diff --git a/docs/zh/.translation-manifest.json b/docs/zh/.translation-manifest.json
index 7c369a1..a3233b1 100644
--- a/docs/zh/.translation-manifest.json
+++ b/docs/zh/.translation-manifest.json
@@ -1,5 +1,5 @@
{
- "generatedAt": "2026-09-02T02:12:58.511Z",
+ "generatedAt": "2026-09-02T04:58:04.200Z",
"pages": {
"https://developers.openai.com/api/docs/actions/actions-library.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -372,14 +372,14 @@
"translatedAt": "2026-08-31T07:03:45.912Z"
},
"https://developers.openai.com/api/docs/guides/batch.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/batch.md",
"sourceSha256": "2bf2066544eb2902b4aeef4338fdf19ff80e684a00ac0e780e343df2fb1aedd0",
"sourceUrl": "https://developers.openai.com/api/docs/guides/batch.md",
"targetPath": "docs/zh/api/docs/guides/batch.md",
- "targetSha256": "f601aabdb735a5b4d2f3da896a1d319777393cf59fbc1e0127efb571e1d241a8",
- "translatedAt": "2026-08-26T17:47:03.390Z"
+ "targetSha256": "8a2b9857877542a281fd898ab58c32304d7dbe537536561cab971605087b4374",
+ "translatedAt": "2026-09-02T04:12:53.691Z"
},
"https://developers.openai.com/api/docs/guides/chatkit-actions.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -582,14 +582,14 @@
"translatedAt": "2026-09-01T07:14:52.310Z"
},
"https://developers.openai.com/api/docs/guides/evaluation-best-practices.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/evaluation-best-practices.md",
"sourceSha256": "4fe3ed0445b93f5adfff687449027fbc3913ea1df535039075a638221aaec228",
"sourceUrl": "https://developers.openai.com/api/docs/guides/evaluation-best-practices.md",
"targetPath": "docs/zh/api/docs/guides/evaluation-best-practices.md",
- "targetSha256": "848f5090f6891418e421c872522885ed58e8aec43668455da701d29b36894b3c",
- "translatedAt": "2026-08-26T17:56:29.502Z"
+ "targetSha256": "564bf06c35f69e0da8eceee44446ab7a8fd4bab95cc398884245f59aa575e0fa",
+ "translatedAt": "2026-09-02T04:16:09.468Z"
},
"https://developers.openai.com/api/docs/guides/evaluation-getting-started.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -742,24 +742,24 @@
"translatedAt": "2026-09-01T07:47:35.911Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-4.1.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/latest-model/gpt-4.1.md",
"sourceSha256": "08bbbfb26cb996a225265ffaf6eb8d1bd641e9d9287f08b41387bebc356bee00",
"sourceUrl": "https://developers.openai.com/api/docs/guides/latest-model/gpt-4.1.md",
"targetPath": "docs/zh/api/docs/guides/latest-model/gpt-4.1.md",
- "targetSha256": "e93e3c503d17ee1fe72569777e84122e5eab7ab8861a0864df9881fdce69d858",
- "translatedAt": "2026-08-26T18:14:36.315Z"
+ "targetSha256": "5e7b2016734970d38b3225446368e794c6634a50e5d0283889d996d0bab2ccd1",
+ "translatedAt": "2026-09-02T04:18:53.592Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.1.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/latest-model/gpt-5.1.md",
"sourceSha256": "726dd6000066e45db59098116a067d37d4c4c778c7bd0b37a236c001ad5af477",
"sourceUrl": "https://developers.openai.com/api/docs/guides/latest-model/gpt-5.1.md",
"targetPath": "docs/zh/api/docs/guides/latest-model/gpt-5.1.md",
- "targetSha256": "6b6b3eaa11f54ab5074985653445529e334ad1e4c8cdcffd0477e5c1abce19b4",
- "translatedAt": "2026-08-26T18:15:45.705Z"
+ "targetSha256": "f3d6a184902971961d502f39f54447b467230617afb7a059fd097c65028a9e98",
+ "translatedAt": "2026-09-02T04:20:45.423Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.2.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -772,14 +772,14 @@
"translatedAt": "2026-09-01T07:53:25.533Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.3-codex.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/latest-model/gpt-5.3-codex.md",
"sourceSha256": "a0ae3591aea061a94957730f6ba89dec25156dc13eccea886ccd9227a6be9b98",
"sourceUrl": "https://developers.openai.com/api/docs/guides/latest-model/gpt-5.3-codex.md",
"targetPath": "docs/zh/api/docs/guides/latest-model/gpt-5.3-codex.md",
- "targetSha256": "cb84ff75d45a973eff028e1a030758709f981bbe2ebfcccc656b4a54bb19c742",
- "translatedAt": "2026-08-26T18:19:27.298Z"
+ "targetSha256": "24517b5f27712b6dd062e679e65a24b7255b23da9a65728319176ab3cae300c7",
+ "translatedAt": "2026-09-02T04:23:32.741Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.4.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -792,14 +792,14 @@
"translatedAt": "2026-09-01T08:01:59.523Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.5.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/latest-model/gpt-5.5.md",
"sourceSha256": "ce7e5efd2f9f6adf0f8510273b282a8dc603ec29e0cbe90237f19400ea8736b0",
"sourceUrl": "https://developers.openai.com/api/docs/guides/latest-model/gpt-5.5.md",
"targetPath": "docs/zh/api/docs/guides/latest-model/gpt-5.5.md",
- "targetSha256": "72443649abe61fc5b48a6a2d5098be065df5931cc08e1827f8b7501d57f5ebfb",
- "translatedAt": "2026-08-26T18:32:11.174Z"
+ "targetSha256": "d45e5165b44e7444d8c028211ea71e6913327e9b3d89f4ccbc0e46d57f69bee9",
+ "translatedAt": "2026-09-02T04:25:50.059Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.6.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -812,14 +812,14 @@
"translatedAt": "2026-09-01T02:51:29.195Z"
},
"https://developers.openai.com/api/docs/guides/latest-model/gpt-5.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/latest-model/gpt-5.md",
"sourceSha256": "7fce5cae5bd6dba62f50c6dc7054edce83c132678c78020ba6a4dfb11790330c",
"sourceUrl": "https://developers.openai.com/api/docs/guides/latest-model/gpt-5.md",
"targetPath": "docs/zh/api/docs/guides/latest-model/gpt-5.md",
- "targetSha256": "8743700381d3b933618533348b926e739270360461647413078da51dc8c0ca49",
- "translatedAt": "2026-08-26T18:33:34.060Z"
+ "targetSha256": "62de2ec063b358ae7f02c68840fc0bcd1ae5a88141d89469db0e99c1d943295d",
+ "translatedAt": "2026-09-02T04:28:11.997Z"
},
"https://developers.openai.com/api/docs/guides/migrate-to-responses.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1172,14 +1172,14 @@
"translatedAt": "2026-09-01T08:58:02.865Z"
},
"https://developers.openai.com/api/docs/guides/responses-multi-agent.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/responses-multi-agent.md",
"sourceSha256": "190afaed1017550fe6009ff7094c3b9338089b60744e98e81c1d4083ef73f645",
"sourceUrl": "https://developers.openai.com/api/docs/guides/responses-multi-agent.md",
"targetPath": "docs/zh/api/docs/guides/responses-multi-agent.md",
- "targetSha256": "59e2a9b32d953a7090101210f720364151a1ae9164739eb3e82d8fade81559da",
- "translatedAt": "2026-08-26T18:55:55.164Z"
+ "targetSha256": "edc2d033739b5fdef8a0e33db00d1aef850232f6789d0c8bc6dadc2510006df4",
+ "translatedAt": "2026-09-02T04:30:25.333Z"
},
"https://developers.openai.com/api/docs/guides/retrieval.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1192,14 +1192,14 @@
"translatedAt": "2026-09-01T09:00:46.562Z"
},
"https://developers.openai.com/api/docs/guides/rft-use-cases.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/rft-use-cases.md",
"sourceSha256": "5bf74966c9974ab794b4e1206bd4c49cf3deff64621b831177f4626c11e0da5d",
"sourceUrl": "https://developers.openai.com/api/docs/guides/rft-use-cases.md",
"targetPath": "docs/zh/api/docs/guides/rft-use-cases.md",
- "targetSha256": "30588bd12c775e3a1be27222b2557eb601f8b684dfb5bfe213efe6fae9126c32",
- "translatedAt": "2026-08-26T18:58:31.569Z"
+ "targetSha256": "993cef6dd9f607f8f056675d4f5ed0636bfd54bcecd4c5994301ad3e1d3e9203",
+ "translatedAt": "2026-09-02T04:33:23.232Z"
},
"https://developers.openai.com/api/docs/guides/safety-best-practices.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1382,14 +1382,14 @@
"translatedAt": "2026-08-27T07:07:04.273Z"
},
"https://developers.openai.com/api/docs/guides/token-counting.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/token-counting.md",
"sourceSha256": "646ac9fc0a85b5bf2d62c598f9172a37191205c4cd7e66697c88239cb6c807a7",
"sourceUrl": "https://developers.openai.com/api/docs/guides/token-counting.md",
"targetPath": "docs/zh/api/docs/guides/token-counting.md",
- "targetSha256": "4b9a909fabca89695cfe880682bded1a5262535e82c178eaab9c27f6d05083e6",
- "translatedAt": "2026-08-26T19:04:02.398Z"
+ "targetSha256": "b7cfbe30271bc2ddf31a9fc79a64766802182f2bd6cbb9487721f21a53e96cda",
+ "translatedAt": "2026-09-02T04:34:13.163Z"
},
"https://developers.openai.com/api/docs/guides/tools-apply-patch.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1462,24 +1462,24 @@
"translatedAt": "2026-08-29T17:35:53.321Z"
},
"https://developers.openai.com/api/docs/guides/tools-programmatic-tool-calling.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/tools-programmatic-tool-calling.md",
"sourceSha256": "b158c41b29e1e9043e6842ad985c02abf5ce3eef2984ff771996809da4b2c8b9",
"sourceUrl": "https://developers.openai.com/api/docs/guides/tools-programmatic-tool-calling.md",
"targetPath": "docs/zh/api/docs/guides/tools-programmatic-tool-calling.md",
- "targetSha256": "e5d43011e5f10a099e3857fc6adad1d50717f3d2dc87cfe9edb5113a63121844",
- "translatedAt": "2026-08-26T19:08:48.732Z"
+ "targetSha256": "7f2613719d5f35d8539f44ad494dcc02428c8d03e3259b8d91a6595dc8f80a6e",
+ "translatedAt": "2026-09-02T04:35:41.057Z"
},
"https://developers.openai.com/api/docs/guides/tools-shell.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/tools-shell.md",
"sourceSha256": "05a4fc082fad71e77963659eeb6e2f21c8c4a2038874eae3dacb1ba3ce08b8cc",
"sourceUrl": "https://developers.openai.com/api/docs/guides/tools-shell.md",
"targetPath": "docs/zh/api/docs/guides/tools-shell.md",
- "targetSha256": "b87d0282ca5c5054e87cf1a36e7af3e009928b0f936fb54f20f4aa031ef7729d",
- "translatedAt": "2026-08-26T19:10:05.263Z"
+ "targetSha256": "0e049184aec519e12140ba39e67f556a2e4b2b978327490c5345e0a90062a51c",
+ "translatedAt": "2026-09-02T04:37:40.177Z"
},
"https://developers.openai.com/api/docs/guides/tools-skills.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1492,24 +1492,24 @@
"translatedAt": "2026-08-29T16:47:32.152Z"
},
"https://developers.openai.com/api/docs/guides/tools-tool-search.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/tools-tool-search.md",
"sourceSha256": "bf38fa5a13a09bb36fe6ab0b06214d2048ef26ce52f596775e2f9b104c351551",
"sourceUrl": "https://developers.openai.com/api/docs/guides/tools-tool-search.md",
"targetPath": "docs/zh/api/docs/guides/tools-tool-search.md",
- "targetSha256": "9afc27c299cf792526e8307bce8ce27671ecb49f12de02961ee97ae5924d6946",
- "translatedAt": "2026-08-26T19:10:55.615Z"
+ "targetSha256": "de5bcbe7eb6e7318a31b3cd20eac5ecb21a1ab69b9027448f52927ffbfac6adc",
+ "translatedAt": "2026-09-02T04:38:56.787Z"
},
"https://developers.openai.com/api/docs/guides/tools-web-search.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/tools-web-search.md",
"sourceSha256": "e78e836f7c1aca4c70ec7fe85f45c5807f466c05c5d77d69c548a464b1d5447c",
"sourceUrl": "https://developers.openai.com/api/docs/guides/tools-web-search.md",
"targetPath": "docs/zh/api/docs/guides/tools-web-search.md",
- "targetSha256": "fa22fadbdb5ec1661e3fc8e39545d52cf7bf031dc2b3e98cff7fcb8b0a3262c9",
- "translatedAt": "2026-08-26T19:12:05.304Z"
+ "targetSha256": "94eb129c57b9ecc1b5bbfba60a23786e1ba60c9faf7eef1407ef527bda0eed50",
+ "translatedAt": "2026-09-02T04:40:52.316Z"
},
"https://developers.openai.com/api/docs/guides/tools.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1562,24 +1562,24 @@
"translatedAt": "2026-08-29T17:38:50.002Z"
},
"https://developers.openai.com/api/docs/guides/upgrading-to-gpt-5p6-sol.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/upgrading-to-gpt-5p6-sol.md",
"sourceSha256": "d4d2494240bc124bde81d96a9a389f3ed7122deabc4b508c18d26a3ebd20c74f",
"sourceUrl": "https://developers.openai.com/api/docs/guides/upgrading-to-gpt-5p6-sol.md",
"targetPath": "docs/zh/api/docs/guides/upgrading-to-gpt-5p6-sol.md",
- "targetSha256": "71910582a96145ead5b3f3c29433ff0baa0115de85b726ecd792d1a4fbd504dc",
- "translatedAt": "2026-08-26T19:14:15.122Z"
+ "targetSha256": "760876884a37bf208e3f7c7a999ea31e3749aca9b7beb87944a37f8f4244e366",
+ "translatedAt": "2026-09-02T04:44:18.905Z"
},
"https://developers.openai.com/api/docs/guides/video-generation.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/video-generation.md",
"sourceSha256": "bebee28e187d9dc6207a5d8fe6504d92904dd5374c00226fd014407b532542b5",
"sourceUrl": "https://developers.openai.com/api/docs/guides/video-generation.md",
"targetPath": "docs/zh/api/docs/guides/video-generation.md",
- "targetSha256": "2ffa769f62769a25c57c11541a6a5bbb4879f5b342f61b932e7ca40aebeeba9c",
- "translatedAt": "2026-08-26T19:15:29.455Z"
+ "targetSha256": "7304a2a72251768f88c03b4c514ebbab1f228c0d6b45f4d8957a35eb8a023c42",
+ "translatedAt": "2026-09-02T04:47:03.045Z"
},
"https://developers.openai.com/api/docs/guides/vision-fine-tuning.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1642,14 +1642,14 @@
"translatedAt": "2026-08-29T17:43:16.200Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/aws.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/workload-identity-federation/aws.md",
"sourceSha256": "e33500caf1439efd60de0a752fe1ae107f155c185f4d3fdbf9f2f82f5b11df5b",
"sourceUrl": "https://developers.openai.com/api/docs/guides/workload-identity-federation/aws.md",
"targetPath": "docs/zh/api/docs/guides/workload-identity-federation/aws.md",
- "targetSha256": "c9839b6b3d82e5b3d354317d8dae341d4f9591a2988b0fefadd2350626f8e89e",
- "translatedAt": "2026-08-26T19:18:30.701Z"
+ "targetSha256": "1dabe0204c56a88ae3649e0141bc48fddb3aca27bdc1708628bd55fdc48e37b3",
+ "translatedAt": "2026-09-02T04:49:03.062Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/federation-rules.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1662,24 +1662,24 @@
"translatedAt": "2026-08-29T17:44:55.522Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/github-actions.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/workload-identity-federation/github-actions.md",
"sourceSha256": "8e9cca35fb1763966f055c06ebbc826f2756289bd167c3eca2b4a6cf8984cac5",
"sourceUrl": "https://developers.openai.com/api/docs/guides/workload-identity-federation/github-actions.md",
"targetPath": "docs/zh/api/docs/guides/workload-identity-federation/github-actions.md",
- "targetSha256": "d94c8416ebb16d81dd3b20c89c8e4977f47907fa2f214a9a795d3e5dbcef0d3b",
- "translatedAt": "2026-08-26T19:19:17.392Z"
+ "targetSha256": "e699deb65e81206bc428aa4e726a4e540d4a6f137c6cf5d93987cd8c83f9e0de",
+ "translatedAt": "2026-09-02T04:50:27.270Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/google-cloud.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/workload-identity-federation/google-cloud.md",
"sourceSha256": "cc7b47c9f5b4a3f03b27b6175408c92ec6f3982fdc3c53667905a42d73bdc77d",
"sourceUrl": "https://developers.openai.com/api/docs/guides/workload-identity-federation/google-cloud.md",
"targetPath": "docs/zh/api/docs/guides/workload-identity-federation/google-cloud.md",
- "targetSha256": "78046fe4b3ddd20dfbd2e6c3f5efdb3c2498072ac8db40eaea5d02feb997bdec",
- "translatedAt": "2026-08-26T19:20:24.783Z"
+ "targetSha256": "bdd0a7a814695963152b67c865569acfd1f2bb61d0e775b37105a0454249178c",
+ "translatedAt": "2026-09-02T04:51:56.650Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/kubernetes.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1692,14 +1692,14 @@
"translatedAt": "2026-08-30T07:21:27.320Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/microsoft-azure.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/docs/guides/workload-identity-federation/microsoft-azure.md",
"sourceSha256": "e036963d11c6719db14849a7dfb990f1bb72ccc616173c4201e10e5adf2e9f5d",
"sourceUrl": "https://developers.openai.com/api/docs/guides/workload-identity-federation/microsoft-azure.md",
"targetPath": "docs/zh/api/docs/guides/workload-identity-federation/microsoft-azure.md",
- "targetSha256": "88bf633a902c016a0ff592a6293df3a78be090c83f69071ea798f16dec149f0f",
- "translatedAt": "2026-08-26T19:21:46.704Z"
+ "targetSha256": "481166b0917160af1d8796712c91e99d06af2b61eb5a78d2bfb7f135a17a8d69",
+ "translatedAt": "2026-09-02T04:53:42.023Z"
},
"https://developers.openai.com/api/docs/guides/workload-identity-federation/oracle-cloud.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1892,14 +1892,14 @@
"translatedAt": "2026-08-30T07:28:49.891Z"
},
"https://developers.openai.com/api/reference/resources/audio.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/audio.md",
"sourceSha256": "d320d8147bdadd1c2135d2d462a377ea2b28111232fcdb9a02f5772ae1a7a7db",
"sourceUrl": "https://developers.openai.com/api/reference/resources/audio.md",
"targetPath": "docs/zh/api/reference/resources/audio.md",
- "targetSha256": "5462b6a70999e0f94f34a280ab75f4adf627980c6b39ad375e3117bbcef6775e",
- "translatedAt": "2026-08-26T19:31:05.859Z"
+ "targetSha256": "73719570597e836a5124f254eb63bee98a5dec8a8e615bfec664f439ac4acb5e",
+ "translatedAt": "2026-09-02T04:55:41.680Z"
},
"https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -1912,14 +1912,14 @@
"translatedAt": "2026-08-30T07:29:06.206Z"
},
"https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/audio/subresources/transcriptions/methods/create.md",
"sourceSha256": "04ad44856539628994701d226072dc1f28d45857af2a58e3e0fa84f10f81fa52",
"sourceUrl": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create.md",
"targetPath": "docs/zh/api/reference/resources/audio/subresources/transcriptions/methods/create.md",
- "targetSha256": "e2c71d2f68f3b7f20be36a3b714733f27cf2c0300c99f74d6ac2b4bcc2d3c328",
- "translatedAt": "2026-08-26T19:31:27.022Z"
+ "targetSha256": "7f4cb30eb7e709915e82e1a4f0e9c4aaead63841c3e6789b830652823d6dd497",
+ "translatedAt": "2026-09-02T04:56:07.799Z"
},
"https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -2112,14 +2112,14 @@
"translatedAt": "2026-08-26T19:45:02.349Z"
},
"https://developers.openai.com/api/reference/resources/beta/subresources/chatkit.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/beta/subresources/chatkit.md",
"sourceSha256": "8ea30deef152ee20ab69a289dbcf39e0e44d13134f692d271fc4635bc208ff7c",
"sourceUrl": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit.md",
"targetPath": "docs/zh/api/reference/resources/beta/subresources/chatkit.md",
- "targetSha256": "fc603f188e22e9db844e1c05b73d7afb691f7f88c2e59cca5a73cb369419c81b",
- "translatedAt": "2026-08-26T19:47:13.331Z"
+ "targetSha256": "70e93675cb6fa9729f5ab6fb773bc2206f0787ce00af1030dce7596655ccf0d3",
+ "translatedAt": "2026-09-02T04:58:04.200Z"
},
"https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/sessions.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -2672,14 +2672,14 @@
"translatedAt": "2026-08-30T14:46:51.625Z"
},
"https://developers.openai.com/api/reference/resources/evals.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/evals.md",
- "sourceSha256": "c6e94687b854f97a415e9ac35ed6f2a49238cf69c7ce2bfb9e784c09b27f6bf5",
+ "sourceSha256": "c8711dedb5aa9034bde1d8b98a17e0db03a4121905c9e5b5479310fd3f81aa4d",
"sourceUrl": "https://developers.openai.com/api/reference/resources/evals.md",
"targetPath": "docs/zh/api/reference/resources/evals.md",
- "targetSha256": "c93d5eef2a18f530b7ef64db46316af9dc789b587f031d66c21b0c441d31cd1e",
- "translatedAt": "2026-08-26T20:33:50.975Z"
+ "targetSha256": "360e9f738f64b3416c90b8c510c722db7888674ee0a05f4a06ab5f6dc9a86173",
+ "translatedAt": "2026-09-02T03:00:42.446Z"
},
"https://developers.openai.com/api/reference/resources/evals/methods/create.md": {
"policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
@@ -2732,14 +2732,14 @@
"translatedAt": "2026-08-30T14:49:02.365Z"
},
"https://developers.openai.com/api/reference/resources/evals/subresources/runs/methods/cancel.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/evals/subresources/runs/methods/cancel.md",
- "sourceSha256": "c86b1de3ee860eb925695b5e57a8d5538021beeddc56733e9359b336c7b95875",
+ "sourceSha256": "4fc15f8ec100803699234fb5313eee95ee3efad70b06dd325b47c50f10afa0c0",
"sourceUrl": "https://developers.openai.com/api/reference/resources/evals/subresources/runs/methods/cancel.md",
"targetPath": "docs/zh/api/reference/resources/evals/subresources/runs/methods/cancel.md",
- "targetSha256": "dbe1b5698c3f2ac74ef18c3ff249a4016743f712f5d926f883197edf1782f8ca",
- "translatedAt": "2026-08-26T20:36:01.543Z"
+ "targetSha256": "d5802c77eb2b753f6dc965870f3053d35d0124d25c85dd69c1dddfe836d54395",
+ "translatedAt": "2026-09-02T03:04:48.516Z"
},
"https://developers.openai.com/api/reference/resources/files.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -2792,14 +2792,14 @@
"translatedAt": "2026-08-30T14:50:54.837Z"
},
"https://developers.openai.com/api/reference/resources/fine_tuning.md": {
- "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
+ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/fine_tuning.md",
- "sourceSha256": "1bab4a2cf8139066cf23d15b3a33ff6f826812ba6645afeb1f2573926bb9072e",
+ "sourceSha256": "684e03eacf45f4fe339a3e5fe505958a78ffcb214d75363bdc40a175ac5d8c42",
"sourceUrl": "https://developers.openai.com/api/reference/resources/fine_tuning.md",
"targetPath": "docs/zh/api/reference/resources/fine_tuning.md",
- "targetSha256": "93116a79dacbd5dbb649ae3bb3f47a424c8fa3414e3f485dd62d409feda57b94",
- "translatedAt": "2026-08-26T20:37:39.113Z"
+ "targetSha256": "7693a15c3e8e12b46cb46afd6525f03da915ef55c2bd62579ceff9613153f82d",
+ "translatedAt": "2026-09-02T03:08:12.686Z"
},
"https://developers.openai.com/api/reference/resources/fine_tuning/subresources/checkpoints/subresources/permissions/methods/create.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -2895,11 +2895,11 @@
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/models.md",
- "sourceSha256": "d5fb0dff14226b9328762aa97ffb9a0fdb80c5db81eec288994a167fad58b758",
+ "sourceSha256": "8922d8a50f11b1df53fb19001f5ed411a7b72bdabc23343fdb579ce8aaf826d9",
"sourceUrl": "https://developers.openai.com/api/reference/resources/models.md",
"targetPath": "docs/zh/api/reference/resources/models.md",
- "targetSha256": "193b6e253f8f520400d15a5d7d78196b1b4b4cbe10aad10b494ecd2382ef7bb6",
- "translatedAt": "2026-08-30T14:52:17.516Z"
+ "targetSha256": "ab218ad45638aa22061d0c84d831567595ac836c640104ba6dd2ddf8ee8ccaf9",
+ "translatedAt": "2026-09-02T03:08:35.566Z"
},
"https://developers.openai.com/api/reference/resources/models/methods/delete.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -2925,11 +2925,11 @@
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/models/methods/retrieve.md",
- "sourceSha256": "3eb34c3d79c0123168821c609d925b1a110382e476779ec450e425ad77a60e44",
+ "sourceSha256": "77264efca7476eae8de815f8a90876bda08651c4976ea7dd108e1750b0e32ec3",
"sourceUrl": "https://developers.openai.com/api/reference/resources/models/methods/retrieve.md",
"targetPath": "docs/zh/api/reference/resources/models/methods/retrieve.md",
- "targetSha256": "8ba414edf0f9aa0214856aca8a7ef2c7ad49b8a6661f6ab089ff75c918acf4f3",
- "translatedAt": "2026-08-30T14:52:57.797Z"
+ "targetSha256": "85b52d4ebb3a14da3cc64a43c4f7cf8e073fecc8be362d44e00460d8804a3cda",
+ "translatedAt": "2026-09-02T03:08:48.972Z"
},
"https://developers.openai.com/api/reference/resources/moderations.md": {
"policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
@@ -3815,41 +3815,41 @@
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses.md",
- "sourceSha256": "56a346524d5a9da0e93f194d51b26dbc484dca81518f4efcf54bab5d5fc3fd73",
+ "sourceSha256": "b0e847f3035db84d94135b68442f6e24358fadef8306868fb98bbab82b9c011f",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses.md",
"targetPath": "docs/zh/api/reference/resources/responses.md",
- "targetSha256": "6af50d3e92045e79dc2516c3739ec9dca5bb12cc237f38a83367675564e8a353",
- "translatedAt": "2026-09-01T20:56:10.951Z"
+ "targetSha256": "82503a3684e8f5f9cf22c568508159148ad8327cb2167832bd5fbe9dc586fab8",
+ "translatedAt": "2026-09-02T03:31:00.844Z"
},
"https://developers.openai.com/api/reference/resources/responses/methods/cancel.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/methods/cancel.md",
- "sourceSha256": "62a4bbdb03e5dff154e8e4985c52fba24ba66b87b0c5865782de0b302e775da7",
+ "sourceSha256": "e47089af475693c03a0e7b45a2897ebf8804cb6a424f201048fe34ee77652265",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/methods/cancel.md",
"targetPath": "docs/zh/api/reference/resources/responses/methods/cancel.md",
- "targetSha256": "985927f059a4a506843d9592445e0af6f35d93710435a10936bae1cf2cbc96bb",
- "translatedAt": "2026-09-01T21:00:11.193Z"
+ "targetSha256": "9de2c7444102c30c92c3c11ef43a7a9b8c7e6c1c5eafec66ddab8bb6db2bc123",
+ "translatedAt": "2026-09-02T03:38:05.393Z"
},
"https://developers.openai.com/api/reference/resources/responses/methods/compact.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/methods/compact.md",
- "sourceSha256": "1257b2a948c7ac775504a36c1dd985621e1a532e4a34a64ca3dad9ae24c58365",
+ "sourceSha256": "81ed2fef55c1a54536cc3f7aa49a0a37fe24dd82709cf44e114376f00908cfe0",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/methods/compact.md",
"targetPath": "docs/zh/api/reference/resources/responses/methods/compact.md",
- "targetSha256": "3a673c5b868861fe2ef3ab093f95c85a102b0947717bc4914ed2cdc55615853f",
- "translatedAt": "2026-09-01T21:04:53.186Z"
+ "targetSha256": "0979081b7d652e13468dbdddb783d77872a30d35425c4de439fea2eab349b1b1",
+ "translatedAt": "2026-09-02T03:43:09.866Z"
},
"https://developers.openai.com/api/reference/resources/responses/methods/create.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/methods/create.md",
- "sourceSha256": "2c44f339ff0d84b54677f80fd80af0e32887f7d443ecec951eb949b744460893",
+ "sourceSha256": "2558551c5d7f8b838207fffa06e7e89beb98e43fc57e3595c641c241f08f224b",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/methods/create.md",
"targetPath": "docs/zh/api/reference/resources/responses/methods/create.md",
- "targetSha256": "9421fc6a8d3cce5348ba0b83b28edd111596ce33e0e26ae773c3f32716b000e9",
- "translatedAt": "2026-09-01T21:09:23.725Z"
+ "targetSha256": "d1eb12838f0d4c577567a05353ef8497ced7574a06ece6ca19b026485c6b484f",
+ "translatedAt": "2026-09-02T03:50:46.919Z"
},
"https://developers.openai.com/api/reference/resources/responses/methods/delete.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
@@ -3865,21 +3865,21 @@
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/methods/retrieve.md",
- "sourceSha256": "300213a3ded26c711f31a8fa686eb4a84f0117b21ed1443d72af7732878f8be7",
+ "sourceSha256": "35223714d2aa6e0454c2b7690cdcd26690a51a05e0a9e686e7f37b9d212e8304",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/methods/retrieve.md",
"targetPath": "docs/zh/api/reference/resources/responses/methods/retrieve.md",
- "targetSha256": "29633aa467d332ba34ff0c358a8234ee0f9eca571a4fb990828106891db55d1f",
- "translatedAt": "2026-09-01T21:14:13.387Z"
+ "targetSha256": "20f2867dfc9b1b97b3fec3092df663c1004b9027b8de2455375f2e8d875bb5f8",
+ "translatedAt": "2026-09-02T03:56:33.467Z"
},
"https://developers.openai.com/api/reference/resources/responses/streaming-events.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/streaming-events.md",
- "sourceSha256": "e0a51e7349df4d95855bebc0220ca227096bfbe614d47dab188dd7eb4cb630d4",
+ "sourceSha256": "920cb602350f5847272e48cf1df7cab859c6383258cbb5f8ccd5953a51f4b95e",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/streaming-events.md",
"targetPath": "docs/zh/api/reference/resources/responses/streaming-events.md",
- "targetSha256": "0935b9ad57f2890f6058441829eada30bca3b35b7339d90546433d383979357a",
- "translatedAt": "2026-09-01T21:18:10.934Z"
+ "targetSha256": "dc2ad1ff5b6e19254f8a605b0a862713cdbee0632e1291da4cbcb538f0819e44",
+ "translatedAt": "2026-09-02T04:01:37.975Z"
},
"https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list.md": {
"policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2",
@@ -3895,21 +3895,21 @@
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/subresources/input_tokens.md",
- "sourceSha256": "9a73c4ff1caf5b7af1ec8606b7c66d571166a35b045a0397b8012a8b3ca54a0c",
+ "sourceSha256": "0635afe1c7e050a362f5289190f3c78202880dc438a877361f17cc5f760f870c",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens.md",
"targetPath": "docs/zh/api/reference/resources/responses/subresources/input_tokens.md",
- "targetSha256": "f1ba3ec64aca6d51bf1dc14fd93a3dbf135ca1908119a875fa8d77332bf251e1",
- "translatedAt": "2026-09-01T21:21:50.219Z"
+ "targetSha256": "5578f7030c98973ab619f4b35427e019c557af1416d462c9a517adb12ff2e4d9",
+ "translatedAt": "2026-09-02T04:06:11.095Z"
},
"https://developers.openai.com/api/reference/resources/responses/websocket-events.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
"reviewStatus": "machine",
"sourcePath": "docs/en/api/reference/resources/responses/websocket-events.md",
- "sourceSha256": "9587401acf3e7a029a3a518abf60631ad2f1b915361eb4a4887676a18df3f78f",
+ "sourceSha256": "5c2e7ea97db804dcc5b5287500b9f74fd5ff3fa9f25d55c97314fd8c53e13f99",
"sourceUrl": "https://developers.openai.com/api/reference/resources/responses/websocket-events.md",
"targetPath": "docs/zh/api/reference/resources/responses/websocket-events.md",
- "targetSha256": "9d0d79b1db3768de14b52369ea6fe9b4fbdce175eada55b69023256593b3467c",
- "translatedAt": "2026-09-01T21:25:51.128Z"
+ "targetSha256": "e6655c9040ae7d0a6aae08563432fecfb26d0a648366c0ef944a80dcc6fec0da",
+ "translatedAt": "2026-09-02T04:10:59.213Z"
},
"https://developers.openai.com/api/reference/resources/uploads.md": {
"policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5",
diff --git a/docs/zh/api/docs/guides/batch.md b/docs/zh/api/docs/guides/batch.md
index 20b757a..3d97064 100644
--- a/docs/zh/api/docs/guides/batch.md
+++ b/docs/zh/api/docs/guides/batch.md
@@ -1,31 +1,31 @@
-# 批处理 API
+# Batch API
-> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 来获取文档页面的 Markdown 版本。
-了解如何使用 OpenAI 的批量 API 发送异步请求组,享受 50% 更低的成本、独立且显著更高的速率限制池,以及明确的 24 小时周转时间。该服务非常适合处理不需要即时响应的作业。你也可以 [直接在此处探索 API 参考文档](https://developers.openai.com/api/reference/resources/batches).
+了解如何使用 OpenAI 的 Batch API 以 50% 的更低成本发送异步请求组,享受独立的更高额度速率限制,以及明确的 24 小时周转时间。该服务非常适合处理不需要立即响应的任务。你还可以 [在此直接浏览 API 参考](https://developers.openai.com/api/reference/resources/batches).
## 概述
-虽然 OpenAI 平台的某些用途需要你发送同步请求,但在许多情况下,请求并不需要立即响应,或者 [速率限制](https://developers.openai.com/api/docs/guides/rate-limits) 会阻止你快速执行大量查询。批处理作业在以下场景中通常很有帮助:
+虽然 OpenAI 平台的某些用法要求你发送同步请求,但在许多情况下请求并不需要立即响应,或者 [速率限制](https://developers.openai.com/api/docs/guides/rate-limits) 会阻止你快速执行大量查询。批处理任务在以下用例中通常很有用:
-1. 运行评估
+1. 运行评测
2. 对大型数据集进行分类
-3. 嵌入内容仓库
-4. 排队大型离线视频渲染任务
+3. 嵌入内容存储库
+4. 对大型离线视频渲染任务进行排队
-批量API提供了一套简洁的端点,让你能够将一组请求收集到单个文件中,启动一个批处理作业来执行这些请求,在底层请求执行时查询该批处理的状态,并在批处理完成后最终检索收集到的结果。
+Batch API 提供了一组简洁的接口,允许你将一组请求打包到单个文件中,启动批处理任务来执行这些请求,在底层请求执行过程中查询批处理任务的状态,并在批处理完成后检索汇总结果。
-与直接使用标准端点相比,批量API具有以下特点:
+与直接使用标准接口相比,Batch API 具有以下特点:
-1. **更好的成本效率:** 与同步 API 相比,可享受 50% 的成本折扣
-2. **更高的速率限制:** [更高的余量](https://platform.openai.com/settings/organization/limits) 与同步 API 相比
+1. **更优的成本效率:** 相比同步 API,成本折扣 50%
+2. **更高的速率限制:** [显著更大的余量](https://platform.openai.com/settings/organization/limits) 相比同步 API
3. **更快的完成时间:** 每个批次在 24 小时内完成(通常更快)
-## 开始使用
+## 入门
-### 1. 准备你的批处理文件
+### 1. 准备批处理文件
-批次以一个 `.jsonl` 文件开始,其中每一行包含对 API 的单个请求的详细信息。目前,可用的端点为:
+批次从一个 `.jsonl` 文件开始,其中每行包含一个发往 API 的单个请求的详细信息。目前可用的端点包括:
- `/v1/responses` ([Responses API](https://developers.openai.com/api/reference/resources/responses))
- `/v1/chat/completions` ([Chat Completions API](https://developers.openai.com/api/reference/resources/chat))
@@ -36,18 +36,18 @@
- `/v1/images/edits` ([Images API](https://developers.openai.com/api/reference/resources/images))
- `/v1/videos` ([视频生成指南](https://developers.openai.com/api/docs/guides/video-generation))
-对于给定的输入文件,每一行参数中的 `body` 字段与底层端点的参数相同。每个请求必须包含一个唯一的 `custom_id` 值,你可以使用该值在完成后引用结果。以下是一个包含 2 个请求的输入文件示例。请注意,每个输入文件只能包含对单个模型的请求。
+对于给定的输入文件,每一行的 `body` 字段与底层端点的参数相同。每个请求必须包含唯一的 `custom_id` 值,你可以在完成后用它来引用结果。下面是一个包含 2 个请求的输入文件示例。请注意,每个输入文件只能包含发往同一模型的请求。
-对于批量处理中的视频生成:
+关于 Batch 中的视频生成:
-- Batch 目前支持 `POST /v1/videos` 。
-- 视频的批量请求必须使用 JSON,而非 multipart。
-- 提前上传资源,并在请求体中传递支持的资源引用,而不是使用 multipart 上传。
-- 使用 `input_reference` 进行 Batch 中的图像引导生成。在 JSON 请求中,传递 `input_reference` 作为一个包含 `file_id` 或 `image_url`.
-- Multipart `input_reference` 上传,包括视频引用输入,在 Batch 中不受支持。
-- 批量生成的视频可在 Batch 完成后下载最多 `24` 小时。
+- Batch 目前仅支持 `POST /v1/videos` 。
+- 视频的 Batch 请求必须使用 JSON,不能使用 multipart。
+- 请提前上传素材,并在请求体中传入受支持的素材引用,而不是使用 multipart 上传。
+- 在 Batch 中用于 `input_reference` 的图像引导生成。在 JSON 请求中,传入作为对象的 `input_reference` ,其中包含 `file_id` 或 `image_url`.
+- Multipart `input_reference` 上传(包括视频参考输入)在 Batch 中不受支持。
+- Batch 生成的视频在批处理完成后可供下载,时长最长为 `24` 小时。
-当目标为 `/v1/moderations`,时,在每个请求体中包含一个 `input` 字段。Batch 接受纯文本输入以及包含文本或图像输入的内容数组,使用 `omni-moderation-latest`。Batch 工作进程会拒绝设置 `stream=true`,的请求,与同步审核端点一致。
+在针对 `/v1/moderations`,时,请在每个请求体中包含 `input` 字段。Batch 接受纯文本输入以及使用文本或图像输入的内容数组。 `omni-moderation-latest`。Batch 工作进程会拒绝设置这些参数的请求 `stream=true`,与同步的 moderation 端点一致。
```jsonl
{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo-0125", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}
@@ -70,7 +70,7 @@
}
```
-带有文本和图像输入的请求:
+包含文本和图像输入的请求:
```jsonl
{
@@ -95,15 +95,15 @@
}
```
-建议引用远程资源,使用 `image_url` (而不是 base64 块)来
- 保持你的 `.jsonl` 文件远低于 200 MB 批量上传限制,
- 尤其是对于多模态审核请求。
+推荐使用 `image_url` (而不是 base64 blob)来
+ 保持你的 `.jsonl` 文件大小远低于 200 MB 的批量上传限制,
+ 特别是针对多模态 Moderations 请求。
### 2. 上传你的批量输入文件
-与我们 [微调 API](https://developers.openai.com/api/docs/guides/model-optimization),类似,你必须首先上传输入文件,以便在启动批次时正确引用它。使用 `.jsonl` 文件,通过 [文件 API](https://developers.openai.com/api/reference/resources/files).
+与我们的 [微调 API](https://developers.openai.com/api/docs/guides/model-optimization),类似,你需要先上传输入文件,以便在启动批次时正确引用它。上传你的 `.jsonl` 使用文件 [Files API](https://developers.openai.com/api/reference/resources/files).
-为批量 API 上传文件
+上传文件用于 Batch API
```javascript
import fs from "fs";
@@ -205,9 +205,9 @@ openai files create \
### 3. 创建批次
-成功上传输入文件后,你可以使用输入 File 对象的 ID 来创建批次。在此示例中,假设文件 ID 为 `file-abc123`。目前,完成窗口只能设置为 `24h`。你还可以通过可选的 `metadata` 参数提供自定义元数据。
+成功上传输入文件后,你可以使用输入的 File 对象 ID 来创建 batch。这里,我们假设文件 ID 为 `file-abc123`。目前,completion window 只能设置为 `24h`。你还可以通过可选的 `metadata` 参数来提供自定义元数据。
-创建批次
+创建 Batch
```javascript
import OpenAI from "openai";
@@ -303,7 +303,7 @@ openai batches create \
```
-此请求将返回一个 [Batch 对象](https://developers.openai.com/api/reference/resources/batches) ,其中包含有关你的批次的元数据:
+该请求将返回一个 [Batch 对象](https://developers.openai.com/api/reference/resources/batches) ,其中包含有关你 batch 的元数据:
```json
{
@@ -331,11 +331,11 @@ openai batches create \
}
```
-### 4. 检查批处理的状态
+### 4. 查看批量任务的状态
-你可以随时检查批次的状态,这也将返回一个 Batch 对象。
+你可以随时检查批处理的状态,这也会返回一个 Batch 对象。
-检查批次状态
+检查批处理的状态
```javascript
import OpenAI from "openai";
@@ -401,24 +401,24 @@ openai batches retrieve \
```
-给定 Batch 对象的状态可以是以下任意一种:
+给定的 Batch 对象的状态可以是以下任意一种:
| 状态 | 描述 |
| ------------- | ------------------------------------------------------------------------------ |
-| `validating` | 输入文件正在验证中,批次尚未开始 |
-| `failed` | 输入文件未通过验证过程 |
-| `in_progress` | 输入文件已成功验证,批次当前正在运行 |
-| `finalizing` | 批次已完成,正在准备结果 |
-| `completed` | 批次已完成,结果已就绪 |
-| `expired` | 批次无法在24小时时间窗口内完成 |
-| `cancelling` | 批次正在被取消(可能需要最多10分钟) |
-| `cancelled` | 批次已被取消 |
+| `validating` | 正在校验输入文件,然后才能开始批量任务 |
+| `failed` | 输入文件未通过校验 |
+| `in_progress` | 输入文件已成功校验,正在执行批量任务 |
+| `finalizing` | 批量任务已完成,正在准备结果 |
+| `completed` | 批量任务已完成,结果已就绪 |
+| `expired` | 批量任务未能在 24 小时时间窗口内完成 |
+| `cancelling` | 批量任务正在取消(最长可能需要 10 分钟) |
+| `cancelled` | 批量任务已取消 |
-### 5. 检索结果
+### 5. 获取结果
-批次完成后,你可以通过对以下内容发起请求来下载输出 [Files API](https://developers.openai.com/api/reference/resources/files) 通过 `output_file_id` 从 Batch 对象中的字段并将其写入到你机器上的文件中,在本例中为 `batch_output.jsonl`
+批次完成后,你可以通过向以下接口发起请求来下载输出 [Files API](https://developers.openai.com/api/reference/resources/files) 通过 `output_file_id` 字段(来自 Batch 对象)获取,并将内容写入你本地的文件,例如 `batch_output.jsonl`
-检索批次结果
+获取批次结果
```javascript
import OpenAI from "openai";
@@ -505,27 +505,27 @@ openai files content \
```
-输出 `.jsonl` 文件中,输入文件中的每个成功请求行将对应一个响应行。批次中任何失败的请求,其错误信息都会被写入一个错误文件,你可以通过批次的 `error_file_id`.
+输出 `.jsonl` 文件中,输入文件里每一条成功的请求都会对应一行响应。批次中任何失败的请求,其错误信息会被写入一个错误文件,可通过该批次的 `error_file_id`.
-对于 `/v1/videos`,一个已完成的批次结果包含已达到终态(如 `completed`, `failed`,或 `expired`)的视频对象。你可以使用返回的视频 ID 在批次完成后立即下载最终资产。
+对于 `/v1/videos`,已完成的批次结果包含已达到终止状态的视频对象,例如 `completed`, `failed`,或 `expired`。你可以使用返回的 video ID 在批次结束后立即下载最终资源。
请注意,输出行的顺序 **可能与** 输入行的顺序不一致。
- 不要依赖顺序来处理结果,请使用 custom_id 字段,
- 该字段会出现在输出文件的每一行中,使你能够将
- 输入中的请求与输出中的结果对应起来。
+ 不要依赖顺序来处理结果,而是使用 custom_id 字段
+ ,该字段会出现在输出文件的每一行中,方便你将
+ 输入中的请求映射到输出中的结果。
```jsonl
{"id": "batch_req_123", "custom_id": "request-2", "response": {"status_code": 200, "request_id": "req_123", "body": {"id": "chatcmpl-123", "object": "chat.completion", "created": 1711652795, "model": "gpt-3.5-turbo-0125", "choices": [{"index": 0, "message": {"role": "assistant", "content": "Hello."}, "logprobs": null, "finish_reason": "stop"}], "usage": {"prompt_tokens": 22, "completion_tokens": 2, "total_tokens": 24}, "system_fingerprint": "fp_123"}}, "error": null}
{"id": "batch_req_456", "custom_id": "request-1", "response": {"status_code": 200, "request_id": "req_789", "body": {"id": "chatcmpl-abc", "object": "chat.completion", "created": 1711652789, "model": "gpt-3.5-turbo-0125", "choices": [{"index": 0, "message": {"role": "assistant", "content": "Hello! How can I assist you today?"}, "logprobs": null, "finish_reason": "stop"}], "usage": {"prompt_tokens": 20, "completion_tokens": 9, "total_tokens": 29}, "system_fingerprint": "fp_3ba"}}, "error": null}
```
-输出文件将在批次完成后 30 天自动删除。
+输出文件将在批次完成后 30 天被自动删除。
-### 6. 取消一个批次
+### 6. 取消批量任务
-如有必要,你可以取消进行中的批处理。批处理的状态将变为 `cancelling` ,直到在途请求完成(最多 10 分钟),之后状态将变为 `cancelled`.
+如果需要,你可以取消正在进行的批量任务。批量任务的状态将变为 `cancelling` ,直至所有进行中的请求完成(最多 10 分钟),之后状态将变为 `cancelled`.
-取消批处理
+取消批量任务
```javascript
import OpenAI from "openai";
@@ -596,9 +596,9 @@ openai batches cancel \
```
-### 7. 获取所有批次的列表
+### 7. 获取所有批处理列表
-你随时可以查看所有批次。对于批次较多的用户,你可以使用 `limit` 和 `after` 参数来对结果进行分页。
+你可以随时查看所有的批次。对于拥有大量批次的用户,你可以使用 `limit` 和 `after` 参数对结果进行分页。
获取所有批次的列表
@@ -678,23 +678,23 @@ openai batches list \
## 模型可用性
-批量 API 在我们的绝大多数模型中广泛可用,但并非所有模型都支持。请参阅 [模型参考文档](https://developers.openai.com/api/docs/models) 以确保你所使用的模型支持批量 API。
+Batch API 在我们的大多数模型中可用,但并非全部。请参阅 [模型参考文档](https://developers.openai.com/api/docs/models) 以确认你使用的模型支持 Batch API。
## 速率限制
-批量 API 速率限制与现有的按模型速率限制是分开的。批量 API 有三种类型的速率限制:
+Batch API 速率限制与现有的按模型速率限制是分开的。Batch API 有三种速率限制类型:
-1. **每个批次的限制:** 单个批次最多可包含 50,000 个请求,且批次输入文件大小上限为 200 MB。请注意, `/v1/embeddings` 批次中所有请求的嵌入输入总数也限制为最多 50,000 个。
-2. **每个模型的排队提示词令牌数:** 每个模型有可排队用于批处理的提示词令牌数量上限。你可以在 [平台设置页面](https://platform.openai.com/settings/organization/limits).
-3. **批次创建速率限制:** 你每小时最多可创建 2,000 个批次。如需提交更多请求,请增加每个批次的请求数量。
+1. **每个批次的限制:** 单个批次最多可包含 50,000 个请求,批次输入文件大小最大为 200 MB。请注意, `/v1/embeddings` 批次中所有请求的 embedding 输入总数也限制为最多 50,000 个。
+2. **每个模型的已排队 prompt token 数:** 每个模型都有一个可排队用于批处理的最大 prompt token 数。你可以在 [Platform Settings 页面](https://platform.openai.com/settings/organization/limits).
+3. **批次创建速率限制:** 你每小时最多可以创建 2,000 个批次。如果需要提交更多请求,请增加每个批次的请求数量。
-Batch API 目前没有输出令牌限制。由于 Batch API 速率限制是一个新的独立池, **使用 Batch API 不会消耗你标准按模型速率限制中的令牌,**,从而为你提供一种便捷的方式,在查询我们的 API 时增加可用请求数和已处理令牌数。
+Batch API 目前没有输出 token 限制。由于 Batch API 速率限制是一个全新的独立池, **使用 Batch API 不会消耗你标准按模型速率限制中的 token**,从而为你提供了一种便捷的方式,可以在调用我们的 API 时增加可用请求数和已处理的 token 数。
-## 批量任务过期
+## Batch 过期
-未及时完成的批处理最终会进入 `expired` 状态;该批处理中未完成的请求将被取消,而已完成请求的任何响应都会通过批处理的输出文件提供。你将按已完成请求消耗的令牌数被收费。
+未能在时限内完成的批次最终会转入 `expired` 状态;该批次中未完成的请求将被取消,已完成请求的任何响应可通过批次的输出文件获取。你将按已完成请求所消耗的 token 计费。
-过期的请求将被写入你的错误文件,并显示如下所示的消息。你可以使用 `custom_id` 来检索过期请求的数据。
+过期的请求将按下方所示消息写入你的错误文件。你可以使用 `custom_id` 检索过期请求的请求数据。
```jsonl
{"id": "batch_req_123", "custom_id": "request-3", "response": null, "error": {"code": "batch_expired", "message": "This request could not be executed before the completion window expired."}}
diff --git a/docs/zh/api/docs/guides/evaluation-best-practices.md b/docs/zh/api/docs/guides/evaluation-best-practices.md
index 956b71f..472fce5 100644
--- a/docs/zh/api/docs/guides/evaluation-best-practices.md
+++ b/docs/zh/api/docs/guides/evaluation-best-practices.md
@@ -1,138 +1,138 @@
# 评估最佳实践
-> 如需查看完整文档索引,请参见 [llms.txt](/llms.txt)。通过向页面 URL 追加 `.md` ,可获得文档页面的 Markdown 版本。
+> 完整文档索引请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。
-生成式 AI 具有可变性。模型有时会对同一输入产生不同输出,这使得传统软件测试方法不足以适用于 AI 架构。评估(**evals**)是测试 AI 系统的一种方式,尽管存在这种可变性。
+生成式 AI 具有不确定性。对于相同的输入,模型有时会产生不同的输出,这使得传统的软件测试方法不足以应对 AI 架构。评估(**evals**)是一种在这种不确定性下测试你的 AI 系统的方案。
-本指南提供关于设计评估的高层指导。要开始使用 [Evals API](https://developers.openai.com/api/reference/resources/evals),请参阅 [评估模型性能](https://developers.openai.com/api/docs/guides/evals).
+本指南提供了关于设计 evals 的高层指引。若要开始使用 [Evals API](https://developers.openai.com/api/reference/resources/evals),请参阅 [评估模型性能](https://developers.openai.com/api/docs/guides/evals).
OpenAI 正在弃用 Evals 平台。现有 evals 内容在过渡期内仍然
- 可用。Evals 将在 2026-10-31 对
- 现有用户变为只读,而该平台计划于
- 2026-11-30 关闭。请参阅 [弃用
- 页面](https://developers.openai.com/api/docs/deprecations#2026-06-03-evals-platform) 以了解当前的
- 时间线。
+ 可用。Evals 将于 2026-10-31 起对现有用户变为只读,并计划于
+ 2026-11-30 关闭平台。请参阅
+ 弃用 [deprecations
+ 页面](https://developers.openai.com/api/docs/deprecations#2026-06-03-evals-platform) 获取当前
+ 时间表。
-## 什么是评估?
+## 什么是 evals?
-Evals 是用于衡量模型性能的结构化测试。它们有助于确保准确性、性能和可靠性,尽管 AI 系统具有非确定性。它们也是少数几种能够 _改善_ 基于 LLM 的应用程序性能的方式之一(通过 [微调](https://developers.openai.com/api/docs/guides/model-optimization)).
+Evals 是用于衡量模型性能的结构化测试。尽管 AI 系统具有非确定性,它们仍有助于确保准确性、性能和可靠性。它们也是 _改进_ 基于 LLM 的应用性能的唯一方法之一(通过 [微调](https://developers.openai.com/api/docs/guides/model-optimization)).
### 评估类型
-当你看到“evals”这个词时,它可能指代几种事物:
+当你看到 "evals" 一词时,它可能指代以下几种含义:
-- 用于在隔离环境中比较模型的行业基准,如 [MMLU](https://github.com/openai/evals/blob/main/examples/mmlu.ipynb) 以及列于 [HuggingFace 排行榜](https://huggingface.co/collections/open-llm-leaderboard/the-big-benchmarks-collection-64faca6335a7fc7d4ffe974a)
-- 标准数值评分——如 [ROUGE](https://aclanthology.org/W04-1013/), [BERTScore](https://arxiv.org/abs/1904.09675)——你可以在为你的用例设计评估时使用
-- 你为衡量 LLM 应用性能而实现的具体测试
+- 用于孤立比较模型的行业基准,例如 [MMLU](https://github.com/openai/evals/blob/main/examples/mmlu.ipynb) 以及 [HuggingFace 的排行榜](https://huggingface.co/collections/open-llm-leaderboard/the-big-benchmarks-collection-64faca6335a7fc7d4ffe974a)
+- 标准数值分数——例如 [ROUGE](https://aclanthology.org/W04-1013/), [BERTScore](https://arxiv.org/abs/1904.09675)——在你为自己的用例设计评估时可以使用的标准数值分数
+- 为衡量 LLM 应用程序性能而实现的具体测试
-本指南介绍的是第三种类型:设计你自己的评估。
+本指南介绍的是第三种类型:自行设计评测。
-### 如何阅读评估
+### 如何阅读 evals
-你经常会看到介于 0 和 1 之间的数值评估分数。评估不仅仅是分数。将指标与人工判断相结合,以确保你在回答正确的问题。
+你经常会看到介于 0 到 1 之间的数值评估分数。但评估远不止分数这么简单。将指标与人工判断相结合,确保你在回答正确的问题。
**评估技巧**
-- 采用评估驱动开发:尽早并频繁评估。在每个阶段编写范围明确的测试。
-- 设计任务特定的评估:让测试反映模型在真实世界分布中的能力。
-- 记录一切:在开发过程中记录日志,以便从日志中挖掘出好的评估用例。
-- 尽可能自动化:构建评估以支持自动评分。
-- 这是一个持续的过程,而非终点:评估是一个持续的过程。
-- 保持一致性:使用人工反馈来校准自动评分。
+- 采用评估驱动的开发方式:尽早并频繁地进行评估。在每个阶段编写有针对性的测试。
+- 设计针对具体任务的评估:让测试反映模型在真实场景分布中的能力。
+- 记录一切:在开发过程中持续记录,以便从日志中挖掘出好的评估用例。
+- 尽可能自动化:组织评估结构,以便支持自动打分。
+- 这是一段旅程,而非终点:评估是一个持续的过程。
+- 保持一致:通过人类反馈来校准自动打分。
**反模式**
-- 过于笼统的指标:仅依赖困惑度或 BLEU 分数等学术指标。
-- 有偏设计:创建的评估数据集未能忠实重现生产流量模式。
-- 基于感觉的评估:使用“看起来似乎有效”作为评估策略,或等到上线前才实施任何评估。
-- 忽视人工反馈:没有将自动化指标与人工评估进行校准。
+- 过于通用的指标:仅依赖学术指标,例如困惑度(perplexity)或 BLEU 分数。
+- 有偏差的设计:构建的评估数据集未能真实地复现生产环境中的流量模式。
+- 凭直觉的评估:以“看起来能跑就行”作为评估策略,或者等到上线后才开始实现任何评估。
+- 忽略人工反馈:未将自动化指标与人工评估进行校准。
## 设计你的评估流程
-一个评估工作流有几个重要组成部分:
+一个 eval 工作流包含几个重要的组件:
-1. **定义评估目标**。该评估的成功标准是什么?
-1. **收集数据集**。哪些数据将有助于你对照目标进行评估?考虑合成评估数据、领域特定评估数据、购买的评估数据、人工整理的评估数据、生产数据和历史数据。
-1. **定义评估指标**。你将如何检查成功标准是否达到?
-1. **运行并比较评估**。针对你的任务或系统,迭代并改进模型性能。
-1. **持续评估**。设置持续评估(CE),在每次变更时运行评估,监控你的应用以识别新的非确定性案例,并随时间增长评估集。
+1. **定义评估目标**。评估的成功标准是什么?
+1. **收集数据集**。哪些数据有助于你针对目标进行评估?可考虑合成评估数据、特定领域的评估数据、购买的评估数据、人工整理的评估数据、生产数据和历史数据。
+1. **定义评估指标**。你将如何检查是否满足成功标准?
+1. **运行并对比评估**。迭代并改进你的任务或系统的模型性能。
+1. **持续评估**。设置持续评估(CE),以便在每次变更时运行评估;监控你的应用以识别新的不确定性情况;并随着时间推移不断扩充评估集。
-让我们来看几个例子。
+让我们来看几个示例。
-### 示例:总结转录内容
+### 示例:总结转录文本
-为了测试基于 LLM 的应用程序汇总转录文本的能力,你的评估设计可能是:
+要测试基于 LLM 的应用在摘要转录文本方面的能力,你的设计方案可能如下:
1. **定义评估目标**
- 模型在相关性和准确性上应能与参考摘要竞争。
+ 模型应能够在相关性和准确性上与参考摘要相竞争。
1. **收集数据集**
- 使用生产数据(从用户对生成摘要的反馈中收集)和领域专家(写作者)创建的数据集混合,以确定“良好”的摘要。
+ 结合使用生产数据(从用户对生成摘要的反馈中收集)和领域专家(作者)创建的数据集,以确定一个“好的”摘要。
1. **定义评估指标**
- 在保留的 1000 条参考转录→摘要数据集上,实现应达到至少 0.40 的 ROUGE-L 分数和至少 80% 的 G-Eval 连贯性分数。
+ 在包含 1000 条参考转录文本对应摘要的保留测试集上,该实现应使用 G-Eval 达到至少 0.40 的 ROUGE-L 分数和至少 80% 的连贯性分数。
1. **运行并比较评估**
- 使用 [Evals API](https://developers.openai.com/api/docs/guides/evals) 在 OpenAI 仪表板中创建并运行评估。
+ 使用 [Evals API](https://developers.openai.com/api/docs/guides/evals) 在 OpenAI 仪表板中创建和运行评估。
1. **持续评估**
- 设置持续评估(CE)以在每次更改时运行评估,监控你的应用以识别新的非确定性案例,并随时间增长评估集。
+ 设置持续评估(CE)以便在每次变更时运行评估,监控你的应用以识别新的非确定性案例,并随着时间推移扩展评估集。
-LLM 更擅长在选项之间进行判别。因此,评估
- 应侧重于成对比较、分类或按特定标准评分
- 等任务,而非开放式生成。将评估
- 方法与 LLM 在此类比较中的优势相结合,可获得对
- LLM 输出或模型对比更可靠的评估。
+LLMs 更擅长在选项之间进行区分。因此,评估
+ 应聚焦于两两比较、分类或针对特定标准的打分等任务,
+ 而不是开放式生成。让评估与
+ 将评估方法与 LLM 的优势结合起来进行比较,可以获得更可靠的结果
+ 对 LLM 输出或模型对比的评估。
### 示例:基于文档的问答
-要测试你的基于大语言模型的应用在文档上进行问答的能力,你的评估设计可能是:
+要测试基于 LLM 的应用对文档进行问答的能力,评估设计可以如下:
1. **定义评估目标**
- 模型应能提供精确的答案,在需要时回忆上下文以推理用户提示,并提供满足用户需求的答案。
+ 模型应当能够给出精确的答案,根据需要调用上下文来推理用户提示,并给出满足用户需求的回答。
1. **收集数据集**
- 混合使用生产数据(收集自用户对其问题所获答案的满意度)、领域专家创建的硬编码正确答案,以及日志中的历史数据。
+ 混合使用生产数据(来自用户对其问题回答的满意度)、由领域专家编写的硬编码正确答案,以及日志中的历史数据。
1. **定义评估指标**
- 上下文召回率至少为 0.85,上下文精确率超过 0.7,且 70% 以上的答案获得正面评价。
+ 上下文召回率不低于 0.85,上下文精确率超过 0.7,且正面评价的回答占比达到 70% 以上。
1. **运行并比较评估**
- 使用 [Evals API](https://developers.openai.com/api/docs/guides/evals) 在 OpenAI 仪表板中创建并运行评估。
+ 使用 [Evals API](https://developers.openai.com/api/docs/guides/evals) 在 OpenAI 仪表板中创建和运行评估。
1. **持续评估**
- 设置持续评估(CE),以便在每次更改时运行评估,监控你的应用以识别非确定性的新案例,并随时间增长评估集。
+ 设置持续评估(CE)以便在每次变更时运行评估,监控你的应用以识别新的非确定性案例,并随着时间推移扩展评估集。
在创建评估数据集时,
[`gpt-5.6`](https://developers.openai.com/api/docs/models/gpt-5.6-sol)
- 对于收集评估示例和边缘情况非常有用。考虑使用它来
- 帮助你生成覆盖多种场景的多样化测试数据。确保
+ 可用于收集评估示例和边缘情况。可以考虑使用它来
+ 帮助你生成跨多种场景的多样化测试数据。请确保
你的测试数据包含典型情况、边缘情况和对抗性情况。使用
- 人类专家标注员。
+ 人工专家标注员。
-## 确定你需要评估的地方
+## 确定你需要进行评估的位置
-随着从简单架构过渡到更复杂的架构,复杂度会随之增加。以下四种是常见的架构模式:
+随着架构从简单向更复杂的方向演进,复杂度也会相应增加。以下是四种常见的架构模式:
- [单轮模型交互](#single-turn-model-interactions)
- [工作流](#workflow-architectures)
- [单智能体](#single-agent-architectures)
- [多智能体](#multi-agent-architectures)
-阅读下文关于每种架构的内容,以确定非确定性进入你系统的位置。这就是你需要实施评估的地方。
+请阅读下方每种架构的介绍,找出系统中非确定性出现的位置,那就是你需要实现评估的地方。
### 单轮模型交互
-在这种架构中,用户向模型提供输入,模型处理这些输入(以及提供的任何开发者提示)以生成相应的输出。
+在这样的架构中,用户向模型提供输入,模型处理这些输入(连同任何提供的开发者提示)以生成相应的输出。
#### 示例
-例如,考虑一个在线零售场景。你的系统提示词指示模型 **将客户的提问分类** 为以下类别之一:
+例如,考虑一个在线零售场景。你的系统提示指示模型 **将客户的问题分类** 为以下类别之一:
- `order_status`
- `return_policy`
@@ -140,7 +140,7 @@ LLM 更擅长在选项之间进行判别。因此,评估
- `cancel_order`
- `other`
-为了确保一致、高效的客户体验,模型应 **仅返回与用户意图匹配的标签**。假设客户询问:“我的订单状态如何?”
+为了提供一致、高效的用户体验,模型应当 **只返回与用户意图匹配的标签**。假设客户问道:“我的订单状态是什么?”
@@ -180,17 +180,17 @@ LLM 更擅长在选项之间进行判别。因此,评估
### 工作流架构
-随着你着手解决更复杂的问题,你可能会从单轮模型交互转向将多次模型调用串联起来的多步骤工作流。工作流不会引入任何新的不确定性元素,但涉及多个底层的模型交互,你可以对其进行单独评估。
+当你着手解决更复杂的问题时,你可能会从单轮模型交互转向一个多步骤 工作流,将多个模型调用串联起来。工作流不会引入任何新的非确定性因素,但会涉及多个底层模型交互,而你可以对这些交互分别进行评估。
#### 示例
-沿用之前的示例,客户询问其订单状态。工作流架构会对客户请求进行分类,并通过一个分步流程进行路由:
+沿用之前的同一个示例,客户询问其订单状态。一个 工作流架构会先对客户请求进行分类,再将其路由到一个逐步处理的过程中:
1. 提取订单 ID
-1. 查找订单详情
-1. 向模型提供订单详情以生成最终响应
+1. 查询订单详情
+1. 将订单详情提供给模型以生成最终回复
-此工作流中的每一步都有模型必须遵循的系统提示,将所有获取的数据放入友好的输出中。
+此 工作流 中的每个步骤都有自己的系统提示,模型必须遵循该提示,并将所有获取的数据整合为友好的输出。
@@ -216,7 +216,7 @@ LLM 更擅长在选项之间进行判别。因此,评估
- 模型是否遵循指令,尝试提取订单
+ 模型是否遵循指令尝试提取 Order
ID?
@@ -245,24 +245,24 @@ LLM 更擅长在选项之间进行判别。因此,评估
-### 单智能体架构
+### Single-智能体 架构
-与工作流不同,智能体解决需要灵活决策的非结构化问题。一个智能体拥有指令和一组工具,并动态选择使用哪个工具。这引入了新的非确定性机会。
+与工作流不同,智能体解决需要灵活决策的非结构化问题。智能体包含指令和一组工具,并动态选择要使用的工具。这带来了一种新的不确定性。
-工具是开发者定义的代码块,模型可以执行这些代码。这
- 可以从小的辅助函数到对现有服务的API调用。例如,
- 例如, `check_order_status(order_id)` 可以是一个工具,它接收
- 参数 `order_id` 并调用API来检查订单状态。
+工具是开发者定义的代码块,模型可以执行这些代码块。这
+ 可以是从小型辅助函数到对现有服务的 API 调用。例如,
+ 例如, `check_order_status(order_id)` 可以是一个工具,它接受
+ 参数 `order_id` 并调用 API 来检查订单状态。
#### 示例
-让我们调整客服示例,改用单个智能体。该智能体可访问三种不同的工具:
+让我们改用单个 智能体 来改造前面的客服示例。该 智能体 可以使用三种不同的工具:
- 订单查询工具
- 密码重置工具
- 产品常见问题工具
-当客户询问订单状态时,智能体会动态决定是调用工具还是回复客户。例如,如果客户问“我的订单状态是什么?”,智能体现在可以通过向客户请求订单号来跟进。这有助于创造更自然的用户体验。
+当客户询问订单状态时,智能体 会动态决定是调用工具还是回复客户。例如,如果客户询问:“我的订单状态是什么?”智能体 现在可以通过向客户请求订单 ID 来进行跟进。这有助于创造更自然的用户体验。
@@ -330,24 +330,24 @@ LLM 更擅长在选项之间进行判别。因此,评估
-### 多智能体架构
+### Multi-智能体 architectures
-当你在单一智能体架构中添加工具和任务时,模型可能难以遵循指令或选择正确的工具来调用。多智能体架构通过创建多个专注于不同领域的独立智能体来提供帮助。这种在多个交接之间的分类和智能体引入了新的非确定性机会。
+当你向单一智能体架构中添加工具和任务时,模型可能难以遵循指令或选择正确的工具进行调用。多智能体架构通过创建若干各自专精不同领域的智能体来帮助解决这个问题。在多个智能体之间进行分流和交接会引入新的不确定性。
-使用多智能体架构的决定应由你的评估驱动。
- 从多智能体架构开始会添加不必要的复杂性,这可能
- 减缓你达到生产环境的时间。
+是否采用多智能体架构,应当由你的评估结果来决定。
+ 从一开始就采用多智能体架构会带来不必要的复杂性,可能
+ 延缓你进入生产环境的时间。
#### 示例
-将单智能体示例拆分为多智能体架构后,我们将有四个不同的智能体:
+将单一智能体示例拆分为多智能体架构后,我们将得到四个不同的智能体:
-1. 分诊智能体
-1. 订单智能体
-1. 账户管理智能体
-1. 销售智能体
+1. 分诊 智能体
+1. 订单 智能体
+1. 账户管理 智能体
+1. 销售 智能体
-当客户询问订单状态时,分流智能体可将对话交接给订单智能体来查询订单。如果客户改变话题询问产品,订单智能体应将请求交回分流智能体,再由其交接给销售智能体获取产品信息。
+当客户询问订单状态时,分诊智能体可能会将对话交接给订单智能体以查询订单。如果客户改变话题,询问某个产品,订单智能体应将该请求交回给分诊智能体,然后由其交接给销售智能体以获取产品信息。
@@ -359,32 +359,32 @@ LLM 更擅长在选项之间进行判别。因此,评估
| Inputs provided by the developer and user |
**Instruction following**: Does the model accurately understand and act according to the provided instructions?
-**指令遵循**:模型是否优先遵循系统提示而非冲突的用户提示? |
- 模型是否专注于分流任务,还是会被用户的问题所左右?
+**指令遵循**:模型是否会优先遵循系统提示,而非与之冲突的用户提示? |
+ 模型是否专注于分诊任务,还是会被用户的问题带偏?
-假设 `lookup_order` 调用已返回,订单智能体是否返回了追踪号和交货日期(不要求正确)? |
+假设 `lookup_order` 调用已返回,订单智能体是否返回了跟踪号和送达日期(不一定是正确的)?
| Outputs generated by the model |
**Functional correctness**: Are the model's outputs are accurate, relevant, and thorough enough to fulfill the intended task or objective? |
Does the model's determination of intent correctly match the expected intent?
-假设 `lookup_order` 调用已返回,订单智能体是否在其响应中提供了正确的追踪号和交货日期?
+假设 `lookup_order` 调用已返回,订单智能体是否在其响应中提供正确的跟踪号和送达日期?
-订单智能体是否遵循系统指令,在处理退货前询问客户申请退货的原因? |
+订单智能体是否遵循系统指令,在处理退货前先询问客户申请退货的原因?
| Tools chosen by the model |
**Tool selection**: Evaluations that test whether the agent is able to select the correct tool to use.
-**数据精确性**:验证智能体是否以正确的参数调用工具的评估。通常这些参数是从对话历史中提取的,因此目标是验证这种提取是否正确。 |
+**数据精度**:验证智能体使用正确参数调用工具的评估。这些参数通常从对话历史中提取,因此目标是验证该提取过程是否正确。
订单智能体是否正确调用了查询订单工具?
订单智能体是否正确调用了 `refund_order` 工具?
-订单智能体是否使用正确的订单 ID 调用了查询订单工具?
+订单智能体是否使用正确的订单 ID 调用查询订单工具?
-账户智能体是否正确调用了 `reset_password` 工具并使用了正确的账户 ID? |
+账户智能体是否正确调用了 `reset_password` 使用正确的账户 ID 调用的工具?
@@ -392,7 +392,7 @@ LLM 更擅长在选项之间进行判别。因此,评估
| **Agent handoff accuracy**: Evaluations that test whether each agent can appropriately recognize the decision boundary for triaging to another agent |
When a user asks about order status, does the triage agent correctly pass to the order agent?
-当用户改变话题谈论最新产品时,订单智能体是否将控制权交回分流智能体? |
+当用户改变主题,谈到最新产品时,订单智能体是否将控制权交回给分诊智能体?
@@ -402,90 +402,90 @@ LLM 更擅长在选项之间进行判别。因此,评估
### 基于指标的评估
-定量评估提供数值评分,可用于筛选和排名结果。它们为自动化回归测试提供了有用的基准。
+定量评估可以提供一个数值分数,供你用于筛选和排序结果。它们为自动化回归测试提供了有用的基准。
-- **示例**:精确匹配、字符串匹配、ROUGE/BLEU 评分、函数调用准确率、可执行评估(执行以评估功能或行为,例如 text2sql)
-- **挑战**:可能未针对特定用例定制,可能遗漏细微差别
+- **示例**:精确匹配、字符串匹配、ROUGE/BLEU 评分、函数调用准确性、可执行评估(通过执行来评估功能或行为——例如 text2sql)
+- **挑战**:可能无法针对特定用例量身定制,可能遗漏细微之处
-### 人工评估
+### Human evals
-人工判断评估质量最高,但速度慢且成本高。
+人工评估能够提供最高质量的结果,但速度较慢且成本较高。
-- **示例**:浏览系统输出,了解其表现是否更好或更差;创建随机、盲测的测试,让员工、承包商或外包标注机构评判系统输出的质量(例如,对少量可能的输出进行排序,或给每个输出打1-5分)
-- **挑战**:人类专家之间存在分歧,成本高,速度慢
+- **示例**: 粗略浏览系统输出,大致判断输出是更好还是更差;创建随机化、盲测的测试,由员工、合同工或外包标注机构评判系统输出的质量(例如,对一小批候选输出进行排序,或为每个输出打出 1-5 的评分)
+- **挑战**: 人类专家之间存在分歧,且成本高昂、速度缓慢
- **建议**:
- - 进行多轮详细的人工审查,以完善评分卡
- - 通过提供不同评分等级(例如,10分中的1分、3分和8分)的示例,实施“展示而非告知”的政策
- - 除数字评分外,还需包含通过/失败阈值
- - 汇总多个评审者意见的简单方法是采用共识投票
+ - 开展多轮细致的人工评审,以不断完善评分卡
+ - 通过提供不同评分等级的示例(例如 1、3、8 分,满分 10 分),实施"展示而非告知"的策略
+ - 除数值评分之外,再加入通过/未通过的门槛
+ - 汇总多名评审人员意见的一种简单方法是采用共识投票
-### LLM-as-a-judge 与模型评分器
+### LLM-as-a-judge 和模型评分器
-使用模型来判断输出比人工评估成本更低、扩展性更好。从 [`gpt-5.6`](https://developers.openai.com/api/docs/models/gpt-5.6-sol) 开始,当你需要强大的大语言模型裁判时,先对照人工标签验证一致性,然后再优化成本或延迟。
+使用模型来评判输出比人工评估更便宜且更具可扩展性。可从 [`gpt-5.6`](https://developers.openai.com/api/docs/models/gpt-5.6-sol) 入手,当你需要一个强大的 LLM 评判器时,在针对成本或延迟进行优化之前,先根据人工标注验证一致性。
- **示例**:
- - 成对比较:向评判模型展示两个回答,并要求其基于特定标准判断哪个更好
- - 单一答案评分:评判模型独立评估单个回答,根据预定义的质量指标给出分数或评级
- - 参考引导评分:向评判模型提供参考答案或“黄金标准”答案,作为评估给定回答的基准
-- **挑战**:位置偏差(回答顺序)、冗长偏差(偏好更长的回答)
+ - 两两对比:向评判模型展示两个回答,让它根据特定标准判断哪一个更好
+ - 单答案评分:评判模型单独评估一个回答,根据预定义的质量指标为其打分或评级
+ - 参考引导评分:向评判模型提供一个参考答案或“金标准”答案,作为评估给定回答的基准
+- **挑战**:位置偏差(回答顺序)、冗长度偏差(倾向于更长的回答)
- **建议**:
- - 使用成对比较或通过与失败判定,以获得更高的可靠性
- - 如果可能,使用能力最强的模型进行评分。先从 [`gpt-5.6`](https://developers.openai.com/api/docs/models/gpt-5.6-sol),开始,然后验证专门的推理模型是否在你的评分标准或参考答案集上表现更好
- - 控制回答长度,因为大语言模型总体上偏向于更长的回答
- - 在评分前添加推理和思维链,因为推理能改善评估性能
- - 一旦大语言模型评判员达到更快、更便宜且与人工标注持续一致的程度,就可以扩大规模
- - 设计问题结构以允许自动评分,同时保持任务的完整性——常见做法是将问题重新格式化为多项选择形式
- - 确保评估评分标准清晰且详细
+ - 使用两两对比或通过/不通过评估以获得更高可靠性
+ - 如果可以的话,使用能力最强的模型来评分。从 [`gpt-5.6`](https://developers.openai.com/api/docs/models/gpt-5.6-sol),开始,然后验证专用的推理模型在你的评分标准或参考答案集上是否表现更好
+ - 控制回答长度,因为 LLM 通常会偏向更长的回答
+ - 加入推理和思维链,因为在评分前进行推理可以提升评估表现
+ - 当 LLM 评判在速度、成本上更优,并且与人工标注保持一致时,就可以扩大规模
+ - 将问题设计成支持自动评分的形式,同时保持任务的完整性——一种常见做法是将问题重新格式化为选择题
+ - 确保评估标准清晰且详细
-没有任何策略是完美的。LLM 作为评判者的质量因问题上下文而异,而使用专家人工标注者提供真实标签既昂贵又耗时。
+没有一种策略是完美的。LLM 作为裁判的质量会因问题上下文而异,而使用专家人工标注者提供真实标签既昂贵又耗时。
## 处理边界情况
-尽管你的评估应覆盖每种架构的主要、理想路径场景,但现实世界的 AI 系统经常会遇到挑战系统性能的边缘情况。评估这些边缘情况对于确保可靠性和良好的用户体验至关重要。
+虽然你的评估应覆盖每种架构的主要正常路径场景,但现实中的 AI 系统经常会遇到挑战系统性能的边缘情况。评估这些边缘情况对于确保可靠性和良好的用户体验非常重要。
-我们看到这些边缘情况分为几类:
+我们将这些边缘情况归纳为几个类别:
### 输入可变性
-由于用户向模型提供输入,我们的系统必须足够灵活,以处理用户可能采用的不同交互方式,例如:
+由于用户会向模型提供输入,我们的系统必须具备足够的灵活性,以处理用户与我们交互时可能采用的不同方式,例如:
- 非英文或多语言输入
- 输入文本以外的格式(例如 XML、JSON、Markdown、CSV)
- 输入模态(例如图像)
-你对指令遵循和功能正确性的评估需要容纳用户可能尝试的输入。
+针对指令遵循和功能正确性的评估需要考虑用户可能尝试的输入。
### 上下文复杂度
-许多基于 LLM 的应用因对请求上下文理解不佳而失败。此上下文可能来自用户或过往对话历史中的噪音。
+许多基于 LLM 的应用失败,是因为对请求上下文理解不足。这些上下文可能来自用户,也可能来自过往对话历史中的噪声。
示例包括:
- 单个请求中包含多个问题或意图
-- 拼写错误和拼写失误
-- 上下文极少的简短请求(例如,如果用户只输入:“returns”)
+- 拼写错误或拼写问题
+- 上下文较少的简短请求(例如,用户仅说:“returns”)
- 长上下文或长时间运行的对话
-- 工具调用返回的数据具有不明确的属性名称(例如, `"on: 123"`,其中“on”是订单号)
-- 多个工具调用,有时会导致参数不正确
-- 多次智能体交接,有时会导致循环交接
+- 返回的数据中属性名称含糊不清的工具调用(例如。, `"on: 123"`,其中“on”是订单编号)
+- 多次工具调用,有时会导致参数错误
+- 多次 智能体 交接,有时会导致循环交接
### 个性化与定制
-虽然 AI 通过适应用户特定请求来改善用户体验,但这种灵活性也引入了许多边缘情况。请为你想专门支持和阻止的用例明确定义评估:
+虽然 AI 通过适应用户特定请求来改善用户体验,但这种灵活性会引入许多边界情况。请为你要明确支持或阻止的用例清晰地定义评估:
-- 越狱尝试,目的是让模型做出不同的事情
-- 格式化请求(例如,格式化为 JSON,或使用项目符号)
-- 用户提示与你的系统提示冲突的情况
+- 试图让模型执行不同操作的越狱行为
+- 格式请求(例如,要求以 JSON 格式输出,或使用项目符号列表)
+- 用户提示与你的系统提示发生冲突的情形
-## 使用 evals 提升性能
+## 使用评估提升性能
-当你的评估达到能持续衡量性能的成熟度时,转而使用评估数据来改进应用程序的性能。
+当你的评估达到一定成熟度,能够稳定衡量性能时,就可以转为使用评估数据来提升应用的性能。
-了解更多关于 [强化微调](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning) 以创建数据飞轮。
+了解有关 [强化微调](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning) 如何构建数据飞轮的更多信息。
## 其他资源
-如需更多灵感,请访问 [OpenAI Cookbook](https://developers.openai.com/cookbook),其中包含示例代码和第三方资源链接,或进一步了解我们的评估工具:
+如需更多灵感,请访问 [OpenAI Cookbook](https://developers.openai.com/cookbook),其中包含示例代码和第三方资源链接,或详细了解我们的评估工具:
- [评估模型性能](https://developers.openai.com/api/docs/guides/evals)
- [如何评估摘要任务](https://developers.openai.com/cookbook/examples/evaluation/how_to_eval_abstractive_summarization)
diff --git a/docs/zh/api/docs/guides/latest-model/gpt-4.1.md b/docs/zh/api/docs/guides/latest-model/gpt-4.1.md
index cb1b97e..99272ea 100644
--- a/docs/zh/api/docs/guides/latest-model/gpt-4.1.md
+++ b/docs/zh/api/docs/guides/latest-model/gpt-4.1.md
@@ -1,34 +1,34 @@
# 使用 GPT-4.1
-> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需查看完整的文档索引,请参阅 [llms.txt](/llms.txt)。通过在页面 URL 后追加 `.md` 即可获得文档页面的 Markdown 版本。
## 简介
-GPT-4.1 模型系列在编码、指令跟随和长上下文等能力方面相较 GPT-4o 实现了显著进步。在本提示指南中,我们汇集了一系列源自大量内部测试的重要提示技巧,帮助开发者充分利用这一新模型系列的增强能力。
+GPT-4.1 系列模型相较 GPT-4o 在编码、指令遵循和长上下文能力方面迈出了重要一步。在本提示指南中,我们汇总了一系列来自大量内部测试的重要提示技巧,帮助开发者充分发挥这一新模型系列的改进能力。
-许多典型的优秀实践仍然适用于 GPT-4.1,例如提供上下文示例、使指令尽可能具体清晰,以及通过提示引发规划以最大化模型智能。然而,我们预计要充分利用该模型,将需要进行一些提示迁移。GPT-4.1 经过训练,比其前代更严格且更字面地遵循指令,而前代往往更宽松地从用户和系统提示中推断意图。但这也意味着,GPT-4.1 具有高度可操控性,并对明确指定的提示响应灵敏——如果模型行为与你预期不同,只需一句坚定而明确地阐明所需行为的话,几乎总能引导模型回归正轨。
+许多典型的最佳实践仍然适用于 GPT-4.1,例如提供上下文示例、让指令尽可能具体清晰,以及通过提示引导规划以最大化模型智能。然而,我们预计要充分发挥该模型的能力,需要进行一定的提示调整。GPT-4.1 经过训练,能够比其前代模型更严格、更字面化地遵循指令;前代模型往往更自由地从用户和系统提示中推断意图。不过,这也意味着 GPT-4.1 具有高度的可控性,能够响应明确指定的提示——如果模型行为与你的预期不同,几乎只需用一句坚定且明确的陈述说明你期望的行为,就足以将模型引导回正轨。
-请继续阅读可作参考的提示示例,并记住,虽然本指南适用范围广泛,但没有任何建议放之四海而皆准。AI 工程本质上是一门经验性学科,大语言模型本质上具有不确定性;除遵循本指南外,我们建议构建信息丰富的评估并经常迭代,以确保你的提示工程改进能为你的使用场景带来收益。
+请继续浏览这些可供参考的提示示例,并请记住,虽然这些指导具有广泛的适用性,但没有任何建议是万能的。AI 工程本质上是一门经验性学科,大语言模型本质上是非确定性的;除了遵循本指南外,我们还建议构建信息丰富的评估并经常迭代,以确保你的提示工程改动确实为你的用例带来收益。
-## 新增内容
+## 新增功能
-- 比之前的 GPT 模型更贴近字面、更遵循指令
-- 更强的编码和长上下文行为
-- 通过 API 原生工具使用时,更好地遵循模式 `tools` 字段
-- 针对智能体工作流和差异生成的提示迁移指南
+- 比之前的 GPT 模型更贴近原文、更忠实地遵循指令
+- 更强的编码与长上下文行为
+- 在通过 tools 字段传入 schema 时,更强的 API 原生工具调用能力 `tools` tools 字段
+- 面向智能体工作流与 diff 生成的提示词迁移指引
## 迁移快速入门
-- 将模型 slug 更新为 `gpt-4.1`.
+- 将模型标识符更新为 `gpt-4.1`.
- 根据你的集成方式,使用 Responses API 或 Chat Completions API。
-- 移除推理相关参数;GPT-4.1 是非推理模型。
-- 通过 API 传递工具模式 `tools` 字段,而不是将工具定义注入提示词中。
-- 审查提示词以确保严格遵循指令,在需要处添加明确的持久性和工具使用规则,并使用评估验证更改。
+- 移除与推理相关的参数;GPT-4.1 是非推理模型。
+- 通过 API 传入工具 schema `tools` 字段,而不是将工具定义注入到提示中。
+- 审阅提示中是否按字面意思遵循指令,必要时添加明确的持久性和工具使用规则,并通过评估验证更改。
-## 模型、API 及功能更新
+## 模型、API 与功能更新
- GPT-4.1 系列包括 `gpt-4.1`, `gpt-4.1-mini`,以及 `gpt-4.1-nano`.
-- GPT-4.1 拥有 1M-token 上下文窗口,并且无需推理步骤即可实现低延迟。
+- GPT-4.1 具有 1M token 的上下文窗口,并且在不进行推理步骤的情况下保持低延迟。
- 该系列支持 Responses API 和 Chat Completions API。
- GPT-4.1 和 GPT-4.1 mini 支持监督微调。
- 支持的工具包括函数调用、网页搜索、文件搜索、图像生成、代码解释器和远程 MCP。
@@ -38,45 +38,45 @@ GPT-4.1 模型系列在编码、指令跟随和长上下文等能力方面相较
### 1. 智能体工作流
-GPT-4.1 是构建智能体工作流的理想选择。在模型训练中,我们强调提供多样化的智能体问题解决轨迹,并且该模型的智能体测试框架在 SWE-bench Verified 上实现了非推理模型的最先进性能,解决了 55% 的问题。
+GPT-4.1 是构建智能体工作流的理想起点。在模型训练中,我们着重提供多样化的智能体问题求解轨迹,并且该模型的智能体评测框架在 SWE-bench Verified 上的非推理模型中达到了业界领先水平,解决了 55% 的问题。
-### 系统提示词提醒
+### 系统提示提醒
-为了充分利用 GPT-4.1 的智能体能力,我们建议在所有智能体提示中包含三种关键类型的提醒。以下提示针对智能体编码工作流进行了专门优化,但可以轻松修改以用于一般的智能体用例。
+为了充分利用 GPT-4.1 的智能体能力,我们建议在所有 智能体 提示中包含三种关键类型的提醒。以下提示是专门为智能体编码 工作流 优化的,但可以轻松修改以适用于一般的智能体用例。
-1. 持久性:这确保模型理解它正在进入一个多消息轮次,并防止其过早地将控制权交还给用户。我们的示例如下:
+1. Persistence(持久性):用于让模型理解自己正在进入一个多轮对话回合,避免过早地把控制权交还给用户。我们的示例如下:
```text
You are an agent - please keep going until the user’s query is completely resolved, before ending your turn and yielding back to the user. Only terminate your turn when you are sure that the problem is solved.
```
-2. 工具调用:这鼓励模型充分利用其工具,并减少其产生幻觉或猜测答案的可能性。我们的示例如下:
+2. Tool-calling(工具调用):用于鼓励模型充分利用其工具,降低其产生幻觉或猜测答案的可能性。我们的示例如下:
```text
If you are not sure about file content or codebase structure pertaining to the user’s request, use your tools to read files and gather the relevant information: do NOT guess or make up an answer.
```
-3. 规划 \[(可选)\]:如果希望,这确保模型在文本中明确规划并反思每次工具调用,而不是仅通过串联一系列工具调用来完成任务。我们的示例如下:
+3. Planning \[optional\]: 如果需要,可确保模型以文本形式对每次工具调用进行显式的规划与反思,而不是通过串联一系列仅有工具调用的方式直接完成任务。我们的示例如下:
```text
You MUST plan extensively before each function call, and reflect extensively on the outcomes of the previous function calls. DO NOT do this entire process by making function calls only, as this can impair your ability to solve the problem and think insightfully.
```
-GPT-4.1 经过训练,可在智能体场景中非常紧密地遵循用户指令和系统提示。该模型严格遵守这三条简单指令,将我们内部的 SWE-bench Verified 分数提高了近 20% \- ,因此我们强烈建议在启动任何智能体提示时,加入涵盖上述三类的清晰提醒。总体而言,我们发现这三条指令能将模型从类似聊天的状态转变为更加“积极”的智能体,自主且独立地推动交互向前发展。
+GPT-4.1 经过训练,能够在智能体场景中非常紧密地遵循用户指令和系统提示。该模型紧密遵循了这三条简单指令,并使我们的内部 SWE-bench Verified 得分提升了近 20% \- 因此,我们强烈鼓励在任何 智能体 提示开头加入涵盖上述三类内容的明确提醒。总体而言,我们发现这三条指令可以将模型从类似聊天机器人的状态转变为更加“主动”的 智能体,自主且独立地推动交互向前发展。
### 工具调用
-与之前的模型相比,GPT-4.1 在有效利用作为参数传入 OpenAI API 请求的工具方面经过了更多训练。我们鼓励开发者专门使用 tools 字段来传递工具,而不是像一些过去报告的那样,手动将工具描述注入提示词并编写单独的工具调用解析器。这是最小化错误并确保模型在工具调用轨迹中保持分布内的最佳方式 \- 在我们自己的实验中,我们观察到,使用 API 解析的工具描述相比手动将模式注入系统提示词,SWE-bench Verified 通过率提高了 2%。
+相比之前的模型,GPT-4.1 接受了更多关于有效使用 OpenAI API 请求中作为参数传入的工具的训练。我们建议开发者仅使用 tools 字段来传递工具,而不要像过去一些人所做的那样,手动将工具描述注入到提示中,并为工具调用编写单独的解析器。这是最小化错误并确保模型在工具调用轨迹中保持分布内的最佳方式 \- 在我们自己的实验中,我们观察到使用 API 解析的工具描述相比手动将 schema 注入到系统提示中,SWE-bench Verified 通过率提升了 2%。
-开发者应为工具清晰命名以表明其用途,并在工具的“description”字段中添加清晰、详细的描述。同样,对于每个工具参数,也应借助良好的命名和描述来确保适当的使用。如果你的工具特别复杂,并且希望提供工具使用示例,我们建议你在系统提示词中创建一个 `# Examples` 部分并将示例放在那里,而不是将它们添加到“description”字段中,该字段应保持详尽但相对简洁。提供示例有助于指示何时使用工具、是否在工具调用中包含用户文本,以及针对不同输入应使用哪些参数。请记住,你可以在 [Prompt Playground](https://platform.openai.com/playground) 中找到你的新工具定义的良好起点。
+开发者应为工具取一个能清晰表明其用途的名称,并在工具的 "description" 字段中添加清晰、详细的描述。类似地,对于每个工具参数,也要依靠良好的命名和描述来确保正确的使用。如果你的工具特别复杂,并且希望提供工具用法的示例,我们建议你在系统提示中创建一个 `# Examples` 部分,并将示例放在那里,而不是将它们添加到 "description" 字段中——该字段应保持详尽但相对简洁。提供示例有助于指明何时使用工具、是否在工具调用时附带用户文本,以及针对不同输入应使用哪些参数。记住,你可以使用 [Prompt Playground](https://platform.openai.com/playground) 来获得新工具定义的良好起点。
-### 提示引发的规划与思维链
+### 提示诱导规划与思维链
-如前所述,开发者可以可选地提示使用 GPT-4.1 构建的 智能体 在工具调用之间进行规划和反思,而不是在不间断的序列中静默调用工具。GPT-4.1 不是推理模型 \- 这意味着它在回答之前不会产生内部的思维链 \- 但在提示中,开发者可以通过使用上述 Planning 提示组件的任何变体来诱导模型产生显式的、逐步的计划。这可以看作是模型“边想边说”。在我们对 SWE-bench Verified 智能体任务的实验中,诱导显式规划将通过率提高了 4%。
+如前所述,开发者可以选择性地提示使用 GPT-4.1 构建的智能体在工具调用之间进行规划和反思,而不是以不间断的顺序静默调用工具。GPT-4.1 不是推理模型 \- 这意味着它在回答之前不会产生内部的思维链 \- 但在提示中,开发者可以通过使用上文所示 Planning 提示组件的任何变体来诱导模型产生显式的、逐步的计划。这可以看作是模型“边想边说”。在我们对 SWE-bench Verified 智能体任务的实验中,诱导显式规划使通过率提高了 4%。
### 示例提示:SWE-bench Verified
-下面,我们分享用于在 SWE-bench Verified 上取得最高分的智能体提示词,其中包含关于工作流和问题解决策略的详细说明。此通用模式可用于任何智能体任务。
+下面,我们将分享我们在 SWE-bench Verified 上取得最高分所使用的智能体提示词,其中包含关于 工作流 和问题解决策略的详细说明。这种通用模式可用于任何智能体任务。
```python
from openai import OpenAI
@@ -469,15 +469,15 @@ puts(response.output_text)
### 2. 长上下文
-GPT-4.1 拥有高性能的 100 万 token 输入上下文窗口,适用于多种长上下文任务,包括结构化文档解析、重新排序、在忽略无关上下文的同时选择相关信息,以及利用上下文进行多跳推理。
+GPT-4.1 拥有高性能的 1M token 输入上下文窗口,可用于多种长上下文任务,包括结构化文档解析、重排序、在忽略无关上下文的情况下筛选相关信息,以及利用上下文进行多跳推理。
### 最佳上下文大小
-我们观察到在完整的 1M token 上下文中,针尖寻针(needle-in-a-haystack)评估表现非常好,在混合相关与不相关代码及其他文档的复杂任务中也表现出非常强的性能。然而,当需要检索更多项,或执行需要了解整个上下文状态的复杂推理(例如执行图搜索)时,长上下文性能可能会下降。
+在我们的完整 1M token 上下文中,大海捞针评估表现出非常出色的性能,并且我们观察到在同时混合相关与不相关的代码以及其他文档的复杂任务上,性能也相当强劲。然而,当需要检索的项目数量增多,或需要基于整个上下文状态进行复杂推理(例如执行图搜索)时,长上下文性能可能会下降。
-### 调优上下文依赖
+### Tuning Context Reliance
-考虑回答你的问题时可能需要的外部与内部世界知识的混合。有时模型需要利用自身知识来连接概念或进行逻辑跳跃,而在其他情况下,只使用提供的上下文是可取的
+考虑回答你的问题可能需要的外部世界知识与内部世界知识的组合。有时让模型运用自身知识来关联概念或进行逻辑跳跃很重要,而在其他情况下则应仅使用提供的上下文
```text
# Instructions
@@ -489,13 +489,13 @@ GPT-4.1 拥有高性能的 100 万 token 输入上下文窗口,适用于多种
### 提示词组织
-尤其是在长上下文使用场景中,指令和上下文的放置位置会影响性能。如果提示词中包含长上下文,理想情况下应将指令放在所提供上下文的开头和结尾两处,因为我们发现这样比仅放在上方或下方效果更好。如果你希望只放置一次指令,那么放在所提供上下文的上方比放在下方效果更好。
+在长上下文使用场景中,指令和上下文的位置会影响性能。如果你的提示中包含较长的上下文,理想的做法是将指令同时放在所提供上下文的开头和结尾处,因为我们发现这种方式的性能优于仅放在上方或下方。如果你希望指令只出现一次,那么放在所提供上下文上方比下方效果更好。
### 3. 思维链
-如前所述,GPT-4.1 并非推理模型,但提示模型逐步思考(称为“思维链”)可以有效地让模型将问题分解为更易处理的部分、加以解决并提升整体输出质量,其代价是使用更多输出 token 带来的更高成本和延迟。该模型经过训练,在智能体推理和现实世界问题解决方面表现良好,因此无需过多提示即可表现出色。
+如上所述,GPT-4.1 不是推理模型,但提示模型逐步思考(即所谓的“思维链”)可以成为让模型将问题拆分为更易处理的子问题、逐一求解并提升整体输出质量的有效方式,代价是会使用更多输出 token,从而带来更高的成本和延迟。该模型经过了针对智能体推理和真实世界问题解决的训练,因此无需过多提示即可表现良好。
-我们建议从提示末尾添加以下基本思维链指令开始:
+我们建议你在提示末尾使用以下这条基础的思维链指令作为起点:
```text
...
@@ -503,9 +503,9 @@ GPT-4.1 拥有高性能的 100 万 token 输入上下文窗口,适用于多种
First, think carefully step by step about what documents are needed to answer the query. Then, print out the TITLE and ID of each document. Then, format the IDs into a list.
```
-在此基础上,你应该通过审查特定示例和评估中的失败案例来改进思维链 (CoT) 提示,并用更明确的指令解决系统性的规划和推理错误。在无约束的 CoT 提示中,模型尝试的策略可能存在差异;如果你观察到某种有效的方法,可以将其编纂到提示中。一般而言,错误往往源于对用户意图的误解、上下文收集或分析不足,或逐步思考不充分或不正确,因此请注意这些问题,并尝试用更具指导性的指令来应对。
+在此基础上,你应当通过审视具体示例和评估中的失败案例来改进思维链 (CoT) 提示,并使用更明确的指令来解决系统性的规划和推理错误。在不受约束的 CoT 提示中,模型尝试的策略可能存在差异;如果你观察到某种方法效果良好,可以将该策略固化到提示中。一般来说,错误往往源于误解用户意图、上下文收集或分析不足,以及分步思考不够充分或不正确,因此请留意这些问题,并尝试用更有针对性的指令加以解决。
-以下是一个示例提示,指示模型在作答前更系统性地分析用户意图并考虑相关上下文。
+下面是一个示例提示,它指示模型在开始作答前更有条理地分析用户意图并考虑相关上下文。
```text
# Reasoning Strategy
@@ -526,35 +526,35 @@ First, think carefully step by step about what documents are needed to answer th
### 4. 指令遵循
-GPT-4.1 展现出卓越的指令遵循性能,开发者可以利用这一特性来精确塑造和控制其特定用例的输出。开发者经常进行大量提示,以涵盖智能体推理步骤、响应语气和声音、工具调用信息、输出格式、应避免的主题等。然而,由于模型更严格地遵循指令,开发者可能需要包含关于该做什么或不该做什么的明确规范。此外,为其他模型优化的现有提示可能无法立即与此模型配合使用,因为现有指令会被更紧密地遵循,而隐式规则不再被强烈地推断出来。
+GPT-4.1 表现出卓越的指令遵循能力,开发者可以利用这一点来精准塑造并控制其特定用例的输出。开发者通常会广泛地为智能体推理步骤、响应语气和风格、工具调用信息、输出格式、需要避免的话题等内容编写提示。然而,由于该模型会更严格地遵循指令,开发者可能需要明确指明该做什么或不该做什么。此外,为其他模型优化的现有提示可能无法直接套用于此模型,因为现有指令会被更严格地遵循,原本被强烈推断出的隐含规则不再被如此强烈地推断出来。
-### 推荐工作流
+### 推荐的工作流
-以下是我们推荐的用于开发和调试提示中指令的工作流:
+以下是我们推荐的提示词中指令开发和调试的工作流:
-1. 首先添加一个整体的“响应规则”或“指令”部分,包含高层次指导和要点列表。
-2. 如果您想要改变更具体的行为,请为该类别添加一个部分来详细说明,例如 `# Sample Phrases`.
-3. 如果您希望模型在其 工作流 中遵循特定步骤,请添加一个有序列表,并指示模型遵循这些步骤。
-4. 如果行为仍然不符合预期:
- 1. 检查是否存在冲突、表述不清或错误的指令和示例。如果存在冲突的指令,GPT-4.1 倾向于遵循更接近提示末尾的那一条。
- 2. 添加展示期望行为的示例;确保您的示例中展示的任何重要行为也在您的规则中被引用。
- 3. 通常不需要使用全大写或其他激励手段,如奖赏或小费。我们建议先不使用这些,只在您的特定提示需要时才使用。请注意,如果您的现有提示包含这些技巧,可能会导致 GPT-4.1 过度关注它们。
+1. 首先用一个整体的“回复规则”或“指令”章节,提供高层级的指导要点和项目符号列表。
+2. 如果想修改更具体的行为,可以新增一个章节来细化该类别,例如 `# Sample Phrases`.
+3. 如果希望模型在其工作流中遵循特定步骤,请添加一个有序列表并指示模型按这些步骤执行。
+4. 如果行为仍不符合预期:
+ 1. 检查是否存在冲突、不够明确或错误的指令与示例。如果存在冲突的指令,GPT-4.1 倾向于遵循更靠近提示末尾的那一条。
+ 2. 添加能够展示期望行为的示例,并确保示例中展示的所有重要行为也在规则中加以说明。
+ 3. 通常无需使用全大写或奖励、小费等其他激励手段。我们建议先不使用这些技巧,只有在你的特定提示确实必要时再采用。请注意,如果现有提示中已经使用了这些技巧,可能会导致 GPT-4.1 过于严格地遵循它们。
-_请注意,使用你偏好的 AI 驱动的 IDE 对于迭代提示词非常有帮助,包括检查一致性或冲突、添加示例,或进行连贯的更新,比如添加一条指令并更新指令以演示该指令。_
+_请注意,使用你常用的 AI 驱动 IDE 对于迭代优化提示非常有帮助,包括检查一致性或冲突、补充示例,或进行统一的更新(例如新增一条指令并相应更新其他指令以体现该指令)。_
-### 常见故障模式
+### 常见失败模式
-这些故障模式并非 GPT-4.1 独有,但此处列出以供一般性了解并便于排查。
+这些失败模式并非 GPT-4.1 独有,但我们在此处列出它们,以便于大家了解并进行调试。
-- 指示模型始终遵循特定行为偶尔会诱发不良影响。例如,如果被告知“在回复用户之前必须先调用工具”,模型可能会虚构工具输入,或在信息不足时以空值调用工具。加上“如果你没有足够的信息来调用工具,请向用户询问所需信息”应能缓解这一问题。
-- 提供示例短语时,模型可能会逐字引用这些示例,从而让用户感觉回复重复。请确保指示模型在必要时对这些示例进行变化。
-- 没有具体指示时,某些模型可能急于提供额外散文来解释其决策,或输出比预期更多的格式。提供指示及可能的示例有助于缓解此问题。
+- 指示模型始终遵循特定行为,有时会产生不良影响。例如,如果告诉模型“你必须在回复用户之前先调用工具”,那么当模型没有足够信息时,可能会幻觉出工具输入或使用 null 值调用工具。补充说明“如果你没有足够的信息来调用工具,请向用户询问你需要的信息”应当能缓解这个问题。
+- 当提供示例短语时,模型可能会逐字引用这些短语,从而开始让用户感到重复。确保你指示模型根据需要变换这些短语。
+- 在没有具体指示的情况下,一些模型可能会急于提供额外的文本来解释它们的决定,或在响应中输出过多不必要的格式。应当提供指示并辅以示例来帮助缓解这种情况。
-### 示例提示词:客户服务
+### 示例提示:客户服务
-这展示了虚构客户服务智能体的最佳实践。注意规则的多样性、具体性,使用额外章节以提供更详细的信息,以及一个示例来演示结合所有先前规则的精确行为。
+这演示了一个虚构的客户服务智能体的最佳实践。请注意规则的多样性、具体性、使用额外章节提供更多细节,以及通过示例来展示融合了所有先前规则的精确行为。
-尝试运行以下笔记本单元格 - 你应该会看到一条用户消息和工具调用,用户消息应以问候语开头,然后回显他们的答案,最后提到他们即将调用工具。尝试更改指令以塑造模型行为,或尝试其他用户消息,以测试指令遵循的性能。
+尝试运行以下 notebook 单元格——你应该会同时看到一条用户消息和一次工具调用,其中用户消息以问候语开头,然后回显其回答,再提及即将调用工具。可以尝试修改指令来塑造模型行为,或者尝试其他用户消息,以测试指令遵循效果。
```python
SYS_PROMPT_CUSTOMER_SERVICE = """You are a helpful customer service agent working for NewTelco, helping a user efficiently fulfill their request while adhering closely to provided guidelines.
@@ -808,11 +808,11 @@ puts(response.output_text)
'status': 'completed'}]
```
-### 5. 一般建议
+### 5. 通用建议
-### 提示词结构
+### 提示结构
-供参考,以下是构建提示词的一个良好起点。
+作为参考,这里有一个很好的起点,可用于构建你的提示词结构。
```text
# Role and Objective
@@ -833,14 +833,14 @@ puts(response.output_text)
# Final instructions and prompt to think step by step
```
-根据你的需求添加或移除章节,并通过实验确定最适合你使用的方案。
+根据需要添加或删除部分,并通过试验来确定最适合你使用场景的方案。
### 分隔符
-以下是为你的提示选择最佳分隔符的一些通用指南。请参阅长上下文部分,了解该上下文类型的特殊注意事项。
+以下是一些为你的提示选择最佳分隔符的通用指南。有关该上下文类型的特殊注意事项,请参阅长上下文(Long Context)部分。
-1. Markdown:我们建议从这里开始,使用 Markdown 标题来划分主要部分和小节(包括更深的层次结构,一直到 H4+)。使用行内反引号或反引号块来精确包裹代码,并根据需要使用标准的有序或无序列表。
-2. XML:这些也表现良好,并且我们改进了此模型对 XML 中信息的遵循程度。XML 便于精确包裹包含起始和结束的部分,向标签添加元数据以提供额外上下文,并支持嵌套。以下是一个使用 XML 标签在示例部分中嵌套示例的示例,每个示例都包含输入和输出:
+1. Markdown:我们建议你从这里开始,并为主要的章节与子章节(包括更深层级,至 H4 及以上)使用 Markdown 标题。必要时使用行内反引号或反引号代码块精确包裹代码,并使用标准的编号列表或项目符号列表。
+2. XML:XML 的表现同样出色,并且此模型对 XML 中信息的遵循度已得到改进。XML 便于精确包裹某个章节(包括起始与结束),可以为标签添加元数据以提供额外上下文,并且支持嵌套。下面是一个示例,展示如何使用 XML 标签在示例章节中嵌套示例,并为每个示例提供输入和输出:
```text
@@ -851,31 +851,31 @@ puts(response.output_text)
```
-3. JSON 结构高度结构化,模型对其理解得很好,特别是在编码上下文中。然而,它可能更冗长,并且需要字符转义,这会增加额外开销。
+3. JSON 结构化程度高,模型对其理解良好,尤其在编程场景中。不过 JSON 可能更冗长,并且需要字符转义,这会带来额外开销。
-关于向输入上下文添加大量文档或文件的特别指导:
+专门针对向输入上下文添加大量文档或文件的指导:
- XML 在我们的长上下文测试中表现良好。
- 示例: `The quick brown fox jumps over the lazy dog`
-- 这一格式由 Lee 等人提出([ref](https://arxiv.org/pdf/2406.13121)),在我们的长上下文测试中也表现良好。
+- 该格式由 Lee et al. ( 提出([参考](https://arxiv.org/pdf/2406.13121)),在我们的长上下文测试中也表现良好。
- 示例: `ID: 1 | TITLE: The Fox | CONTENT: The quick brown fox jumps over the lazy dog`
-- JSON 的表现尤为不佳。
+- JSON 表现尤其不佳。
- 示例: `[{'id': 1, 'title': 'The Fox', 'content': 'The quick brown fox jumped over the lazy dog'}]`
-该模型经过训练,能够稳健地理解多种格式中的结构。通常,请运用你的判断力,思考什么能向模型提供清晰的信息并“脱颖而出”。例如,如果你检索的文档包含大量XML,那么基于XML的分隔符可能效果较差。
+该模型经过训练,能够稳健地理解多种格式的结构。通常,你可以自行判断,考虑哪种方式能让信息清晰并对模型“突出”。例如,如果你检索的文档包含大量 XML,基于 XML 的分隔符效果可能较差。
### 注意事项
-- 在某些孤立情况下,我们观察到模型对生成非常长且重复的输出(例如逐一分析数百个项目)存在抵触。如果这对你的使用场景是必要的,请强烈指示模型完整输出这些信息,并考虑将问题分解或采用更简洁的方法。
-- 我们已经看到一些罕见的并行工具调用不正确的实例。我们建议对此进行测试,并考虑将 [parallel_tool_calls](https://developers.openai.com/api/reference/resources/responses/methods/create#responses-create-parallel_tool_calls) 参数设置为 false,如果你遇到问题。
+- 在某些个别情况下,我们观察到模型在生成非常冗长、重复的输出时会出现抵抗行为,例如逐个分析数百个项目。如果你的用例确实需要这样做,请明确指示模型完整输出这些信息,并考虑拆分问题或改用更简洁的方法。
+- 我们曾遇到一些罕见的并行工具调用结果不正确的案例。建议你进行测试,如果发现问题,可考虑将 [parallel_tool_calls](https://developers.openai.com/api/reference/resources/responses/methods/create#responses-create-parallel_tool_calls) 参数设置为 false。
-### 附录:生成和应用文件差异
+### 附录:生成与应用文件差异(diff)
-开发者向我们反馈,准确且格式良好的 diff 生成是支撑编码相关任务的关键能力。为此,GPT-4.1 系列相比之前的 GPT 模型显著提升了 diff 生成能力。此外,虽然 GPT-4.1 在给定清晰指令和示例的情况下,能够强力生成任何格式的 diff,我们在此开源了一种推荐的 diff 格式,该模型已针对此格式进行了广泛训练。我们希望,尤其是对于刚起步的开发者来说,这将大大减少你自己创建 diff 时的猜测工作。
+开发者反馈,准确且格式规范的 diff 生成能力是支撑编码相关任务的关键能力。为此,GPT-4.1 系列相比之前的 GPT 模型大幅提升了 diff 能力。此外,尽管 GPT-4.1 在给定清晰指令和示例的情况下,对任何格式的 diff 生成都表现出色,我们仍在此开源一种推荐的 diff 格式,模型已针对该格式进行了广泛训练。我们希望这能特别帮助刚刚入门的开发者,省去自行创建 diff 时的大量猜测工作。
-### 应用补丁
+### Apply Patch
-请参阅下面的示例,了解如何正确应用我们推荐的工具调用提示。
+请参阅下方示例,了解一个正确应用我们推荐的工具调用的提示。
```python
APPLY_PATCH_TOOL_DESC = """This is a custom utility that makes it more convenient to add, remove, move, or edit code files. `apply_patch` effectively allows you to execute a diff/patch against a file, but the format of the diff specification is unique to this task, so pay careful attention to these instructions. To use the `apply_patch` command, you should pass a message of the following structure as "input":
@@ -953,7 +953,7 @@ APPLY_PATCH_TOOL = {
### 参考实现:apply_patch.py
-以下是我们在模型训练中使用的 apply_patch 工具的参考实现。你需要将其制作为可执行文件,并在 \`apply_patch\` 从模型执行命令的 shell 中使其可用:
+这是我们用作模型训练一部分的 apply_patch 工具的参考实现。你需要将其设为可执行文件,并可在以下位置使用: \`apply_patch\` 从模型将执行命令的 shell 中:
```python
#!/usr/bin/env python3
@@ -1491,11 +1491,11 @@ if __name__ == "__main__":
```
-### 其他有效的 Diff 格式
+### 其他有效的差异格式
-如果你想尝试使用不同的 diff 格式,我们在测试中发现,Aider 的 polyglot 基准测试中使用的 SEARCH/REPLACE diff 格式,以及一种无需内部转义的伪 XML 格式,两者的成功率都很高。
+如果你想尝试使用不同的 diff 格式,我们在测试中发现 Aider 的 polyglot 基准中所使用的 SEARCH/REPLACE diff 格式,以及一种不带内部转义的伪 XML 格式,两者都拥有较高的成功率。
-这些 diff 格式有两个共同的关键点:(1)它们不使用行号,(2)它们同时提供要替换的确切代码和用于替换的确切代码,并在两者之间有清晰的分隔符。
+这些 diff 格式有两个共同的关键特征:(1) 它们不使用行号;(2) 它们既提供要被替换的精确代码,也提供用来替换的精确代码,并在两者之间使用清晰的分隔符。
````python
SEARCH_REPLACE_DIFF_EXAMPLE = """
diff --git a/docs/zh/api/docs/guides/latest-model/gpt-5.1.md b/docs/zh/api/docs/guides/latest-model/gpt-5.1.md
index bfb7500..1db0872 100644
--- a/docs/zh/api/docs/guides/latest-model/gpt-5.1.md
+++ b/docs/zh/api/docs/guides/latest-model/gpt-5.1.md
@@ -1,54 +1,54 @@
# 使用 GPT-5.1
-> 有关完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后附加以下内容获取 `.md` 来访问。
+> 完整文档索引请参见 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获取该页面的 Markdown 版本。
-## 介绍
+## 简介
-GPT-5.1 旨在平衡智能与速度,以应对各种智能体和编码任务,同时引入了一种新的 `none` 低延迟交互的推理模式。基于 GPT-5 的优势,GPT-5.1 能更好地校准提示难度,在低复杂度输入上消耗更少的 token,并更高效地处理高难度输入。除此之外,GPT-5.1 在个性、语气和输出格式方面更具可操控性。
+GPT-5.1 旨在为各种智能体和编码任务平衡智能与速度,同时引入一种新的 `none` 面向低延迟交互的推理模式。GPT-5.1 在 GPT-5 的优势基础上,对提示难度的校准更为精准:在较低复杂度的输入上消耗的 token 远更少,在处理高难度输入时也更加高效。此外,GPT-5.1 在个性、语气和输出格式方面也更加可控。
-虽然 GPT-5.1 对大多数应用开箱即用,但本指南着重介绍能在实际部署中最大化性能的提示模式。这些技巧源于广泛的内部测试以及与构建生产环境 智能体 的合作伙伴的协作,在这些场景中,微小的提示改动往往能大幅提升可靠性和用户体验。我们希望本指南能作为一个起点:提示调优是迭代性的,最佳效果将来自将这些模式适配到你的具体工具和工作流中。
+虽然 GPT-5.1 开箱即用即可在大多数应用中表现出色,但本指南重点关注可在实际部署中最大化性能的提示模式。这些技巧源自大量的内部测试以及与那些正在构建生产级智能体的合作伙伴的协作——在这些场景中,提示上微小的改动常常会带来可靠性和用户体验上的大幅提升。我们希望本指南能作为一个起点:提示工程是迭代式的,最佳结果来自于将这些模式适配到你自己特定的工具和工作流中。
-## 新功能
+## 新增功能
-- 新增 `none` 低延迟交互的推理模式
-- 在低复杂度和高挑战性输入上,推理 token 的使用得到更好的校准
-- 个性、语气和输出格式更具可操控性
-- 为编码 智能体 应用补丁和 shell 工具指南
+- 新增 `none` 用于低延迟交互的推理模式
+- 在低复杂度和高难度输入下,推理 token 的使用经过更精细校准
+- 更可控的个性、语气和输出格式
+- 为编码智能体应用 patch 与 shell 工具指南
## 迁移快速入门
-对于使用 GPT-4.1、GPT-5.1 的开发者, `none` 推理投入度应能自然适配大多数不需要推理的低延迟用例。
+对于使用 GPT-4.1、GPT-5.1 且 `none` 的开发者,reasoning effort(推理投入度)应当能自然适用于大多数不需要推理的低延迟用例。
-对于使用 GPT-5 的开发者,我们看到遵循以下几条关键指导的客户取得了显著成功:
+对于使用 GPT-5 的开发者,我们发现遵循以下几条关键建议的客户都取得了显著成效:
-1. **坚持性:** GPT-5.1 现在具有更校准的推理 token 消耗,但有时可能过于简洁,并可能以牺牲答案完整性为代价。通过提示强调坚持性和完整性的重要性可能会有所帮助。
-2. **输出格式和冗长程度:** 虽然整体更详细,但 GPT-5.1 偶尔会冗长,因此在指令中明确期望的输出详细程度是值得的。
-3. **编码 智能体:** 如果你正在开发编码 智能体,请将你的 `apply_patch` 工具迁移到我们新的命名实现。
-4. **指令遵循:** 对于其他行为问题,GPT-5.1 在指令遵循方面表现出色,你应该能够通过检查冲突指令并明确表达来显著塑造行为。
+1. **Persistence(持续性):** GPT-5.1 现在拥有经过更好校准的推理 token 消耗,但有时会偏向过度简洁,从而牺牲答案的完整性。在提示中强调持续性和完整性的重要性会有所帮助。
+2. **输出格式与详略程度:** 虽然整体上更为详尽,但 GPT-5.1 偶尔会过于冗长,因此在指令中明确说明期望的输出详细程度是值得的。
+3. **编码 智能体:** 如果你正在开发编码 智能体,请将你的 `apply_patch` tool 迁移到我们全新的具名实现。
+4. **指令遵循:** 对于其他行为问题,GPT-5.1 在指令遵循方面表现出色,你应当可以通过检查是否存在相互冲突的指令并保持清晰来显著塑造其行为。
-我们还发布了 GPT-5.1-Codex。该模型的行为与 GPT-5.1 不同;参见 [Codex 提示指南](https://developers.openai.com/cookbook/examples/gpt-5/codex_prompting_guide) 了解更多信息。关于 API 中后续 Codex 模型的指导,请参阅 [使用 GPT-5.3 Codex](https://developers.openai.com/api/docs/guides/latest-model?model=gpt-5.3-codex).
+我们还发布了 GPT-5.1-Codex。该模型的行为与 GPT-5.1 不同;参见 [Codex 提示指南](https://developers.openai.com/cookbook/examples/gpt-5/codex_prompting_guide) 以了解更多信息。如需了解 API 中后续 Codex 模型的指导,请参见 [使用 GPT-5.3 Codex](https://developers.openai.com/api/docs/guides/latest-model?model=gpt-5.3-codex).
-## 模型、API与功能更新
+## 模型、API 以及功能更新
-- `gpt-5.1` 可在 Responses API 和 Chat Completions API 中使用。
+- `gpt-5.1` 在 Responses API 和 Chat Completions API 中可用。
- `reasoning.effort` 支持 `none` (默认), `low`, `medium`,以及 `high`.
-- 该模型支持函数调用和 OpenAI 托管的工具,包括 网页搜索、文件搜索、图像生成、代码解释器和应用补丁。
-- GPT-5.1-Codex 变体针对智能体编码工作流进行了单独优化。
+- 该模型支持函数调用和 OpenAI 托管工具,包括 网页搜索、文件搜索、图像生成、代码解释器和 apply patch。
+- GPT-5.1-Codex 变体分别为智能体编码工作流进行了单独优化。
## 提示词最佳实践
-### 智能体可控性
+### 智能体的可控性
-GPT-5.1 是一个高度可操控的模型,可让你对 智能体 的行为、个性和沟通频率进行稳健的控制。
+GPT-5.1 是一个可操控性极强的模型,允许你对智能体的行为、个性和沟通频率进行稳健的控制。
#### 塑造你的智能体的个性
-GPT-5.1 的个性与回复风格可根据你的使用场景进行调整。虽然冗长度可通过专用 `verbosity` 参数控制,你还可以通过提示词塑造整体的风格、语气和节奏。
+GPT-5.1 的个性和回答风格可以根据你的使用场景进行调整。除了可以通过专用参数控制冗长程度外, `verbosity` 你还可以通过提示塑造整体风格、语气和节奏。
-我们发现,当你定义清晰的 智能体角色时,个性与风格效果最佳。这对面向客户的 智能体尤为重要,它们需要展现情商以应对各种用户情境和互动动态。在实践中,这意味着根据对话状态调整亲近度和简洁度,并避免“明白了”或“谢谢”等过多的确认用语。
+我们发现,在定义清晰的智能体角色后,个性和风格才能发挥最佳效果。对于面向客户的智能体,这一点尤其重要,因为它们需要展现情绪智能,以应对各种用户情境和互动动态。在实践中,这意味着要根据对话进展调整温度感和简洁度,并避免过度使用“知道了”或“谢谢你”之类的确认语。
-下面的示例提示词展示了我们如何为客服 智能体塑造个性,重点是在解决问题时平衡直率与亲近感的恰当程度。
+下面的示例提示展示了我们如何塑造客户支持智能体的个性,重点是在解决问题时平衡恰当的直接程度和温度感。
```text
@@ -75,7 +75,7 @@ You value clarity, momentum, and respect measured by usefulness rather than plea
```
-在下面的提示词中,我们加入了限制编码 智能体回复的段落,使其在小的改动上保持简短,在更详细的查询上则更详细。我们还指定了最终回复中允许的代码量,以避免大段代码块。
+在下面的提示中,我们加入了相关部分,将编码智能体的回答限制为:小型更改使用简短回答,更详细的查询使用较长回答。我们还指定了最终回答中允许的代码量,以避免出现大段代码。
```text
@@ -97,7 +97,7 @@ You value clarity, momentum, and respect measured by usefulness rather than plea
```
-多余的输出长度可通过调整冗长度参数来缓解,并可通过提示词进一步减少,因为 GPT-5.1 能很好地遵循具体的长度指导:
+可以通过调整冗长程度参数来缓解输出过长的问题,也可以进一步利用提示来缩短输出,因为 GPT-5.1 能够很好地遵循明确的长度要求:
```text
@@ -107,11 +107,11 @@ You value clarity, momentum, and respect measured by usefulness rather than plea
```
-#### 获取用户更新
+#### 引导用户更新
-用户更新(也称为前言)是 GPT-5.1 在部署期间分享前期计划并以助手消息形式提供一致进度更新的一种方式。用户更新可沿四个主要维度进行调整:频率、详细程度、语气和内容。我们训练模型擅长通过计划、重要见解和决策,以及关于正在做什么及其原因的细粒度上下文来让用户了解情况。这些更新有助于用户更有效地监督智能体部署,无论是在编码还是非编码领域。
+用户更新(也称为前置说明)是一种让 GPT-5.1 在执行过程中共享前期计划,并以助手消息形式提供一致进度更新。用户更新可沿四个主要维度进行调整:频率、详细程度、语气和内容。我们训练了模型,让它能够出色地通过计划、重要洞察和决策,以及关于正在做什么/为什么做的细粒度上下文来随时通知用户。这些更新有助于用户更有效地监督智能体执行过程,无论是在编码还是非编码领域。
-如果时机得当,模型将能够分享一个映射到部署当前状态的时点理解。在下面的提示添加中,我们定义了哪些类型的前言是有用的,哪些不是。
+如果时机把握得当,模型将能够分享与执行当前状态对应的实时理解。在下面的提示补充内容中,我们定义了哪些类型的前置说明会有用,哪些不会。
```text
@@ -138,7 +138,7 @@ You'll work for stretches with tool calls — it's critical to keep the user upd
```
-在较长时间运行的模型执行中,提供快速的初始助手消息可以改善感知延迟和用户体验。我们可以通过清晰的提示与 GPT-5.1 实现这种行为。
+在长时间运行的模型执行过程中,提供一条快速的初始助手消息可以改善感知延迟和用户体验。通过清晰的提示,我们可以在 GPT-5.1 上实现这一行为。
```text
@@ -146,13 +146,13 @@ Always explain what you're doing in a commentary message FIRST, BEFORE sampling
```
-### 优化智能与指令遵循
+### 优化智能与指令遵循能力
-GPT-5.1 将高度关注你提供的指令,包括关于工具使用、并行性和解决方案完整性的指导。
+GPT-5.1 会非常密切地关注你提供的指令,包括关于工具使用、并行性和解答完整性的指引。
-#### 鼓励提供完整解决方案
+#### Encouraging complete solutions
-在较长的智能体任务中,我们注意到 GPT-5.1 可能会在未达成完整解决方案的情况下提前结束,但我们发现这种行为可以通过提示词来调整。在以下指令中,我们告诉模型避免提前终止和提出不必要的后续问题。
+在较长的智能体任务中,我们注意到 GPT-5.1 可能过早结束,而无法得出完整解决方案,但我们发现这种行为可以通过提示来控制。在以下指令中,我们要求模型避免过早终止和不必要的追问。
```text
@@ -164,7 +164,7 @@ GPT-5.1 将高度关注你提供的指令,包括关于工具使用、并行性
#### 工具调用格式
-为了使工具调用最有效,我们建议在工具定义中描述功能,并在提示词中说明如何/何时使用工具。在下面的示例中,我们定义了一个创建餐厅预订的工具,并简洁地描述了它被调用时的作用。
+为了让工具调用发挥最佳效果,我们建议在工具定义中描述其功能,并在提示中说明如何以及何时使用这些工具。在下面的示例中,我们定义了一个用于创建餐厅预订的工具,并简要描述了它在被调用时的功能。
```json
{
@@ -187,7 +187,7 @@ GPT-5.1 将高度关注你提供的指令,包括关于工具使用、并行性
}
```
-在提示词中,你可以有一个引用该工具的部分,如下所示:
+在提示中,你可以设置一个像下面这样引用工具的部分:
```text
@@ -219,37 +219,37 @@ Assistant: “Done! Your reservation for Daniel at 6:00pm tonight is confirmed.
```
-GPT-5.1 还能更高效地执行并行工具调用。在扫描代码库或从向量存储中检索时,启用并行工具调用并在工具描述中鼓励模型使用并行是一个很好的起点。在系统提示词中,你可以通过提供一些允许并行的示例来强化并行工具的使用。示例指令可能如下:
+GPT-5.1 还能更高效地执行并行工具调用。在扫描代码库或从向量存储中检索时,启用并行工具调用并在工具描述中鼓励模型使用并行是一个很好的起点。在系统提示中,你可以通过提供一些允许并行的示例来强化对并行工具使用的引导。示例指令可能如下所示:
```text
Parallelize tool calls whenever possible. Batch reads (read_file) and edits (apply_patch) to speed up the process.
```
-#### 使用“none”推理模式以提高效率
+#### 使用 “none” 推理模式以提升效率
-GPT-5.1 引入了一种新的推理模式: `none`。与 GPT-5 之前的 `minimal` 设置不同, `none` 强制模型不使用推理 token,使其在使用上更接近 GPT-4.1、GPT-4o 以及其他先前的非推理模型。重要的是,开发者现在可以使用托管工具,如 [网页搜索](https://developers.openai.com/api/docs/guides/tools-web-search?api-mode=responses) 和 [文件搜索](https://developers.openai.com/api/docs/guides/tools?tool-type=file-search) 结合使用 `none`,自定义函数调用的性能也显著提升。考虑到这一点, [关于提示非推理模型的先前指导](https://developers.openai.com/cookbook/examples/gpt4-1_prompting_guide) (如 GPT-4.1)同样适用于此,包括使用少样本提示和高质量的工具描述。
+GPT-5.1 引入了一种新的推理模式: `none`。与 GPT-5 先前 `minimal` 设置不同, `none` 会强制模型从不使用推理 token,使其使用体验更接近 GPT-4.1、GPT-4o 以及其他非推理模型。重要的是,开发者现在可以在 [网页搜索](https://developers.openai.com/api/docs/guides/tools-web-search?api-mode=responses) 和 [文件搜索](https://developers.openai.com/api/docs/guides/tools?tool-type=file-search) 中使用托管工具, `none`,并且自定义函数调用性能也得到显著提升。考虑到这一点, [先前关于非推理模型的提示指南](https://developers.openai.com/cookbook/examples/gpt4-1_prompting_guide) (例如 GPT-4.1)同样适用于 GPT-5.1,包括使用 few-shot 提示和高质量的工具描述。
-虽然 GPT-5.1 在使用 `none`,时不使用推理 token,但我们发现提示模型仔细考虑计划调用的函数可以提高准确性。
+尽管 GPT-5.1 在 `none`,下不使用推理 token,我们发现提示模型仔细思考它计划调用哪些函数可以提高准确率。
```text
You MUST plan extensively before each function call, and reflect extensively on the outcomes of the previous function calls, ensuring user's query is completely resolved. DO NOT do this entire process by making function calls only, as this can impair your ability to solve the problem and think insightfully. In addition, ensure function calls have the correct arguments.
```
-我们还观察到,在较长的模型执行过程中,鼓励模型“验证”其输出可以更好地遵循指令进行工具使用。以下是我们澄清工具用法时在指令中使用的示例。
+我们还观察到,在较长的模型执行过程中,鼓励模型“验证”其输出能够带来更好的工具使用指令遵循效果。下面是我们在说明工具用法时在指令中使用的一个示例。
```text
When selecting a replacement variant, verify it meets all user constraints (cheapest, brand, spec, etc.). Quote the item-id and price back for confirmation before executing.
```
-在我们的测试中,GPT-5 之前的 `minimal` 推理模式有时会导致执行提前终止。虽然其他推理模式可能更适合这些任务,但我们对 GPT-5.1 在使用 `none` 时的指导类似。以下是来自 Tau 基准测试提示的示例片段。
+在我们的测试中,GPT-5 先前 `minimal` 推理模式有时会导致执行过早终止。虽然其他推理模式可能更适合这些任务,但我们对使用 `none` 的 GPT-5.1 的建议也与此类似。下面是我们 Tau bench 提示中的一个片段。
```text
Remember, you are an agent - please keep going until the user’s query is completely resolved, before ending your turn and yielding back to the user. You must be prepared to answer multiple queries and only finish the call once the user has confirmed they're done.
```
-### 从规划到执行,最大化编码性能
+### 从规划到执行,最大化提升编码性能
-对于长时间运行的任务,我们推荐实现一种规划工具。你可能已经注意到推理模型会在其推理摘要中进行规划。虽然这在当时很有帮助,但要跟踪模型相对于查询执行的位置可能会很困难。
+对于长时间运行的任务,我们建议实现的一个工具是规划工具。你可能注意到推理模型会在其推理摘要中进行规划。虽然这在当时很有帮助,但可能难以追踪模型相对于查询执行进度的位置。
```text
@@ -266,7 +266,7 @@ Remember, you are an agent - please keep going until the user’s query is compl
```
-规划工具可以用最少的脚手架来实现。在我们的规划工具实现中,我们传递一个合并参数以及一个待办事项列表。列表包含简要描述、任务当前状态以及分配给的 ID。以下是一个 GPT-5.1 可能用来记录其状态的函数调用示例。
+规划工具只需极少的脚手架即可使用。在我们对规划工具的实现中,我们传入一个 merge 参数以及一个待办事项列表。该列表包含简要描述、任务的当前状态以及分配给它的 ID。下面是一个示例函数调用,展示了 GPT-5.1 可能用于记录其状态的方式。
```json
{
@@ -289,9 +289,9 @@ Remember, you are an agent - please keep going until the user’s query is compl
}
```
-#### 设计系统强制
+#### 设计系统约束
-在构建前端界面时,GPT-5.1 可以被引导以生成符合你视觉设计系统的网站。我们建议使用 Tailwind 来渲染 CSS,你可以进一步定制以符合你的设计指南。在下面的示例中,我们定义了一个设计系统来约束 GPT-5.1 生成的颜色。
+在构建前端界面时,可以引导 GPT-5.1 生成与你的视觉设计系统匹配的网站。我们建议使用 Tailwind 来渲染 CSS,这样你可以进一步定制以满足你的设计规范。在下面的示例中,我们定义了一个设计系统来约束 GPT-5.1 生成的颜色。
```text
@@ -306,13 +306,13 @@ Remember, you are an agent - please keep going until the user’s query is compl
### GPT-5.1 中的新工具类型
-GPT-5.1 已在编码场景中常用的特定工具上进行了后训练。现在,你可以使用预定义的 apply_patch 工具与你的环境中的文件进行交互。类似地,我们添加了一个 shell 工具,让模型可以为你的系统提出要运行的命令。
+GPT-5.1 已针对编码场景中常用的特定工具进行了后训练。若要与环境中的文件交互,你现在可以使用预定义的 apply_patch 工具。类似地,我们新增了一个 shell 工具,让模型可以针对你的系统提出要运行的命令。
-#### 使用 apply_patch
+#### Using apply_patch
-apply_patch 工具可让 GPT-5.1 使用结构化差异在你的代码库中创建、更新和删除文件。模型不只是建议编辑,而是发出补丁操作,你的应用程序应用这些操作并随后回报结果,从而支持迭代式多步骤代码编辑工作流。你可以在以下位置找到更多使用细节和上下文: [GPT-4.1 提示指南](https://developers.openai.com/cookbook/examples/gpt4-1_prompting_guide#:~:text=PYTHON_TOOL_DESCRIPTION%20%3D%20%22%22%22This,an%20exclamation%20mark.).
+apply_patch 工具让 GPT-5.1 能够使用结构化 diff 在你的代码库中创建、更新和删除文件。模型不只是建议编辑,而是发出 patch 操作,由你的应用执行后再回报结果,从而支持迭代式、多步骤的代码编辑工作流。你可以在 [GPT-4.1 提示词指南](https://developers.openai.com/cookbook/examples/gpt4-1_prompting_guide#:~:text=PYTHON_TOOL_DESCRIPTION%20%3D%20%22%22%22This,an%20exclamation%20mark.).
-使用 GPT-5.1,你可以将 apply_patch 用作新的工具类型,而无需为工具编写自定义描述。描述和处理由 Responses API 管理。在底层,此实现使用自由形式的函数调用,而非 JSON 格式。在测试中,命名函数将 apply_patch 失败率降低了 35%。
+对于 GPT-5.1,你可以直接将 apply_patch 作为新的工具类型使用,无需为该工具编写自定义描述。描述与处理逻辑由 Responses API 统一管理。在实现上,该方案使用自由格式函数调用,而非 JSON 格式。经测试,使用具名函数后 apply_patch 的失败率下降了 35%。
```python
response = client.responses.create(
@@ -341,7 +341,7 @@ client.responses().create(params).output().stream()
```
-当模型决定执行 apply_patch 工具时,你将在响应流中收到 apply_patch_call 函数类型。在操作对象内,你将收到一个 type 字段(其值为 `create_file`, `update_file`、 `delete_file`)之一)以及要实施的差异。
+当模型决定执行 apply_patch 工具时,你将在响应流中收到一个 apply_patch_call 函数类型。在 operation 对象中,你会获得一个 type 字段(取值为 `create_file`, `update_file`)之一,以及要应用的 diff `delete_file`。
```text
{
@@ -365,7 +365,7 @@ client.responses().create(params).output().stream()
```
-[此仓库](https://github.com/openai/openai-cookbook/blob/main/examples/gpt-5/apply_patch.py) 包含 apply_patch 工具可执行文件的预期实现。当你的系统完成补丁工具的执行后,Responses API 期望以下形式的工具输出:
+[此代码仓库](https://github.com/openai/openai-cookbook/blob/main/examples/gpt-5/apply_patch.py) 中包含 apply_patch 工具可执行文件的预期实现。当你的系统完成 patch 工具的执行后,Responses API 期望收到如下形式的工具输出:
```python
{
@@ -377,18 +377,18 @@ client.responses().create(params).output().stream()
```
-#### 使用 shell 工具
+#### Using the shell tool
-我们还为 GPT-5.1 构建了一个新的 shell 工具。该 shell 工具允许模型通过受控的命令行界面与你的本地计算机交互。模型提出 shell 命令;你的集成执行这些命令并返回输出。这创建了一个简单的计划-执行循环,让模型能够检查系统、运行实用程序并收集数据,直到完成任务。
+我们还为 GPT-5.1 构建了一个新的 shell 工具。shell 工具允许模型通过受控的命令行界面与你本地的计算机进行交互。模型提出 shell 命令,你的集成负责执行它们并返回输出。这形成了一个简单的计划-执行循环,让模型能够检查系统、运行工具并收集数据,直到完成任务。
-shell 工具的调用方式与 apply_patch 相同:将其作为类型为 `shell`.
+shell 工具的调用方式与 apply_patch 相同:将其作为类型为的工具包含进去 `shell`.
```python
tools = [{"type": "shell"}]
```
-当返回 shell 工具调用时,Responses API 包含一个 `shell_call` 对象,其中包含超时时间、最大输出长度以及要运行的命令。
+当 shell 工具调用被返回时,Responses API 会包含一个 `shell_call` 对象,其中包含超时时间、最大输出长度以及要运行的命令。
```text
{
@@ -403,7 +403,7 @@ tools = [{"type": "shell"}]
}
```
-执行 shell 命令后,返回未截断的 stdout/stderr 日志以及退出代码详细信息。
+执行完 shell 命令后,返回未经截断的 stdout/stderr 日志以及退出码详情。
```json
{
@@ -423,9 +423,9 @@ tools = [{"type": "shell"}]
}
```
-### 如何有效进行元提示词
+### 如何有效地编写元提示
-构建提示词可能很繁琐,但这也是解决大多数模型行为问题时能做的最具杠杆效应的事情。小小的包含内容可能会意外地让模型产生不良行为。让我们通过一个规划活动的智能体示例来探讨。在下面的提示词中,面向客户的智能体被要求使用工具来回答用户关于潜在场地和后勤的问题。
+构建提示词可能很繁琐,但它也是你能够用来解决大多数模型行为问题的最高杠杆手段。一个微小的包含项就可能意外地让模型偏离预期方向。下面我们来看一个负责策划活动的智能体示例。在下面的提示词中,面向客户的智能体负责使用工具来回答用户关于候选场地和后勤安排的疑问。
```text
You are “GreenGather,” an autonomous sustainable event-planning agent. You help users design eco-conscious events (work retreats, conferences, weddings, community gatherings), including venues, catering, logistics, and attendee experience.
@@ -495,19 +495,19 @@ Avoid over-apologizing or repeating yourself. Users should feel like decisions a
End every response with a subtle next step the user could take, phrased as a suggestion rather than a question, and avoid explicit calls for confirmation such as “Let me know if this works.”
```
-尽管这是一个强有力的起始提示词,但我们在测试中注意到了一些问题:
+虽然这是一个不错的起始提示词,但在测试时我们还是发现了一些问题:
-- 小的概念性问题(如询问20人领导力晚宴)触发了不必要的工具调用和非常具体的场地建议,尽管提示词允许对简单、高层级的问题使用内部知识。
+- 小的概念性问题(比如询问 20 人的领导层晚宴)触发了不必要的工具调用,并给出了非常具体的场地建议,尽管提示允许在简单、高层次的问题上使用内部知识。
-- 智能体在过于冗长(多日奥斯汀异地会议演变为密集多节的文章)和过于犹豫(拒绝在未提出更多问题的情况下给出方案)之间摇摆不定,并且偶尔忽略单元规则(柏林峰会用英里和°F描述,而非公里和°C)。
+- 该 智能体 在过度冗长(多天的奥斯汀外出团建变成了密集、多章节的文章)和过度犹豫(拒绝在进一步提问前提出方案)之间摇摆,并且偶尔会忽略单位规则(例如将柏林峰会用英里和 °F 来描述,而不是 km 和 °C)。
-与其手动猜测系统提示中的哪些行导致了这些行为,我们可以对 GPT-5.1 进行元提示,让它检查自身的指令和追踪。
+与其手动猜测系统提示中的哪些行导致了这些行为,不如对 GPT-5.1 进行元提示,让它检查自身的指令和追踪。
-**步骤 1**:请 GPT-5.1 诊断故障
+**Step 1**:让 GPT-5.1 诊断失败
-将系统提示和一小批失败示例粘贴到单独的调用中进行分析。基于你已看到的评估,先简要概述你预期要处理的失败模式,但将事实调查工作留给模型。
+将系统提示和一小批失败示例粘贴到一个单独的分析调用中。根据你看到的评估,提供一个简短的概述,说明你预计要解决的失败模式,但将事实调查留给模型。
-请注意,在此提示中,我们还没有要求给出解决方案,只要求进行根本原因分析。
+请注意,在这个提示中,我们还没有要求给出解决方案,只是进行根本原因分析。
```text
You are a prompt engineer tasked with debugging a system prompt for an event-planning agent that uses tools to recommend venues, logistics, and sustainable options.
@@ -545,11 +545,11 @@ failure_modes:
- why_it_matters: ...
```
-当反馈在逻辑上可以归为一组时,元提示的效果最佳。如果你提供太多失败模式,模型可能难以将所有线索串联起来。在此示例中,失败日志的转储可能包含一些错误示例,例如模型在回答用户问题时过于冗长或过于简短。对于模型过于急切调用工具的问题,则会单独发出查询。
+元提示在反馈可以合理地归为一组时效果最佳。如果你提供许多失败模式,模型可能会难以把所有线索串联起来。在这个示例中,失败日志转储可能包含以下错误示例:模型在回复用户问题时过于冗长或不够详细。针对模型过度急切地调用工具,会发出一个单独的查询。
-**步骤 2:** 请 GPT-5.1 给出如何修补提示以修复这些行为
+**Step 2:** 询问 GPT-5.1 将如何修补提示以修复这些行为
-一旦你获得该分析,你可以进行第二次独立的调用,专注于实现:在不完全重写提示的前提下进行收紧。
+获得该分析后,你可以运行第二个单独的调用,专注于实现:在不完全重写的情况下收紧提示。
```text
You previously analyzed this system prompt and its failure modes.
@@ -578,9 +578,9 @@ Output:
2) revised_system_prompt: the full updated system prompt with your edits applied, ready to drop into an agent configuration.
```
-在此示例中,第一个元提示帮助 GPT-5.1 直接指向相互矛盾的部分(例如重叠的工具规则,以及自主性与澄清指导之间的冲突),第二个元提示将该分析转化为事件策划智能体指令的简洁、清理后的版本。
+在这个示例中,第一个元提示帮助 GPT-5.1 直接定位相互矛盾的部分(例如重叠的工具规则以及自主性与澄清指导之间的冲突),第二个元提示则将该分析转化为事件规划 智能体指令的具体、清理后的版本。
-第二个提示的输出可能看起来像这样:
+第二个提示的输出可能如下所示:
```text
patch_notes:
@@ -595,13 +595,13 @@ revised_system_prompt:
[...]
```
-在此迭代周期之后,再次运行查询以观察任何回归,并重复此过程,直到你的失败模式被识别和处理完毕。
+完成这一迭代周期后,再次运行查询以观察是否有回归,并重复此过程,直到你的失败模式已被识别和分类。
-随着你继续扩展你的智能体系统(例如,扩大范围或增加工具调用的数量),考虑对你想要做的增补进行元提示,而不是手工添加。这有助于为每个工具及其使用时机保持清晰的边界。
+随着你持续扩展智能体系统(例如扩大范围或增加工具调用次数),考虑对你想要添加的内容进行元提示,而不是手动添加。这有助于保持每个工具的独立边界以及它们的使用时机。
-### 后续内容
+### 下一步
-总之,GPT-5.1 建立在 GPT-5 奠定的基础上,并增添了诸如对简单问题更快思考、模型输出可操控性、用于编程场景的新工具,以及将推理设置为 `none` (当你的任务无需深度思考时)的选项。
+总结一下,GPT-5.1 在 GPT-5 奠定的基础上构建,并新增了诸多能力,例如针对简单问题的更快思考、对模型输出的可引导性、面向编码场景的新工具,以及将推理设置为 `none` 当你的任务不需要重度思考时。
-查看 [GPT-5.1 模型和 API 指南](#model-api-and-feature-updates),或阅读 [博客文章](https://openai.com/index/gpt-5-1-for-developers/) 以了解更多信息。
+请参阅 [GPT-5.1 模型与 API 指南](#model-api-and-feature-updates),或阅读 [博客文章](https://openai.com/index/gpt-5-1-for-developers/) 以了解更多。
diff --git a/docs/zh/api/docs/guides/latest-model/gpt-5.3-codex.md b/docs/zh/api/docs/guides/latest-model/gpt-5.3-codex.md
index 386edd6..10c7110 100644
--- a/docs/zh/api/docs/guides/latest-model/gpt-5.3-codex.md
+++ b/docs/zh/api/docs/guides/latest-model/gpt-5.3-codex.md
@@ -1,25 +1,25 @@
# 使用 GPT-5.3-Codex
-> 有关完整的文档索引,请参阅 [llms.txt](/llms.txt)。通过在页面 URL 后添加 `.md` 可以获取文档页面的 Markdown 版本。
+> 完整文档索引请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获得文档页面的 Markdown 版本。
-## 引言
+## 简介
-GPT-5.3-Codex 推进了智能体编码的智能与效率前沿。请密切遵循本指南,以确保你从该模型获得最佳性能。本指南适用于通过 API 直接使用该模型以获得最大自定义能力的任何人;我们还有 [Codex SDK](https://developers.openai.com/codex/codex-sdk/) 用于更简单的集成。
+GPT-5.3-Codex 在智能体编码方面推进了智能与效率的前沿。请仔细遵循本指南,以确保你从该模型中获得最佳性能。本指南面向通过 API 直接使用该模型以获得最大可定制性的用户;我们还提供了 [Codex SDK](https://developers.openai.com/codex/codex-sdk/) 以便更简单地集成。
-在 API 中,经过 Codex 调优的模型是 `gpt-5.3-codex` (参见 [模型页面](https://developers.openai.com/api/docs/models/gpt-5.3-codex)).
+在 API 中,Codex 调优模型为 `gpt-5.3-codex` (参见 [模型页面](https://developers.openai.com/api/docs/models/gpt-5.3-codex)).
-## 新增内容
+## 新增功能
-- 更快且更节省 token:使用更少的思考 token 即可完成任务。我们建议将“medium”推理力度作为全面交互式编码模型的良好选择,以平衡智能与速度。
-- 更高的智能与长时间自主运行:Codex 可以自主运行数小时以完成你最困难的任务。你可以使用 `high` 或 `xhigh` 推理力度来处理最困难的任务。
-- 一流的压缩支持:压缩支持多小时的推理而不触及上下文限制,并支持更长的连续用户对话,无需启动新的聊天会话。
-- Codex 在 PowerShell 和 Windows 环境中也表现更佳。
+- 更快、更省 token:在完成任务时使用更少的思考 token。我们推荐“medium”推理力度,它是一个综合表现优秀的交互式编码模型,能在智能程度和速度之间取得良好平衡。
+- 更高的智能水平和长时自主能力:Codex 可以自主运行数小时来完成你最难的任务。你可以使用 `high` 或 `xhigh` 推理力度来处理你最难的任务。
+- 一流上下文压缩支持:压缩使长达数小时的推理不会触及上下文限制,并支持更长时间的持续用户对话,无需开启新的聊天会话。
+- Codex 在 PowerShell 和 Windows 环境下也有显著改进。
## 迁移快速入门
-如果你已经有一个可以正常工作的 Codex 实现,这个模型应该只需要相对较小的更新就能良好运行;但如果你是从一个针对 GPT-5 系列模型或第三方模型优化的提示词和工具集开始,我们建议进行更大幅度的改动。最佳的参考实现是我们完全开源的 codex-cli 智能体,可在 [GitHub](https://github.com/openai/codex)。上获取。克隆此仓库,并使用 Codex(或任何编码智能体)来询问实现方式相关的问题。通过与客户合作,我们还了解到了如何针对这一特定实现之外定制 智能体 工具框架。
+如果你已经有可运行的 Codex 实现,该模型应该可以以相对较小的改动正常工作;但如果你当前使用的是针对 GPT-5 系列模型优化的提示词和工具集,或来自第三方模型,我们建议进行更显著的改动。最佳参考实现是我们完全开源的 codex-cli 智能体,可在 [GitHub](https://github.com/openai/codex). 克隆此仓库并使用 Codex(或任何编程 智能体)来询问相关实现方式。通过与客户的合作,我们也了解了如何针对此具体实现之外的 智能体 框架进行定制。
-将你的工具框架迁移到 codex-cli 的关键步骤:
+将你的框架迁移到 codex-cli 的关键步骤:
-
@@ -44,19 +44,19 @@ GPT-5.3-Codex 推进了智能体编码的智能与效率前沿。请密切遵循
-## 模型、API及功能更新
+## 模型、API 与功能更新
-- `gpt-5.3-codex` 专为 Codex 或类似环境中的智能体编码任务而优化。
-- 可在Responses API中使用。
+- `gpt-5.3-codex` 针对 Codex 或类似环境中的智能体编码任务进行了优化。
+- 可通过 Responses API 使用。
- `reasoning.effort` 支持 `low`, `medium`, `high`,以及 `xhigh`.
- 支持的工具包括函数调用、网页搜索、托管 shell 和技能。
-## 提示词最佳实践
+## 提示最佳实践
-### 推荐的起始提示词
+### 推荐入门提示
-此提示词最初以默认 [GPT-5.1-Codex-Max 提示词](https://github.com/openai/codex/blob/main/codex-rs/core/gpt-5.1-codex-max_prompt.md) 为基础,并针对内部评估进一步优化,以提升答案的准确性、完整性、质量、正确的工具使用与并行性,以及行动偏好。如果你正在使用此模型运行评估,我们建议调高自主性或提示进入“非交互”模式,尽管在实际使用中可能需要更多的澄清。
+该提示词最初为默认 [GPT-5.1-Codex-Max 提示词](https://github.com/openai/codex/blob/main/codex-rs/core/gpt-5.1-codex-max_prompt.md) 并针对内部评估做了进一步优化,包括答案正确性、完整性、质量、正确的工具使用与并行执行,以及行动倾向。如果你正在使用该模型运行评估,建议提高自主性或提示进入“非交互”模式,不过在实际使用中,更多澄清可能更合适。
```text
You are Codex, based on GPT-5. You are running as a coding agent in the Codex CLI on a user's computer.
@@ -193,17 +193,17 @@ You are producing plain text that will later be styled by the CLI. Follow these
* Examples: src/app.ts, src/app.ts:42, b/server/index.js#L10, C:\repo\project\main.rs:12:5
```
-### 中途推出的用户更新
+### Mid-Rollout User Updates
-Codex 模型系列可以在工作期间呈现滚动中的用户更新。对于 gpt-5.3-codex 之前的 codex 版本,这些更新是系统生成的,不可通过提示词控制,因此我们建议不要为这些版本在提示词中添加关于中间计划或用户消息的指令。对于 gpt-5.3-codex 及之后版本,这些更新更具沟通性,提供更多关于正在发生什么以及原因的关键信息,其工作方式类似于其他 GPT-5 系列模型的中间消息,并且可以根据下方“前言与个性”部分进行提示。
+Codex 模型系列在工作中可以展示中段用户更新。对于 gpt-5.3-codex 之前的 codex 版本,这些更新由系统生成,无法通过提示触发,因此我们建议不要在这些版本的提示中加入关于中间计划或向用户发送消息的指令。对于 gpt-5.3-codex 及之后版本,这些更新更具沟通性,会提供关于正在发生什么以及为何发生的更关键信息,其工作方式类似于其他 GPT-5 系列模型的中间消息,可以根据下方的 Preambles & Personality 一节通过提示进行定制。
-### 使用智能体.md
+### 使用 智能体.md
-Codex-cli 会自动枚举这些文件并将它们注入对话中;模型经过训练会严格遵循这些指令。
+Codex-cli 会自动枚举这些文件并将它们注入对话中;模型已经过训练,会严格遵循这些指令。
-1\. 文件从 \~/.codex 以及从仓库根目录到当前工作目录(CWD)的每个目录中拉取(带有可选的回退名称和大小上限)。
-2\. 它们按顺序合并,后面的目录会覆盖前面的目录。
-3\. 每个合并后的块以用户角色消息的形式呈现在模型面前,如下所示:
+1\. 文件来源: \~/.codex 以及从仓库根目录到 CWD 的每个目录(带有可选的回退名称和大小上限)。
+2\. 它们按顺序合并,后面的目录覆盖前面的目录。
+3\. 每个合并后的块都作为一条独立的 user-role 消息呈现给模型,如下所示:
```text
# AGENTS.md instructions for
@@ -214,34 +214,34 @@ Codex-cli 会自动枚举这些文件并将它们注入对话中;模型经过
```
-其他详细信息
+更多细节
-- 每个发现的文件都会成为一条独立的用户角色消息,以 \# 开头的 AGENTS.md 指令,适用于 \<目录\>,其中 \<目录\> 是提供该文件的文件夹路径(相对于仓库根目录)。
-- 消息会注入到对话历史的顶部附近,位于用户提示之前,按根到叶的顺序排列:先全局指令,再仓库根目录,然后是每个更深层次的目录。如果使用了 AGENTS.override.md,其目录名称仍会出现在标题中(例如, \# backend/api 的 AGENTS.md 指令),这样转录中的上下文就一目了然。
+- 每个发现的文件都会成为一条独立的 user 角色消息,开头为 \# AGENTS.md instructions for \, where \ 是该文件夹的路径(相对于仓库根目录),即提供该文件的文件夹路径。
+- 消息会注入到对话历史的靠前位置,位于用户提示之前,按从根到叶的顺序排列:先是全局指令,然后是仓库根目录,再依次是更深的目录。如果使用了 AGENTS.override.md,其目录名仍会出现在标头中(例如。, \# AGENTS.md instructions for backend/api),以便在转录内容中清晰呈现上下文。
-### 压缩
+### Compaction
-压缩解锁了显著更长的有效上下文窗口,使会话可以跨越许多轮次而不会触及上下文窗口限制或长上下文性能下降,且智能体可以执行超出典型上下文窗口的非常长的轨迹,用于长期、复杂的任务。这种功能的较弱版本之前可通过临时脚手架和对话摘要实现,但我们的原生实现通过Responses API提供,与模型集成且性能极高。
+压缩显著释放了更长的有效上下文窗口,用户对话可以在多轮交互中持续进行,而不会触及上下文窗口限制或出现长上下文性能下降的问题,智能体 可以执行远超典型上下文窗口的超长轨迹,以完成长时间运行的复杂任务。此前通过临时脚手架和对话摘要也能实现较弱的类似效果,但我们的原生实现可通过 Responses API 使用,并与模型深度集成,性能表现优异。
工作原理:
-1. 你照常使用 Responses API,发送包含工具调用、用户输入和助手消息的输入项。
-2. 当你的上下文窗口变得很大时,可以调用 /compact 生成一个新的、紧凑的上下文窗口。有两点需要注意:
- 1. 你发送给 /compact 的上下文窗口应适合你的模型的上下文窗口。
- 2. 该端点与 ZDR 兼容,将返回一个“encrypted_content”项,你可以将其传入未来的请求中。
-3. 对于后续对 /responses 端点的调用,你可以传入更新后的、紧凑的对话项列表(包括新增的压缩项)。模型会用更少的对话令牌保留关键的先前的状态。
+1. 你可以像现在一样使用 Responses API,发送包含工具调用、用户输入和助手消息的输入项。
+2. 当上下文窗口变大时,你可以调用 /compact 生成一个新的、压缩后的上下文窗口。有两点需要注意:
+ 1. 你发送到 /compact 的上下文窗口应能容纳在你的模型上下文窗口内。
+ 2. 该端点兼容 ZDR,并会返回一个“encrypted_content”项,你可以将其传入后续请求。
+3. 对于之后对 /responses 端点的调用,你可以传入更新、压缩后的对话项列表(包括新增的压缩项)。模型会以更少的对话词元保留关键的历史状态。
-有关端点详情,请参阅我们的 `/responses/compact` [文档](https://developers.openai.com/api/reference/resources/responses/methods/compact).
+有关端点详情请参阅我们的 `/responses/compact` [文档](https://developers.openai.com/api/reference/resources/responses/methods/compact).
### 工具
-1. 我们强烈建议使用我们的确切 `apply_patch` 实现,因为该模型已经针对这种 diff 格式进行了训练并表现出色。对于终端命令,我们推荐使用我们的 `shell` 工具,对于计划/TODO 项目,我们的 `update_plan` 工具应该表现最佳。
-2. 如果你希望你的 智能体 使用更多“类似终端的工具”(比如 `file_read()` 而不是调用 \`sed\` 在终端中),这个模型可以可靠地调用它们,而不是终端(按照下面的说明)
-3. 对于其他工具,包括语义搜索、MCP 或其他自定义工具,它们也可以工作,但需要更多的调整和实验。
+1. 我们强烈建议使用我们的官方实现 `apply_patch` 实现,因为模型经过训练可在此 diff 格式上表现出色。对于终端命令,我们推荐我们的 `shell` 工具;对于计划/TODO 项,我们的 `update_plan` 工具表现最佳。
+2. 如果你希望你的智能体使用更多“类似终端的工具”(例如 `file_read()` 而非调用 \`sed\` 在终端中执行),该模型可以可靠地调用它们来代替终端操作(遵循以下说明)
+3. 对于其他工具,包括语义搜索、MCP 或其他自定义工具,它们可以使用,但需要更多的调优和实验。
#### Apply_patch
-实现 apply_patch 最简单的方式是使用我们在 Responses API 中的一级实现,但你也可以使用我们的自由形式工具实现,配合 [上下文无关文法](https://developers.openai.com/cookbook/examples/gpt-5/gpt-5_new_params_and_tools?utm_source=chatgpt.com#3-contextfree-grammar-cfg)。下面将展示这两种方式。
+实现 apply_patch 最简单的方式是使用 Responses API 中我们的一等实现,但你也可以使用我们的自由格式工具实现配合 [上下文无关文法](https://developers.openai.com/cookbook/examples/gpt-5/gpt-5_new_params_and_tools?utm_source=chatgpt.com#3-contextfree-grammar-cfg)。两者均在下方演示。
```python
# Sample script to demonstrate the server-defined apply_patch tool
@@ -393,11 +393,11 @@ for item in response_cfg.output:
```
-通过遵循这个 Responses API 工具补丁对象可以按照以下方式实现 [示例](https://github.com/openai/openai-agents-python/blob/main/examples/tools/apply_patch.py) ,而来自自由形式工具的补丁可以使用我们规范的 GPT-5 中的逻辑应用 [apply_patch.py](https://github.com/openai/openai-cookbook/blob/main/examples/gpt-5/apply_patch.py%20) 实现。
+响应接口 工具的 Patches 对象可以通过参考此 Responses API 工具的 [示例](https://github.com/openai/openai-agents-python/blob/main/examples/tools/apply_patch.py) 来实现,而来自自由格式工具的补丁则可应用我们标准 GPT-5 [apply_patch.py](https://github.com/openai/openai-cookbook/blob/main/examples/gpt-5/apply_patch.py%20) 实现中的逻辑。
#### Shell_command
-这是我们的默认 shell 工具。请注意,我们观察到使用命令类型“string”而不是命令列表时性能更佳。
+这是默认的 shell 工具。注意,我们观察到使用 “string” 类型的命令比使用命令列表性能更好。
```json
{
@@ -437,17 +437,17 @@ for item in response_cfg.output:
}
```
-如果你使用的是 Windows PowerShell,请更新为此工具描述。
+如果你使用的是 Windows PowerShell,请将工具描述更新为这条。
```text
Runs a shell command and returns its output. The arguments you pass will be invoked via PowerShell (e.g., ["pwsh", "-NoLogo", "-NoProfile", "-Command", ""]). Always fill in workdir; avoid using cd in the command string.
```
-你可以查看 codex-cli 获取实现方式, `exec_command`,它在你需要流式输出、REPL 或交互式会话时启动长期存在的 PTY;以及 `write_stdin`,用于向现有的 exec_command 会话提供额外的按键输入(或仅轮询输出)。
+你可以查看 codex-cli 以了解 `exec_command`,的实现,它在需要流式输出、REPL 或交互式会话时启动一个长期存活的 PTY;以及 `write_stdin`,的实现,用于为现有的 exec_command 会话输入额外的按键(或只是轮询输出)。
#### 更新计划
-这是我们的默认 TODO 工具;欢迎根据你的偏好自定义。参见 `## Plan tool` 我们起始提示词中的部分,了解保持整洁和调整行为的额外说明。
+这是我们默认的 TODO 工具;你可以根据需要进行自定义。请参阅 `## Plan tool` 部分以获取保持整洁和调整行为的额外说明。
```json
{
@@ -488,9 +488,9 @@ Runs a shell command and returns its output. The arguments you pass will be invo
}
```
-#### 查看图像
+#### 查看图片
-这是 codex-cli 中用于让模型查看图片的基础函数。
+这是 codex-cli 中使用的一个基础函数,用于让模型查看图片。
```json
{
@@ -514,9 +514,9 @@ Runs a shell command and returns its output. The arguments you pass will be invo
}
```
-### 专用终端换行工具
+### 专用终端包装工具
-如果你更希望你的 codex 智能体使用终端包装工具(比如一个专用的 `list_dir(‘.’)` 工具而不是 `terminal(‘ls .’)`,这通常效果不错。我们发现,当工具的名称、参数和输出尽可能与底层命令的对应项接近时,效果最佳,因为这样对模型来说尽可能在分布内(模型主要使用专用终端工具训练)。例如,如果你注意到模型通过终端使用 git,而你更希望它使用专用工具,我们发现创建一个相关工具,并在提示中添加一条指令,要求仅使用该工具处理 git 命令,就完全消除了模型对 git 命令的终端使用。
+如果你更希望你的 codex 智能体使用终端包装类工具(例如专用的 `list_dir(‘.’)` 工具而非 `terminal(‘ls .’)`),这通常效果不错。我们发现,当工具的名称、参数和输出与底层命令尽可能接近时,能得到最好的效果,这样对模型而言就尽可能符合其训练时的数据分布(该模型主要使用专用终端工具训练)。例如,如果你发现模型通过终端使用 git 并希望改用专用工具,我们发现创建一个相关工具,并在提示中加入仅在执行 git 命令时使用该工具的指令,就能完全消除模型通过终端执行 git 命令的情况。
```python
GIT_TOOL = {
@@ -560,15 +560,15 @@ PROMPT_TOOL_USE_DIRECTIVE = (
### 其他自定义工具(网页搜索、语义搜索、记忆等)
-该模型未必经过针对这些工具的后期训练,但我们也在此类使用中看到了成功案例。为充分利用这些工具,我们建议:
+该模型未必经过后训练以擅长使用这些工具,但我们也观察到它在这方面能够取得成功。为了充分利用这些工具,我们建议:
-1. 让工具名称和参数在语义上尽可能“正确”,例如“search”含义模糊,但“semantic_search”明确指示了工具的功能,相对于你可能拥有的其他与搜索相关的潜在工具。“Query”对于这个工具来说是一个好的参数名。
-2. 在你的提示中明确指出何时、为何以及如何使用这些工具,包括好的和坏的示例。
-3. 让结果看起来与模型习惯从其他工具看到的输出不同也可能有帮助,例如ripgrep结果应该看起来与语义搜索结果不同,以避免模型陷入旧习惯。
+1. 尽可能让工具名称和参数在语义上“正确”,例如“search”含义模糊,而“semantic_search”则能清晰地表明该工具的功能,相对于你可能拥有的其他潜在搜索相关工具而言。“Query”将是此工具的一个良好参数名称。
+2. 在你的提示中明确说明何时、为何以及如何使用这些工具,并提供正面和反面的示例。
+3. 让结果看起来与模型习惯看到的其他工具输出不同也可能有所帮助,例如 ripgrep 的结果应该看起来与语义搜索结果不同,以避免模型陷入旧习惯。
-### 并行工具调用
+### Parallel Tool Calling
-在 codex-cli 中,当启用并行工具调用时,API 请求会设置 `parallel_tool_calls: true` 并在系统指令中添加以下片段:
+在 codex-cli 中,当启用了并行工具调用时,responses API 请求会设置 `parallel_tool_calls: true` 以下代码片段会被添加到系统指令中:
```text
## Exploration and reading files
@@ -585,7 +585,7 @@ PROMPT_TOOL_USE_DIRECTIVE = (
- Do not try to parallelize using scripting or anything else than `multi_tool_use.parallel`.
```
-我们发现,若能按以下顺序排列并行工具调用项和响应,会更有帮助且更符合分布要求:
+我们发现,如果按照以下方式对并行工具调用项及其响应进行排序,会更加清晰,也更符合常规的分布:
```text
function_call
@@ -596,24 +596,24 @@ function_call_output
### 工具响应截断
-我们建议按如下方式截断工具调用响应,以便尽可能让模型处于分布内:
+我们建议按如下方式对工具调用响应进行截断,以尽可能贴合模型的输入分布:
-- 限制为 1 万个 token。你可以通过计算以下内容来廉价地近似实现这一点 `num_bytes/4`.
-- 如果达到截断限制,你应该将预算的一半用于开头,一半用于结尾,并在中间截断,使用 `…3 tokens truncated…`
+- 限制为 10k token。你可以通过计算来粗略近似这一点 `num_bytes/4`.
+- 如果达到截断限制,应将预算的一半用于开头,一半用于末尾,并在中间进行截断,使用 `…3 tokens truncated…`
### GPT-5.3 Codex 中的新功能
#### 前言消息
-Responses API 包含一个 `phase` 参数,旨在防止当提示请求前导消息时出现提前停止和其他异常行为。正确实现此参数是 `gpt-5.3-codex`;所必需的;否则,可能会出现显著的性能下降。
+Responses API 包含一个 `phase` 参数,用于在提示请求前置消息时防止提前停止和其他异常行为。正确实现该参数是 `gpt-5.3-codex`;否则可能会出现严重的性能下降。
#### 阶段
-为了更好地支持带有前言的 `gpt-5.3-codex`,Responses API 包含一个 `phase` 字段,旨在防止长时间运行任务过早停止及其他异常行为。
+为了更好地支持带有 `gpt-5.3-codex`,的预消息,Responses API 提供了一个 `phase` 字段,旨在防止在长时间运行的任务上提前停止以及其他异常行为。
-##### 值
+##### Values
-`phase` 是以下之一:
+`phase` 为以下值之一:
- `null`
- `"commentary"`
@@ -621,44 +621,44 @@ Responses API 包含一个 `phase` 参数,旨在防止当提示请求前导消
##### 出现位置
-你将收到 `phase` 关于助手输出项(例如, `output_item.done`)。你的集成必须持久化助手输出项,包括它们的 `phase`,并在后续请求中传回这些助手项。
+你会收到 `phase` 关于助手输出项(例如, `output_item.done`)。你的集成必须持久化助手输出项,包括其 `phase`,并在后续请求中把这些助手项传回。
-**重要:** `phase` 仅支持在助手项上使用。不要在用户消息中添加 `phase` 。
+**重要提示:** `phase` 仅在助手项上受支持。不要将 `phase` 添加到用户消息中。
-##### 下游如何使用
+##### 它的下游使用方式
-当模型用以下方式标记输出项时:
+当模型使用以下方式标记某个输出项时:
-- `phase: "commentary"`:相应的助手消息应被视为评论/前言风格的内容。
-- `phase: "final_answer"`:相应的助手消息应被视为最终收尾。
+- `phase: "commentary"`: 对应的助手消息应被视为评论/前言式内容。
+- `phase: "final_answer"`: 对应的助手消息应被视为最终收尾内容。
-正确保留 `phase` 智能体项目上的 `gpt-5.3-codex`。是必需的。如果智能体 `phase` 元数据在历史重建过程中被丢弃,可能会导致显著的性能下降。
+正确保留 `phase` assistant 项上的元数据是必需的 `gpt-5.3-codex`。如果 assistant `phase` 元数据在历史记录重建过程中被丢弃,可能会导致严重的性能下降。
-#### 前言与人格设定
+#### 前言与人设
-前导消息是随工具调用一起发送的消息,在工作过程中向用户提供更新:简短、人类可读的进度和意图快照,让用户保持了解情况,而不会将对话记录变成工具调用日志。GPT-5.3-Codex 的前导消息已针对以下特征进行了调优:
+前言消息是随工具调用一起发送的消息,用于在工作时向用户提供更新:简短、人类可读的进度和意图快照,可以让用户随时了解情况,而不会把对话记录变成工具调用日志。GPT-5.3-Codex 的前言已针对以下特性进行了调优:
-- 在调用任何工具之前,先确认再制定计划(1 句确认,1–2 句计划)。
-- 大多数更新保持 1–2 句,仅在真正达到里程碑时使用更长的更新。
-- 节奏:目标为每 1–3 个执行步骤一次;硬性下限:至少每 6 个步骤或 10 次工具调用内一次。
-- 每次更新的内容:目前为止的结果/影响、接下来的 1–3 个步骤,以及存在的开放问题/学习心得。
-- 语气:真实人物配对,低仪式感;避免标题/状态标签和日志语气。
+- 在任何工具调用之前先确认再规划(1 句确认,1–2 句规划)。
+- 大多数更新控制在 1–2 句,仅在真正的里程碑处使用较长更新。
+- 节奏:目标每 1–3 个执行步骤一次;硬性下限:至少每 6 步或 10 次工具调用内一次。
+- 每次更新的内容:到目前为止的进展/影响、接下来的 1–3 步,以及(若存在)未解决的问题/学到的经验。
+- 语气:像真实的人在结对协作,低仪式感;避免使用标题/状态标签以及日志式的措辞。
-##### 个性(友好 vs 务实)
+##### Personality(友好 vs 务实)
-个性是比前言机制(节奏、长度和依据)更高层次的氛围与协作姿态。它影响措辞选择、模型解释权衡的积极程度,以及它为交互带来的温暖感。
+人格是位于前置语机制(节奏、长度和事实依据)之上的更高层次的氛围与协作姿态。它会影响用词选择、模型解释权衡取舍的积极程度,以及它在交互中带来多少温度。
-Codex 应用和 CLI 内置支持两种个性,此处作为示例实现提供,供你的工具链使用。
+Codex 应用和 CLI 自带对两种人格的支持,这里将其作为示例实现提供给你的运行环境。
-###### 友好
+###### 友好型
-- 更像人类,更具搭档感的配对能量。
-- 稍多一些认可、安慰和情境铺垫。
-- 当用户受益于叙述性引导(如入门指导、任务不明确、变更影响较大)时效果更佳。
+- 更人性化、更具伙伴感的配对风格。
+- 略多的确认、安抚和背景铺垫。
+- 在用户需要叙事式引导时(新手引导、模糊任务、影响更大的改动)效果更佳。
-###### 来自 codex-cli 的友好人格提示词示例片段
+###### Example Friendly personality prompt snippet from codex-cli
-这段代码片段可用于你的系统提示中,以引导模型的结对编程个性。
+此代码片段可用于你的系统提示中,以引导模型的结对编程风格。
```text
# Personality
@@ -684,21 +684,21 @@ You escalate gently and deliberately when decisions have non-obvious consequence
###### 务实
-- 更简洁、直接,注重交付。
-- 减少社交客套;每个 token 承载更多可操作信息。
-- 当延迟/吞吐量重要,或你的用户已了解工作流且只关心进展和结果时,此方式更佳。
+- 更简洁直接,专注交付与上线。
+- 减少社交性修饰;每个 token 承载更高比例的可操作信息。
+- 在延迟或吞吐量至关重要时效果更好,或当你的用户已了解 工作流、只希望获得进展与结果时尤为适用。
-#### 故障排查与元提示
+#### 故障排除与元提示
我们一直在明确追踪的常见故障模式:
-- 过度思考/在首次有效操作(工具调用或具体计划)之前耗时过长。
-- 像日志般生硬/不自然的更新状态,而非结对编程式的协作。
-- 尴尬的开场白措辞和重复性的口头禅("说得好"、"啊哈"、"明白了–"等)。
+- 在首次有效操作(工具调用或具体计划)之前过度思考/耗时过长。
+- 日志式/不自然的状态更新,而非结对编程式的协作。
+- 尴尬的铺垫措辞和重复的口头禅(例如 "Good catch"、"Aha"、"Got it–" 等)。
-##### 针对特定修复的元提示
+##### 针对定向修复的元提示
-像上面这样的故障模式通常可以通过元提示来解决。在某个回合结束时,如果模型的表现未达到预期,可以询问模型如何改进其自身的指令。下面这个提示词被用来生成上述一些过度思考问题的解决方案,你可以根据你的具体需求进行修改。
+像上述这类失败模式通常可以通过元提示(metaprompting)来解决。可以在未达到预期效果的一轮结束时向模型询问如何改进其自身的指令。下面这段提示曾用于生成上述“过度思考”问题的部分解答,你可以根据自身需求进行调整。
```text
That was a high quality response, thanks! It seemed like it took you a while to finish responding though. Is there a way to clarify your instructions so you can get to a response as good as this faster next time? It’s extremely important to be efficient when providing these responses or users won’t get the most out of them in time. Let’s see if we can improve!
@@ -707,10 +707,10 @@ read through your instructions starting from "" and look for anything that might
write out targeted (but generalized) additions/changes/deletions to your instructions to make a request like this one faster next time with the same level of quality
```
-在特定上下文中使用元提示时,如果可能的话,多次生成响应并注意响应中共同存在的元素非常重要。模型提出的某些改进或更改可能过于针对特定情况,但你通常可以简化它们以获得普遍适用的改进。我们建议创建一个评估来测量特定的提示词更改对你的具体用例是有益还是有害。
+在特定上下文中使用元提示时,重要的是尽可能多次生成回复,并留意这些回复中共通的部分。模型提出的某些改进或变更可能过度针对该特定情境,但你通常可以将它们简化,从而得到一种通用的改进方法。建议你创建一个评估(eval),用来衡量某项提示改动对你的具体用例而言是更好还是更差。
##### 一些示例
-- 针对过度思考/起步缓慢:要求它提出指令修改,以缩短首次工具调用或首个具体计划的时间。
-- 对于过于冗长的开场白:要求它重写你的用户更新指令,以满足你的特定偏好约束。
+- 针对过度思考 / 启动缓慢:让它提出能缩短首次工具调用时间或首个具体方案的指令修改建议。
+- 针对过于冗长的开场白:让它重写你的用户更新说明,以满足你特定的偏好约束。
diff --git a/docs/zh/api/docs/guides/latest-model/gpt-5.5.md b/docs/zh/api/docs/guides/latest-model/gpt-5.5.md
index 0411175..2838ff6 100644
--- a/docs/zh/api/docs/guides/latest-model/gpt-5.5.md
+++ b/docs/zh/api/docs/guides/latest-model/gpt-5.5.md
@@ -1,107 +1,107 @@
# 使用 GPT-5.5
-> 有关完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取文档页面的 Markdown 版本。
## 简介
-GPT-5.5 提升了复杂生产工作流的基线。它非常适合编码用例、大量使用工具的智能体、有依据的助手、长上下文检索、产品规格到计划的转换工作流,以及执行质量和回复润色至关重要的面向客户的工作流。
+GPT-5.5 提升了复杂生产工作流的基线水平。它非常适合编码场景、工具密集型的智能体、基于事实的助手、长上下文检索、从产品规约到规划的工作流,以及对执行质量和回复润色要求较高的面向客户的工作流。
-要充分利用 GPT-5.5,请将其视为需要调优的新模型系列,而不是 `gpt-5.2` 或 `gpt-5.4`。的即插即用替代品。开始迁移时,请使用全新的基线,而不是照搬旧提示词堆栈中的所有指令。从能保持产品契约的最小提示词开始,然后根据代表性示例调整推理力度、详细程度、工具描述和输出格式。
+要充分发挥 GPT-5.5 的能力,应将其视为一个需要重新调优的新模型系列,而不是 `gpt-5.2` 或 `gpt-5.4`。的直接替代品。开始迁移时建议建立全新的基线,而不是照搬旧提示词栈中的所有指令。先从能在保持产品契约的前提下用最小提示词,随后针对代表性样本调优推理力度、冗长度、工具描述和输出格式。
-GPT-5.5 支持 GPT-5.4 已经提供的所有 API 功能,包括 [提示词缓存](https://developers.openai.com/api/docs/guides/prompt-caching), [托管工具](https://developers.openai.com/api/docs/guides/tools#available-tools), [工具搜索](https://developers.openai.com/api/docs/guides/tools-tool-search), [压缩](https://developers.openai.com/api/docs/guides/compaction),以及 `phase` 手动重放助手项目的处理。
+GPT-5.5 支持 GPT-5.4 已有的所有 API 功能,包括 [提示词缓存](https://developers.openai.com/api/docs/guides/prompt-caching), [托管工具](https://developers.openai.com/api/docs/guides/tools#available-tools), [工具搜索](https://developers.openai.com/api/docs/guides/tools-tool-search), [压缩](https://developers.openai.com/api/docs/guides/compaction),以及 `phase` 对手动重放助手条目的处理。
-参见 [提示词最佳实践](#prompting-best-practices) ,了解成功提示词模式的示例。
+请参阅 [提示最佳实践](#prompting-best-practices) 中成功提示模式的示例。
-## 新增内容
+## What's new
-- **更高效的推理:** GPT-5.5 在更少的推理 token 下即可达到更强的结果,即便在相同的推理力度下也是如此。这在复杂、工具密集或多步骤工作流中尤为有用,因为 token 节省会累积。
-- **更强的任务执行能力,配合结果优先的提示词:** GPT-5.5 更擅长从明确目标出发、保留约束,并将产品意图转化为具体的下一步行动。请描述预期结果、成功标准、允许的副作用、证据规则和输出格式。除非具体路径很重要,否则避免逐步过程指导。
-- **更强更精确的工具使用:** GPT-5.5 在大型工具集、多步骤服务工作流和长时间运行的智能体任务中尤其有用。它在工具选择和参数使用上往往更加精确。
-- **语气通常更优雅,但可能更直接:** GPT-5.5 往往能以更少的提示词脚手架产生更温暖、更易读的答案。
+- **更高效的推理:** GPT-5.5 以比以往模型更少的推理令牌即可取得出色的结果,即使在相同的推理强度下也是如此。在复杂、工具密集或多步骤的工作流中,令牌节省会不断累积,这一点尤为有用。
+- **通过以结果为先的提示获得更强的任务执行能力:** GPT-5.5 更擅长围绕明确目标工作、保留约束条件,并将产品意图转化为具体的下一步。请描述预期结果、成功标准、允许的副作用、证据规则以及输出形态。除非确切的执行路径至关重要,否则应避免逐步式的流程指导。
+- **更强且更精准的工具使用:** GPT-5.5 在大型工具集、多步骤服务工作流以及长时间运行的智能体任务中尤为有用。它在工具选择和参数使用方面通常更为精准。
+- **语气通常更精炼,但可能更直接:** GPT-5.5 通常能以更少的提示脚手架,生成更温暖、更易读的回复。
## 行为变更
-1. **推理努力现在默认为 `medium`:** GPT-5.5 默认使用 `medium` 推理努力。将 `medium` 视为在质量、可靠性、延迟和成本方面推荐的平衡起点。对于延迟敏感的工作流,评估 `low` 之前, `none` 当工具使用、规划、搜索或多步骤决策仍然重要时。保留 `none` 用于不需要推理或多链工具调用的延迟关键任务,例如轻量级语音回合、快速信息检索和分类。增加到 `high` 或 `xhigh` 仅当评估显示可测量的质量提升,且证明额外的延迟和成本是合理的。参见 [推理模型文档](https://developers.openai.com/api/docs/guides/reasoning) 以获取推荐设置的更多详细信息。
+1. **推理强度现在默认为 `medium`:** GPT-5.5 默认为 `medium` 推理强度。将 `medium` 视为在质量、可靠性、延迟和成本方面推荐的均衡起点。对于延迟敏感的工作流,请在工具使用、规划、搜索或多步决策仍然重要时评估 `low` 再 `none` ,当工具使用、规划、搜索或多步决策仍然重要时,请评估 `none` 用于不需要推理或多链式工具调用的延迟关键任务,例如轻量级语音轮次、快速信息检索和分类。仅当评估显示可衡量的质量提升能证明额外延迟和成本合理时,才提升至 `high` 或 `xhigh` 。更多推荐设置详情,请参阅 [推理模型文档](https://developers.openai.com/api/docs/guides/reasoning) 。
- 更高的推理努力并不自动更好。如果任务有冲突的指令、较弱的停止标准或开放式的工具访问,更高的努力可能导致过度思考、不必要的搜索或输出质量下降。仅在评估显示可测量的质量提升时才增加努力。
+ 更高的推理强度并不自动更好。如果任务存在冲突指令、较弱的停止条件或开放式的工具访问,更高的强度可能导致过度思考、不必要的搜索或输出质量下降。仅当评估显示可衡量的质量提升时,才提升强度。
-2. **图像输入默认保留更多视觉细节:** GPT-5.5 更新了图像输入的默认处理方式,以保留更多视觉细节并提升计算机使用性能。当 `image_detail` 未设置或设置为 `auto`,时,模型现在使用 `original` 行为,在不调整大小的情况下保留图像,最高可达 10,240,000 像素或 6,000 像素的尺寸限制。对于 `high`,直接指定值;它会在不调整大小的情况下保留图像,最高可达 2,500,000 像素或 2,048 像素的尺寸限制。 `low` 现在专注于上下文效率,并比之前的模型更积极地调整超过 512 像素尺寸限制的图像大小。参见 [图像和视觉文档](https://developers.openai.com/api/docs/guides/images-vision).
+2. **图像输入默认保留更多视觉细节:** GPT-5.5 更新了图像输入的默认处理方式,以保留更多视觉细节并提升计算机使用性能。当 `image_detail` 未设置或设置为 `auto`,时,模型现在使用 `original` 行为,在不超过 10,240,000 像素或 6,000 像素尺寸限制的情况下保留图像而不进行缩放。对于 `high`,请直接指定该值;它在不超过 2,500,000 像素或 2,048 像素尺寸限制的情况下保留图像而不进行缩放。 `low` 现在专注于上下文效率,并以比先前模型更激进的方式对超过 512 像素尺寸限制的图像进行缩放。请参阅 [图像和视觉文档](https://developers.openai.com/api/docs/guides/images-vision).
-3. **改进的指令遵循:** GPT-5.5 以字面和彻底的方式解读提示,使产品需要时能够提供具体、描述性的指令。定义成功标准和停止规则,尤其是对于长时间运行、工具密集型或收集证据的工作流。请参阅 [以结果为导向的提示编写](#outcome-first-prompts-and-stopping-conditions) 和 [保持适当的特异性](#formatting).
+3. **改进指令遵循能力:** GPT-5.5 以字面化且彻底的方式解读提示词,当产品需要时可以给出具体、描述性的指令。定义成功标准和停止规则,尤其是对于长时间运行、工具密集或证据收集型的工作流。参见 [编写以结果为先的提示词](#outcome-first-prompts-and-stopping-conditions) 以及 [保持适度的具体性](#formatting).
-4. **默认风格更简洁直接:** GPT-5.5 默认倾向于高效、直接且以任务为导向。这对于许多生产工作流很有用,但面向客户或对话式体验可能需要明确的人格、温暖度、理由和格式指导。使用 `text.verbosity` 要有意识: `medium` 是默认选项,而 `low` 通常是获得简洁响应的更好起点。请参阅 [提示最佳实践](#prompting-best-practices).
+4. **默认风格更简洁直接:** GPT-5.5 默认倾向于高效、直接且以任务为导向。这对许多生产工作流很有用,但面向客户或对话式的体验可能需要明确指定个性、温度、推理过程和格式指引。使用 `text.verbosity` 有意设置: `medium` 为默认值,而 `low` 通常更适合作为简洁回复的起点。参见 [提示词最佳实践](#prompting-best-practices).
-5. **编码工作流需要更强的编排:** GPT-5.5 更适合需要规划、工具使用、代码库导航、验证和多步骤执行的复杂编码任务。对于编码 智能体,要明确复用、子智能体委派、测试期望、验收标准,以及何时继续与何时寻求帮助。
+5. **编码工作流需要更强的编排:** GPT-5.5 更适合需要规划、工具使用、代码库导航、验证以及多步执行的复杂编码任务。对于编码 智能体,应明确说明复用、子智能体委托、测试预期、验收标准,以及何时继续推进、何时寻求帮助。
## 迁移快速入门
### 使用 Codex 自动迁移
-Codex 可以应用本指南中推荐的更改,配合 [OpenAI Docs 技能](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs).
+Codex 可以通过以下方式应用本指南中的推荐更改: [OpenAI Docs 技能](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs).
```text
$openai-docs migrate this project to gpt-5.5
```
-要在其他编码 智能体中使用此技能,请从以下位置下载: [OpenAI 技能仓库](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs).
+要在其他编码智能体中使用此技能,请从 [OpenAI 技能仓库下载](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs).
-### API 与模型参数
+### API 和模型参数
- 将模型 slug 更新为 `gpt-5.5`.
-- 对于任何推理、工具调用或多轮用例,请使用 Responses API。
-- 调整 `reasoning.effort`。使用 `low` 实现高效推理, `medium` 用于在延迟/性能曲线上取得平衡点, `high` 用于需要硬推理且延迟不太重要的复杂智能体任务,以及 `xhigh` 用于最困难的异步智能体任务或测试模型智能极限的评估。请参阅 [推理模型文档](https://developers.openai.com/api/docs/guides/reasoning).
-- 要配置更简洁的响应,请将 `text.verbosity` 设置为 `low`。在 GPT-5.5 上,这将比 `low` GPT-5.4 的冗长程度产生成比例地更简洁的响应。
-- 对于工具密集型或长时间运行的工作流,请验证你的应用程序是否正确处理 `phase`、前言和助手条目重放。
-- 在准确性、令牌消耗和端到端延迟方面与其他模型进行基准测试。
+- 使用 Responses API 处理任何推理、工具调用或多轮用例。
+- Tune `reasoning.effort`。使用 `low` 进行高效推理, `medium` 在延迟与性能曲线上取得平衡, `high` 用于需要强推理且对延迟要求不高的复杂智能体任务,以及 `xhigh` 用于最具挑战性的异步智能体任务或评估模型智能边界的评测。详见 [推理模型文档](https://developers.openai.com/api/docs/guides/reasoning).
+- 若要配置更简洁的回复,请将 `text.verbosity` 设置为 `low`。在 GPT-5.5 上,这将带来比 GPT-5.4 上的 `low` verbosity 比例更简洁的回复。
+- 对于工具密集型或长时间运行的工作流,请验证你的应用是否正确处理 `phase`、前言以及 assistant-item 重放。
+- 在准确性、token 消耗和端到端延迟方面与其他模型进行基准对比。
-### 提示词
+### 提示工程
-- 说明预期结果和成功标准。
-- 减少或移除详细的分步过程指导。除非产品要求特定路径,否则让 GPT-5.5 自行选择路径。
-- 尽可能从提示中移除输出模式定义。改为使用 [结构化输出](https://developers.openai.com/api/docs/guides/structured-outputs) 。
-- 针对缓存优化你的提示: [静态部分前置,动态部分后置](https://developers.openai.com/api/docs/guides/prompt-caching).
-- 移除当前日期。模型已经知道当前的 UTC 日期。
-- 使用以下内容审查并优化你的提示: [提示最佳实践](#prompting-best-practices).
+- 明确预期结果和成功标准。
+- 减少或移除详细的分步流程指导。除非产品要求该路径,否则让 GPT-5.5 自行选择路径。
+- 尽可能在提示中移除输出模式定义。使用 [结构化输出](https://developers.openai.com/api/docs/guides/structured-outputs) 来替代。
+- 优化你的提示以提升缓存效果: [静态内容在前,动态内容在后](https://developers.openai.com/api/docs/guides/prompt-caching).
+- 去掉当前日期。模型已经知道当前的 UTC 日期。
+- 使用以下工具审查并优化你的提示: [提示词最佳实践](#prompting-best-practices).
## 使用推理模型
-本指导适用于 GPT-5 系列模型,当团队将工作负载迁移到推理模型上时值得重新审视。GPT-5.5 延续了许多早期模型中首次出现的功能,但如果你从较早的 GPT-5 模型、GPT-4.1 或诸如 o3 的推理模型迁移过来,这些功能仍然值得回顾。
+本指南适用于 GPT-5 系列模型,每当团队将工作负载迁移到推理模型时都值得重新阅读。GPT-5.5 沿用了许多在早期模型中首次出现的能力,但如果你是从早期的 GPT-5 模型、GPT-4.1 或类似 o3 的推理模型迁移过来,这些能力仍然值得重新审视。
-团队可能会忽略这些功能,因为它们部分位于 API 配置和编排中,而非提示本身。结合使用 Responses API、推理控制、详细程度、结构化输出、提示缓存、工具设计、托管工具和状态管理,可帮助推理模型实现最佳的智能、可靠性、延迟和成本表现。
+团队可能会忽略这些特性,因为它们有一部分位于 API 配置与编排层面,而非提示本身。组合使用时,Responses API、推理控制、详细程度、结构化输出、提示缓存、工具设计、托管工具以及状态管理,能帮助推理模型在智能、可靠性、延迟和成本结构上发挥最佳水平。
-- **Responses API:** GPT-5.5 在 [Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses)。中表现最佳。使用 `previous_response_id` 处理多轮状态。对于无状态或零数据保留流程,每轮传递返回的相关输出项。参见 [从上一响应传递上下文](https://developers.openai.com/api/docs/guides/conversation-state#passing-context-from-the-previous-response) 了解详情。
-- **推理努力:** 使用 `reasoning.effort` 在 `low`, `medium`, `high`、或 `xhigh`。之间选择。默认值为 `medium`,但许多工作负载使用 `low`。也能表现良好。将 `none` 保留给低延迟比智能更重要的用例。参见 [推理模型](https://developers.openai.com/api/docs/guides/reasoning) 获取详细建议。
-- **详细程度:** 使用 `text.verbosity` 控制输出长度。将最终答案的长度视为与推理质量无关;在需要时指定字数预算、章节数量、表格宽度或仅 JSON 输出。
-- **结构化输出:** 避免在提示中描述预期的输出模式。使用 [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs) 进行自动验证并提高准确性。
-- **提示缓存:** [Prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching) 会自动对符合条件的长提示生效,并可以降低延迟和输入 token 成本。为了最大化缓存命中率,请在请求开头保持稳定的内容。将动态的、特定于用户的内容放在接近末尾处。对于具有常见前缀的重复流量,请始终使用 `prompt_cache_key` 并跟踪 `usage.prompt_tokens_details.cached_tokens`.
-- **工具调用:** GPT-5.5 支持与 GPT-5.4 相同的工具调用模式,包括函数工具和大量使用工具的智能体工作流。将大部分特定于工具的指导放在工具描述本身中:工具的作用、何时使用它、所需输入、副作用、重试安全性和常见错误模式。仅当工具特定的上下文适用于所有工具或实质性改变智能体的操作策略时,才将其添加到系统指令中。
-- **托管工具和工具搜索:** 优先使用 [OpenAI 托管的工具](https://developers.openai.com/api/docs/guides/tools) 适用于符合工作流的场景,例如网页搜索、文件搜索、代码解释器、图像生成和计算机使用。托管工具减少自定义编排负担,并使常见工具模式与Responses API和Agents SDK保持一致。当您需要调用自己的系统、强制执行特定领域的副作用或暴露内部业务工作流时,请使用自定义函数工具。对于大型工具目录,请考虑使用 [tool search](https://developers.openai.com/api/docs/guides/tools-tool-search) 以延迟工具定义并仅加载相关子集。
-- **工具前言:** 前言可以改善聊天用户体验,因为用户在模型生成最终响应之前会看到初始的、有用的状态更新。它们还使工具的使用更容易理解:模型可以说明它将要检查或做什么,然后在工具结果到达后从同一助手状态继续。
-- **`phase` 处理:** 如果您的应用程序手动管理 Responses 状态,通过将输出项传递回每一轮,而不是使用 `previous_response_id`,请保留 `phase` 返回的助手输出项上的参数,并原样传回。在使用推理努力、前言或重复工具调用时,这一点尤其重要。参见 [Phase 参数](https://developers.openai.com/api/docs/guides/reasoning#phase-parameter).
-- **压缩:** 对于长时间运行的智能体,请使用 [对话/状态压缩](https://developers.openai.com/api/docs/guides/compaction) 有意识地。保留已完成的动作、活跃的假设、ID、工具结果、未解决的阻碍因素以及下一个具体目标。
-- **Agents SDK:** 对于新的智能体系统,请使用最新的 [Agents SDK](https://developers.openai.com/api/docs/guides/agents) 模式来处理工具编排、追踪、交接和状态管理,而不是从头重建编排。
-- **当前日期:** GPT-5.5 知道 UTC 的当前日期。你无需在系统指令中添加当前日期。仅在应用需要业务特定的时区、政策生效日期、用户本地日期或其他非 UTC 参考点时,才添加明确的日期或时区上下文。
+- **Responses API:** GPT-5.5 在 [Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses)。使用 `previous_response_id` 中表现最佳,可用于多轮状态处理。对于无状态或零数据保留流程,请在每轮回传相关的返回输出项。详见 [从上一次响应传递上下文](https://developers.openai.com/api/docs/guides/conversation-state#passing-context-from-the-previous-response) 。
+- **推理力度:** 使用 `reasoning.effort` 在以下选项之间选择 `low`, `medium`, `high`,或 `xhigh`。默认值为 `medium`,但许多工作负载使用 `low`。时也能表现良好。 `none` 将其留给那些低延迟比智能更重要的用例。详见 [推理模型](https://developers.openai.com/api/docs/guides/reasoning) 以获取详细建议。
+- **冗长度:** 使用 `text.verbosity` 以控制输出长度。将最终答案的长度与推理质量分开处理;在需要时指定字数预算、章节数量、表格宽度或仅输出 JSON。
+- **结构化输出:** 避免在提示中描述期望的输出模式。请使用 [结构化输出](https://developers.openai.com/api/docs/guides/structured-outputs) 用于自动校验并提升准确性。
+- **Prompt caching:** [Prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching) 会针对符合条件的较长提示自动生效,可降低延迟和输入 token 成本。为最大化缓存命中率,请在请求开头保持稳定内容,将与用户相关的动态上下文放在末尾。对于具有相同前缀的重复流量,请使用 `prompt_cache_key` 保持一致,并跟踪 `usage.prompt_tokens_details.cached_tokens`.
+- **工具调用:** GPT-5.5 支持与 GPT-5.4 相同的工具调用模式,包括函数工具以及工具密集型的智能体工作流。将大部分工具专属指导放在工具描述本身中:工具的功能、何时使用、所需输入、副作用、重试安全性以及常见错误模式。仅当工具专属上下文跨工具通用或实质性改变智能体的运行策略时,才将其加入系统指令。
+- **托管工具和工具搜索:** 优先使用 [OpenAI-hosted tools](https://developers.openai.com/api/docs/guides/tools) 以契合工作流,例如网页搜索、文件搜索、代码解释器、图像生成和计算机使用。托管工具可减少自定义编排负担,并使常见工具模式与Responses API以及Agents SDK保持一致。当你需要调用自有系统、执行特定领域的副作用,或暴露内部业务工作流时,请使用自定义函数工具。对于大型工具目录,可考虑使用 [tool search](https://developers.openai.com/api/docs/guides/tools-tool-search) 以延迟工具定义,仅加载相关子集。
+- **工具前置说明:** 前置说明可以改善聊天体验,因为用户在模型生成最终响应之前就能看到一条有用的初始状态更新。它们也让工具调用过程更易于跟踪:模型可以说明接下来要检查或执行的操作,然后在工具结果返回后从同一助手状态继续。
+- **`phase` 处理:** 如果你的应用通过在每轮传回输出项来手动管理 Responses 状态,而非使用 `previous_response_id`,请在返回的助手输出项上保留该 `phase` 参数并原样传回。在使用推理强度、前置说明或重复工具调用时,这一点尤为重要。参见 [Phase parameter](https://developers.openai.com/api/docs/guides/reasoning#phase-parameter).
+- **压缩:** 对于长时间运行的 智能体,使用 [conversation/state compaction](https://developers.openai.com/api/docs/guides/compaction) (对话/状态压缩),仅在明确意图下进行。保留已完成的活动、当前假设、ID、工具结果、未解决的阻塞项以及下一个具体目标。
+- **Agents SDK:** 对于新的智能体系统,使用最新的 [Agents SDK](https://developers.openai.com/api/docs/guides/agents) 中的工具编排、追踪、交接和状态管理模式,而不是从零开始重建编排逻辑。
+- **当前日期:** GPT-5.5 已知晓 UTC 当前日期。你无需将当前日期添加到系统指令中。仅当应用需要业务特定的时区、生效日期、用户本地日期或其他非 UTC 参考点时,才添加显式的日期或时区上下文。
-## 提示词最佳实践
+## 提示最佳实践
-当提示词定义好预期结果并为模型留出选择高效解决方案路径的空间时,GPT-5.5 表现最佳。与早期模型相比,你通常可以使用更简短、更以结果为导向的提示词:描述理想结果的样子、哪些约束条件重要、有哪些可用证据,以及最终答案应包含什么。
+GPT-5.5 在提示词明确描述期望结果并为模型留出选择高效解决方案路径的空间时表现最佳。与早期模型相比,你通常可以使用更简短、更聚焦于结果的提示词:描述什么算作良好结果、哪些约束重要、可用的证据有哪些,以及最终答案应包含哪些内容。
-避免沿用旧提示词堆栈中的每一条指令。传统提示词往往过度指定流程,因为早期模型需要更多帮助才能保持在正轨上。对于 GPT-5.5,这可能会增加干扰、缩小模型的搜索空间,或导致过于机械的回答。
+避免沿用旧版提示词栈中的每一条指令。旧版提示词往往会过度规定过程,因为早期模型需要更多帮助才能保持在正轨上。而在 GPT-5.5 上,这可能反而会引入噪声、收窄模型的搜索空间,或导致答案过于机械。
-这里的模式是起点。根据你的产品界面、工具、评估和用户体验目标进行调整。
+这里的模式只是起点。请结合你的产品界面、工具、评估方式和用户体验目标进行调整。
### 个性与行为
-GPT-5.5 的默认风格高效、直接且以任务为导向。这对生产系统很有用:响应保持聚焦,行为更易引导,模型会避免不必要的对话填充。
+GPT-5.5 的默认风格高效、直接且以任务为导向。这对生产系统很有用:响应保持聚焦,行为更易引导,并且模型会避免不必要的对话式冗余。
-对于面向客户的助手、支持工作流、辅导体验和其他对话型产品,既要定义个性,也要定义协作风格。
+对于面向客户的助手、支持工作流、辅导体验以及其他对话型产品,需要同时定义其个性与协作风格。
-- **个性** 控制助手的声音表现:语气、温暖度、直接程度、正式程度、幽默感、共情能力以及精细程度。
-- **协作风格** 控制助手的工作方式:何时提问、何时做出假设、应多主动、提供多少上下文、何时检查工作,以及如何处理不确定性或风险。
+- **个性** 控制助手的声音风格:语气、亲和度、直接程度、正式度、幽默感、共情能力以及表达的精致程度。
+- **协作风格** 控制助手的工作方式:何时提问、何时做出假设、应有多主动、提供多少上下文、何时检查工作,以及如何处理不确定性或风险。
-两者都应保持简短。个性指令应塑造用户体验。协作指令应塑造任务行为。两者都不应取代明确的目标、成功标准、工具规则或停止条件。
+保持两者简短。个性指令应当塑造用户体验。协作指令应当塑造任务行为。两者都不能替代清晰的目标、成功的评判标准、工具规则或停止条件。
-稳定的任务导向型助手的个性块示例:
+用于稳定且专注于任务的智能体的个性示例块:
```text
# Personality
@@ -114,7 +114,7 @@ Stay concise without becoming curt. Give enough context for the user to understa
Match the user's tone within professional bounds. Avoid emojis and profanity by default, unless the user explicitly asks for that style or has clearly established it as appropriate for the conversation.
```
-富有表现力的协作助手的个性块示例:
+用于表达性协作型智能体的个性示例块:
```text
# Personality
@@ -125,33 +125,33 @@ Be warm, collaborative, and polished. Conversation should feel easy and alive, b
Be thoughtful and grounded when the task calls for synthesis or advice. State a clear recommendation when you have enough context, explain important tradeoffs, and name uncertainty without becoming evasive.
```
-对于更具表现力的产品,明确加入温暖、好奇、幽默或观点,但保持块简短。使用个性来塑造体验,而不是弥补不清晰的目标或缺失的任务说明。
+对于更具表现力的产品,可以明确地加入温暖感、好奇心、幽默感或观点,但请保持该块简短。使用个性来塑造体验,而不是用来弥补目标不清晰或任务指令缺失。
-### 使用前导内容缩短首个可见令牌的时间
+### 通过预填充消息缩短首字延迟
-在流式应用中,用户会关注第一个可见响应出现前需要多长时间。GPT-5.5 在输出可见文本之前,可能会花时间进行推理、规划或准备工具调用。
+在流式应用中,用户会注意到在第一个可见响应出现之前需要等待多长时间。GPT-5.5 可能会在发出可见文本之前花时间进行推理、规划或准备工具调用。
-对于较长的任务或工具密集型任务,提示模型以简短的前言开始:一段简短的可见更新,确认请求并说明第一步。这可以在不改变底层任务的情况下提升可感知的响应速度。
+对于较长或工具密集型任务,可以提示模型以一段简短的引导语开头:先给出一个简短的可见更新,确认请求并说明第一步。这可以在不改变底层任务的情况下改善感知到的响应速度。
-当任务可能需要多个步骤、需要调用工具,或涉及长时间运行的智能体 工作流时,使用此模式。
+当任务可能需要多个步骤、需要工具调用,或涉及长时间运行的智能体工作流时,可以使用此模式。
```text
Before any tool calls for a multi-step task, send a short user-visible update that acknowledges the request and states the first step. Keep it to one or two sentences.
```
-对于暴露独立消息阶段的编码智能体,你可以更明确地表述:
+对于暴露独立消息阶段的编码智能体,你可以更明确地这样做:
```text
You must always start with an intermediary update before any content in the analysis channel if the task will require calling tools. The user update should acknowledge the request and explain your first step.
```
-### 结果优先的提示词与停止条件
+### 以结果为导向的提示与停止条件
-当提示词定义了目标结果、成功标准、约束条件和可用上下文,然后让模型自行选择路径时,GPT-5.5 的表现最为强劲。
+当提示词定义了目标结果、成功标准、约束以及可用上下文,并让模型自行选择路径时,GPT-5.5 的表现最佳。
-对于许多任务,描述目标而非每一步。这能让模型有空间为任务选择正确的搜索、工具或推理策略。
+对于许多任务,应描述目标,而不是罗列每一步。这样可以让模型根据任务自行选择合适的搜索、工具或推理策略。
-推荐这样写:
+推荐写法:
```text
Resolve the customer's issue end to end.
@@ -163,9 +163,9 @@ Success means:
- if evidence is missing, ask for the smallest missing field
```
-**避免不必要的绝对规则。** 较旧的提示词常使用严格指令,如 `ALWAYS`, `NEVER`, `must`,以及 `only` 来控制模型行为。仅在真正的不可变项上使用这些措辞,例如安全规则、必填输出字段或绝不应发生的操作。对于需要判断的情况,例如何时搜索、请求澄清、使用工具或继续迭代,优先使用决策规则。
+**避免不必要的绝对规则。** 较早的提示词常常使用如下严格指令 `ALWAYS`, `NEVER`, `must`,以及 `only` 来控制模型行为。请将这些措辞留给真正的不变项,例如安全规则、必需的输出字段或绝不应发生的操作。对于判断类问题,例如何时搜索、何时请求澄清、何时使用工具或何时继续迭代,应改用决策规则。
-除非每一步都确实必要,否则避免这种风格的指令:
+除非每一步都确实必要,否则应避免这种指令风格:
```text
First inspect A, then inspect B, then compare every field, then think through
@@ -181,7 +181,7 @@ Resolve the user query in the fewest useful tool loops, but do not let loop mini
After each result, ask: "Can I answer the user's core request now with useful evidence and citations for the factual claims?" If yes, answer.
```
-定义缺少证据时的行为:
+定义证据缺失时的行为:
```text
Use the minimum evidence sufficient to answer correctly, cite it precisely, then stop.
@@ -189,11 +189,11 @@ Use the minimum evidence sufficient to answer correctly, cite it precisely, then
### 格式化
-GPT-5.5 在输出格式和结构上具有很强的可引导性。当它有助于提升理解或产品契合度时,请利用这种控制。
+GPT-5.5 在输出格式和结构上具有高度可引导性。当这种控制有助于理解或产品契合时,请善加利用。
-设置 `text.verbosity`,描述预期的输出形状,并将较重的结构保留用于能提升理解或你的产品 UI 需要稳定产物的情况。API 的默认 `text.verbosity` 是 `medium`;使用 `low` 当你偏好更短、更简洁的响应时。
+设置 `text.verbosity`,描述预期的输出形态,并将更重的结构留给能够提升理解力或产品 UI 需要稳定产物的场景。API 针对 `text.verbosity` 的默认是 `medium`;若你偏好更简短 `low` 的回复,请使用。
-纯对话式格式:
+简洁的口语化排版:
```text
Let formatting serve comprehension. Use plain paragraphs as the default format for normal conversation, explanations, reports, documentation, and technical writeups. Keep the presentation clean and readable without making the structure feel heavier than the content.
@@ -203,25 +203,25 @@ Use headers, bold text, bullets, and numbered lists sparingly. Reach for them wh
Respect formatting preferences from the user. If they ask for a terse answer, minimal formatting, no bullets, no headers, or a specific structure, follow that preference unless there is a strong reason not to.
```
-添加明确的受众和长度指导:
+添加明确的受众与长度指引:
```text
Write for a senior business audience. Keep the answer under 400 words. Use short paragraphs and only include bullets when they improve scannability. Prioritize the conclusion first, then the reasoning, then caveats.
```
-对于编辑、重写、摘要或面向客户的讯息,在要求模型改进风格之前,先告诉模型要保留什么。当你希望润色而不扩充内容时,此模式很有用。
+在编辑、改写、摘要或面向客户的消息场景中,先告诉模型需要保留什么,再要求其改进风格。当你希望润色而非扩展时,这种模式非常有用。
```text
Preserve the requested artifact, length, structure, and genre first. Quietly improve clarity, flow, and correctness. Do not add new claims, extra sections, or a more promotional tone unless explicitly requested.
```
-### 基础支撑、引用与检索预算
+### Grounding, citations, and retrieval budgets
-对于有依据的答案,引用行为应作为提示词的一部分。应明确哪些内容需要支持、什么才算充分证据,以及当证据缺失时模型应如何表现。证据缺失不应自动变成事实性的“不是”。有关更多细节和示例,请参阅 [引用格式指南](https://developers.openai.com/api/docs/guides/citation-formatting).
+对于有依据的答案,引用行为应纳入提示词中。明确哪些内容需要依据支持、何为充分证据,以及当证据缺失时模型应如何表现。缺少证据不应自动变成事实上的“否”。更多细节和示例,请参阅 [引用格式化指南](https://developers.openai.com/api/docs/guides/citation-formatting).
-#### 添加显式检索预算
+#### 添加显式的检索预算
-检索预算(retrieval budgets)是搜索的停止规则。它们告诉模型何时收集到的证据已经足够。
+检索预算是搜索的停止规则。它们告诉模型何时证据已经足够。
```text
For ordinary Q&A, start with one broad search using short, discriminative keywords. If the top results contain enough citable support for the core request, answer from those results instead of searching again.
@@ -238,7 +238,7 @@ Do not search again to improve phrasing, add examples, cite nonessential details
### 创意起草护栏
-对于起草任务,需告知模型哪些论断必须来源于资料,哪些部分可以自由创作。这一点对幻灯片、发布文案、客户摘要、演讲稿、领导层简介以及叙事框架尤为重要。
+对于起草类任务,告诉模型哪些说法必须来自资料来源,哪些部分可以由你自由创作。这对于幻灯片、上线文案、客户摘要、宣讲话术、领导致辞以及叙事框架尤其重要。
```text
For creative or generative requests such as slides, leadership blurbs, outbound copy, summaries for sharing, talk tracks, or narrative framing, distinguish source-backed facts from creative wording.
@@ -250,11 +250,11 @@ For creative or generative requests such as slides, leadership blurbs, outbound
### 前端工程与视觉品味
-对于前端工作,请参考 [示例指令](https://developers.openai.com/api/docs/guides/frontend-prompt) 以获取引导 UI 质量的实用方法。这些指令涵盖产品和用户上下文、设计系统对齐、首屏可用性、熟悉控件、预期状态、响应式行为,以及应避免的常见生成式 UI 默认设置,例如通用英雄区、嵌套卡片、装饰性渐变、可见的说明性文字和布局破损。
+对于前端工作,请参阅 [示例说明](https://developers.openai.com/api/docs/guides/frontend-prompt) 了解引导 UI 质量的实用方法。它们涵盖了产品和用户上下文、设计系统一致性、首屏可用性、熟悉的控件、预期状态、响应式行为,以及需要避免的常见生成式 UI 默认值,例如通用的英雄区、嵌套卡片、装饰性渐变、可见的说明性文字以及布局错乱等问题。
### 提示模型检查其工作
-在可以进行验证时,给 GPT-5.5 提供可让其检查输出的工具。
+让 GPT-5.5 访问能够在可以验证时检查输出的工具。
对于编码智能体,要求提供具体的验证命令:
@@ -268,13 +268,13 @@ After making changes, run the most relevant validation available:
If validation cannot be run, explain why and describe the next best check.
```
-对于视觉产物,要求渲染后进行审查:
+对于视觉工件,要求在渲染后进行检查:
```text
Render the artifact before finalizing. Inspect the rendered output for layout, clipping, spacing, missing content, and visual consistency. Revise until the rendered output matches the requirements.
```
-对于工程和规划任务,使实施计划可追踪:
+对于工程和规划任务,让实现计划可追溯:
```text
For implementation plans, include:
@@ -287,11 +287,11 @@ For implementation plans, include:
- open questions that materially affect implementation
```
-### 阶段参数
+### Phase 参数
-从 GPT-5.4 开始,长时间运行或工具密集型的 Responses 工作流可以使用助手项 `phase` 值来区分中间更新与最终答案。GPT-5.5 使用相同的模式。
+从 GPT-5.4 开始,长期运行或工具调用密集的 Responses 工作流可使用 assistant-item `phase` 值来区分中间更新与最终答复。GPT-5.5 使用相同的模式。
-如果你使用 `previous_response_id`,API会自动保留先前的助手状态。如果你的应用手动将助手输出项重放到下一个请求中,请保留每个原始的 `phase` 值并将其原样传回。当响应包含前言、重复的工具调用或中间助手更新后的最终答案时,这一点最为重要。
+如果你使用 `previous_response_id`, API 会自动保留之前的助手状态。如果你的应用将助手输出项手动重放到下一次请求中,请保留每个原始 `phase` 值并原样传回。当响应包含开场白、重复的工具调用,或在中间助手更新之后的最终答复时,这一点尤为重要。
```text
If manually replaying assistant items:
@@ -303,7 +303,7 @@ If manually replaying assistant items:
### 建议的提示词结构
-将这一结构作为复杂提示词的起点。保持每个部分简短。仅在影响行为的地方添加细节。
+以此结构作为复杂提示词的起点。每个章节保持简洁,仅在影响行为处补充细节。
```text
Role: [1-2 sentences defining the model's function, context, and job]
diff --git a/docs/zh/api/docs/guides/latest-model/gpt-5.md b/docs/zh/api/docs/guides/latest-model/gpt-5.md
index 261c2ac..32af004 100644
--- a/docs/zh/api/docs/guides/latest-model/gpt-5.md
+++ b/docs/zh/api/docs/guides/latest-model/gpt-5.md
@@ -1,54 +1,54 @@
# 使用 GPT-5
-> 如需查看完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 完整文档索引请参见 [llms.txt](/llms.txt)。如需获取页面的 Markdown 版本,可在页面 URL 末尾追加 `.md` 。
-## 简介
+## 概述
-GPT-5 在智能体任务性能、编码、原始智能和控制方面代表了巨大的飞跃。
+GPT-5 在智能体任务表现、编码、原始智能和控制力方面实现了重大飞跃。
-虽然我们相信它在广泛的领域内能够“开箱即用”地表现出色,但本指南将介绍一些提示技巧,以最大化模型输出的质量,这些技巧源自我们在训练和将模型应用于现实世界任务中的经验。我们讨论诸如提升智能体任务性能、确保指令遵循、利用新的 API 功能以及优化前端和软件工程任务的编码等概念——并穿插关于 AI 代码编辑器 Cursor 与 GPT-5 在提示调优工作上的关键见解。
+虽然我们相信它在“开箱即用”的情况下就能在广泛领域表现出色,但本指南将介绍一些提示技巧,以最大化模型输出的质量,这些技巧源自我们在真实任务上训练和应用该模型的经验。我们将讨论如何提升智能体任务表现、确保指令遵循、利用新的 API 特性,以及针对前端和软件工程任务优化编码——同时分享 AI 代码编辑器 Cursor 与 GPT-5 开展提示调优工作的关键洞察。
-我们已经看到了通过应用这些最佳实践并尽可能采用我们的规范工具所获得的显著收益,我们希望本指南以及 [提示优化器工具](https://platform.openai.com/chat/edit?optimize=true) (我们已构建的)能作为你使用 GPT-5 的起点。但一如既往,请记住提示并非一刀切的练习——我们鼓励你进行实验,并在此提供的基础上进行迭代,以找到最适合你问题的解决方案。
+我们已看到在应用这些最佳实践并尽可能采用我们的标准工具后取得了显著收益,我们希望本指南以及我们打造的 [提示优化工具](https://platform.openai.com/chat/edit?optimize=true) 能够为你使用 GPT-5 提供一个良好的起点。但请始终记住,提示工程没有放之四海而皆准的方案——我们鼓励你在本文提供的基础上开展实验并不断迭代,从而找到针对你问题的最佳解决方案。
-## 新增内容
+## 更新日志
-- 更强的智能体任务执行能力、编码能力和控制力
-- 在工具调用流程中使用 Responses API 实现推理延续
-- 针对智能体主动性、工具前导语、推理力度和详细程度的专用控制
-- 支持自由格式输入和受约束输出的自定义工具
+- 更强的智能体任务表现、编程能力与可控性
+- 在工具调用流程中,借助 Responses API 实现推理延续
+- 针对智能体主动程度、工具前言、推理力度和详尽程度的专用控制
+- 支持自由输入与受限输出的自定义工具
## 迁移快速入门
-- 将模型 slug 更新为 `gpt-5`.
-- 使用 Responses API 进行推理、工具调用和多轮工作流,以便推理项能在工具调用之间保留。
-- 从 `medium` 推理力度开始,然后在代表性任务上测试 `minimal`, `low`,或 `high` 。
-- 有意地设置 `text.verbosity` ,并尽可能将结构化响应契约迁移到 Structured Outputs。
-- 重新评估提示词中的智能体持久性、工具前言和停止条件。
+- 将模型标识符更新为 `gpt-5`.
+- 使用 Responses API 进行推理、工具调用和多轮工作流,以便在工具调用之间保留推理项。
+- 从 `medium` 推理力度开始,然后测试 `minimal`, `low`,或 `high` 针对代表性任务进行测试。
+- 设置 `text.verbosity` 刻意设置,并将结构化响应契约尽可能迁移到 Structured Outputs。
+- 重新评估智能体持久性、工具前言和停止条件的提示词。
-## 模型、API与功能更新
+## 模型、API 与功能更新
- GPT-5 系列包括 `gpt-5`, `gpt-5-mini`,以及 `gpt-5-nano`.
- `reasoning.effort` 支持 `minimal`, `low`, `medium`,以及 `high`.
-- GPT-5 引入了自定义工具,可接受自由形式的输入,并可使用上下文无关文法约束输出。
-- 该模型支持函数调用和 OpenAI 托管的工具,包括 网页搜索、文件搜索、图像生成、代码解释器和远程 MCP。
+- GPT-5 引入了接受自由格式输入并可使用上下文无关文法约束输出的自定义工具。
+- 该模型支持函数调用和 OpenAI 托管工具,包括 网页搜索、文件搜索、图像生成、代码解释器和远程 MCP。
## 提示词最佳实践
-### 智能体工作流的可预测性
+### 智能体 工作流 可预测性
-我们在开发 GPT-5 时以开发者为出发点:专注于改进工具调用、指令跟随和长上下文理解,使其成为智能体应用的最佳基础模型。如果为智能体和工具调用流程采用 GPT-5,我们建议升级到 [Responses API](https://developers.openai.com/api/reference/resources/responses),其中推理在工具调用之间得以延续,从而实现更高效、更智能的输出。
+我们针对开发者训练了 GPT-5:我们着重提升了工具调用、指令遵循和长上下文理解能力,使其成为智能体应用的最佳基础模型。如果要将 GPT-5 用于智能体和工具调用流程,我们建议升级到 [Responses API](https://developers.openai.com/api/reference/resources/responses),在工具调用之间保持推理状态,从而获得更高效、更智能的输出。
-#### 控制智能体的主动性
+#### 控制智能体的积极程度
-智能体化脚手架可以涵盖广泛的控制范围——有些系统将绝大多数决策权交给底层模型,而另一些系统则通过大量的程序化逻辑分支对模型进行严格约束。GPT-5 经过训练,可以在这一范围内的任何位置运行,从在模糊情况下做出高层决策,到处理重点明确、定义清晰的任务。在本节中,我们将介绍如何最佳地校准 GPT-5 的智能体主动性:也就是说,它在主动性和等待明确指导之间的平衡。
+智能体脚手架在控制粒度上跨度很大——有些系统将绝大多数决策权下放给底层模型,而另一些则通过大量程序化逻辑分支将模型严格约束。GPT-5 经过训练,能够在这一谱系上的任意位置工作,从在模糊情境下做出高层决策,到处理聚焦且定义明确的任务。本节将介绍如何最佳地校准 GPT-5 的智能体积极性:换言之,即在主动推进与等待明确指引之间的平衡。
-##### 降低主动性提示
+##### 提示词缓解过度热情
-GPT-5 默认情况下在智能体环境中尝试收集上下文时会表现得很彻底且全面,以确保生成正确的答案。为了减少 GPT-5 的智能体行为范围——包括限制无关的工具调用操作并最小化到达最终答案的延迟——可以尝试以下方法:
+GPT-5 默认会在智能体环境中全面且详尽地收集上下文,以确保给出正确答案。若希望缩小 GPT-5 智能体行为的范围——包括限制过度的工具调用动作,并缩短到达最终答案的延迟——可尝试以下做法:
-- 更改为较低的 `reasoning_effort`。这会降低探索深度,但可以提高效率和延迟。许多工作流可以在中等甚至低 `reasoning_effort`.
-- 在提示中明确指定你希望模型如何探索问题空间的标准。这会减少模型探索和考虑过多想法的需求:
+- 切换到更低的 `reasoning_effort`。这会降低探索深度,但能提升效率和延迟。许多工作流可以在 medium 甚至 low 下获得一致的结果 `reasoning_effort`.
+- 在你的提示中定义清晰的标准,说明你希望模型如何探索问题空间。这可以减少模型探索和推理过多想法的需要:
```text
@@ -75,7 +75,7 @@ Loop:
```
-如果你愿意采取最大限度的规定性做法,你甚至可以设置固定的工具调用预算,如下所示。预算可以根据你期望的搜索深度自然变化。
+如果你愿意做到最大限度的规范性,甚至可以设置固定的工具调用预算,如下所示。预算可以根据你期望的搜索深度自然变化。
```text
@@ -86,11 +86,11 @@ Loop:
```
-当限制核心上下文收集行为时,明确为模型提供一个逃生舱口是有帮助的,这使其更容易满足更短上下文收集步骤的要求。通常这以允许模型在不确定情况下继续进行的条款形式出现,比如 `“even if it might not be fully correct”` 在上述示例中。
+在限制核心上下文收集行为时,明确为模型提供一个“逃生通道”会很有帮助,使其更容易在更短的上下文收集步骤中满足要求。通常这表现为一个允许模型在不确定的情况下继续执行的条款,例如 `“even if it might not be fully correct”` 如上例所示。
-##### 提示以增强积极性
+##### 引导智能体更主动
-另一方面,如果你希望鼓励模型自主性、提高工具调用持续性,并减少澄清性问题或交还给用户的情况,我们建议提高 `reasoning_effort`,并使用类似下面的提示词来鼓励持续性和彻底的任务完成:
+另一方面,如果你希望鼓励模型自主性、提高工具调用的持续性,并减少澄清性问题或交还给用户的情况,我们建议提高 `reasoning_effort`,并使用如下提示来鼓励持续性和彻底的任务完成:
```text
@@ -101,13 +101,13 @@ Loop:
```
-一般来说,清晰地说明智能体任务的停止条件、概述安全与不安全的操作,并定义模型何时(如果有的话)可以交还给用户,会很有帮助。例如,在一组购物工具中,结账和支付工具应明确设置较低的不确定性阈值以要求用户澄清,而搜索工具应具有极高的阈值;同样,在编码环境中,删除文件工具应比 grep 搜索工具具有更低的阈值。
+通常,明确说明智能体任务的停止条件、列出安全与不安全的操作、以及定义在何种情况下(如果有的话)模型可以交还给用户会很有帮助。例如,在一组购物工具中,下单和支付工具应当显式设置较低的不确定性阈值以要求用户澄清,而搜索工具则应设置极高的阈值;同样地,在编码环境中,删除文件工具的阈值应远低于 grep 搜索工具。
-#### 工具前言
+#### 工具开场白
-我们认识到,在由用户监控的智能体轨迹中,间歇性地更新模型正在用工具调用做什么以及为什么这样做,可以提供更好的交互式用户体验——轨迹越长,这些更新带来的差异就越大。为此,GPT-5 被训练为通过“工具前导”消息提供清晰的前期计划和持续的进度更新。
+我们注意到,在由用户监控的智能体轨迹中,模型间歇性地更新它正在调用哪些工具以及为何调用的信息,可以带来更好的交互式用户体验——rollout 越长,这些更新带来的差异就越明显。为此,GPT-5 经过训练,会通过“工具序言”消息提供清晰的前置计划和一致的进度更新。
-你可以在提示中控制工具前导的频率、风格和内容——从对每次工具调用的详细解释到简短的前期计划以及介于两者之间的一切。以下是一个高质量前导提示的示例:
+你可以在 prompt 中引导工具序言的频率、风格和内容——从对每一次工具调用的详细解释,到简短的前置计划,以及介于两者之间的任何形式。下面是一个高质量序言 prompt 的示例:
```text
@@ -117,7 +117,7 @@ Loop:
```
-以下是一个响应此类提示可能发出的工具前导示例——随着工作变得更加复杂,此类前导可以极大地提高用户跟随你的智能体工作的能力:
+下面是一个针对上述 prompt 可能生成的工具序言示例——随着智能体的工作变得更加复杂,这类序言可以显著提升用户跟随其工作进度的能力:
```text
"output": [
@@ -153,23 +153,23 @@ Loop:
],
```
-#### 推理努力
+#### Reasoning effort
-我们提供一个 `reasoning_effort` 参数来控制模型思考的深度以及其调用工具的意愿;默认值为 `medium`,但你可以根据任务的难度进行适当调整。对于复杂、多步骤的任务,我们建议使用更高的推理能力以确保最佳输出。此外,我们观察到,将不同的、可分离的任务拆分为多个 智能体 轮次,每轮处理一个任务时,性能达到峰值。
+我们提供了一个 `reasoning_effort` 参数来控制模型思考的强度以及调用工具的意愿;默认值为 `medium`,你可以根据任务难度上调或下调该值。对于复杂的多步骤任务,我们建议使用更高的推理深度,以确保获得尽可能好的输出。此外,我们观察到当将不同的、可分离的任务拆分到多个 智能体 轮次中(每个任务一轮)时,性能达到峰值。
-#### 使用 Responses API 复用推理上下文
+#### 复用 Responses API 的推理上下文
-我们强烈建议在使用 GPT-5 时采用 Responses API,以在你的应用中解锁改进的智能体流程、更低的成本和更高效的令牌使用。
+我们强烈建议在使用 GPT-5 时使用 Responses API,以解锁更优的智能体流程、更低的成本以及更高效的令牌使用。
-我们看到,在使用 Responses API 而非 Chat Completions 时,评估结果在统计上显著改善——例如,仅通过切换到 Responses API,我们观察到 Tau-Bench Retail 分数从 73.9% 提升至 78.2%,并且包括 `previous_response_id` 将先前的推理项目传回后续请求。这使得模型能够参考其先前的推理轨迹,节省 CoT 令牌,并在每次工具调用后无需从头重建计划,从而改善延迟和性能——该功能对所有 Responses API 用户开放,包括 ZDR 组织。
+我们在评估中观察到,使用 Responses API 相较于 Chat Completions 有统计上显著的提升——例如,仅通过切换到 Responses API 并传入 `previous_response_id` 以将先前的推理项传回后续请求。这使模型能够参考其先前的推理追踪,从而节省 CoT 令牌,并免去每次工具调用后重新构建计划的需要,从而同时改善延迟和性能——该功能对所有 Responses API 用户可用,包括 ZDR 组织。
-### 提升编码性能:从规划到执行
+### 最大化编码性能,从规划到执行
-GPT-5 在编程能力上领先所有前沿模型:它可以在大型代码库中工作以修复错误、处理大型差异,并实现多文件重构或大型新功能。它还擅长完全从零开始实现新应用,涵盖前端和后端实现。在本节中,我们将讨论我们在生产环境中为编程智能体客户所观察到的、能提升编程性能的提示优化。
+GPT-5 在所有前沿模型的编程能力中处于领先地位:它能在大型代码库中修复 bug、处理大型 diff,并实现多文件重构或大型新功能。它还擅长从零开始完整实现新应用,覆盖前端和后端实现。在本节中,我们将讨论我们在编程 智能体 客户的实际用例中已验证可提升编程性能的提示优化方法。
#### 前端应用开发
-GPT-5 经过训练,具备出色的基线审美品味和严谨的实现能力。我们相信它能够使用各类 Web 开发框架和包;然而,对于新应用,我们建议使用以下框架和包,以充分发挥模型的前端能力:
+GPT-5 经过训练,在具备严谨实现能力的同时,也拥有出色的基线审美品味。我们对其使用各类 Web 开发框架和包的能力充满信心;不过,对于新应用,我们建议使用以下框架和包,以充分发挥该模型的前端能力:
- 框架:Next.js (TypeScript)、React、HTML
- 样式 / UI:Tailwind CSS、shadcn/ui、Radix Themes
@@ -179,7 +179,7 @@ GPT-5 经过训练,具备出色的基线审美品味和严谨的实现能力
##### 从零到一的应用生成
-GPT-5 擅长一次性构建应用程序。在该模型的早期实验中,用户发现类似于下面的提示——要求模型根据自建的卓越评分标准进行迭代执行——可以通过利用 GPT-5 的周密规划和自我反思能力来提高输出质量。
+GPT-5 擅长一次性构建应用。在对该模型的早期实验中,用户发现类似下面这样的提示——要求模型根据其自行构建的优秀标准反复执行——能够借助 GPT-5 全面的规划和自我反思能力来提升输出质量。
```text
@@ -189,9 +189,9 @@ GPT-5 擅长一次性构建应用程序。在该模型的早期实验中,用
```
-##### 匹配代码库设计标准
+##### 匹配代码库设计规范
-在现有应用中实施增量更改和重构时,模型编写的代码应遵循已有的样式和设计标准,并尽可能自然地“融入”代码库。无需特别提示,GPT-5 已会从代码库中搜索参考上下文——例如读取 package.json 以查看已安装的包——但通过提示词指导来总结代码库的关键方面(如工程原则、目录结构以及显式和隐式的最佳实践),可以进一步增强该行为。下面的提示词片段展示了为 GPT-5 组织代码编辑规则的一种方式:你可以根据自身的编程设计偏好随意更改规则的实际内容!
+在现有应用中实现增量变更和重构时,模型编写的代码应当遵循现有的代码风格与设计规范,并尽可能“融入”到代码库中。在没有特殊提示的情况下,GPT-5 已经会主动从代码库中搜索参考上下文——例如读取 package.json 来查看已安装的依赖包——但你可以通过提示指令进一步增强这种行为,例如在提示中总结代码库的关键要点,包括显式和隐式的工程原则、目录结构以及最佳实践。下面的提示片段演示了一种为 GPT-5 组织代码编辑规则的方式:你可以根据自己的编程设计偏好随意修改规则的实际内容!
```text
@@ -235,29 +235,29 @@ GPT-5 擅长一次性构建应用程序。在该模型的早期实验中,用
```
-#### 生产环境中的协作编码:Cursor 的 GPT-5 提示词调优
+#### 生产环境中的协作编码:Cursor 对 GPT-5 的提示调优
-我们很自豪能够让 AI 代码编辑器 Cursor 成为 GPT-5 的可信赖 alpha 测试者:下面,我们将展示 Cursor 如何调整他们的提示词,以充分利用该模型的能力。更多信息,他们的团队还发布了一篇博客文章,详细介绍了 GPT-5 在 Cursor 中的首日集成: https://cursor.com/blog/gpt-5
+我们非常高兴 AI 代码编辑器 Cursor 担任了 GPT-5 的可信 alpha 测试用户:下面,我们将展示 Cursor 如何调整提示词以充分发挥该模型能力的一瞥。此外,他们的团队还发布了一篇博客文章,详细介绍了 GPT-5 在 Cursor 中的首发集成: https://cursor.com/blog/gpt-5
-##### 系统提示词与参数调优
+##### 系统提示与参数调优
-Cursor的系统提示词侧重于可靠的工具调用,在冗长与自主行为之间取得平衡,同时让用户能够配置自定义指令。Cursor为其系统提示词设定的目标是让智能体在长周期任务中相对自主地运行,同时仍忠实遵循用户提供的指令。
+Cursor 的系统提示专注于可靠的工具调用,在冗长度和自主行为之间取得平衡,同时让用户能够配置自定义指令。Cursor 对其系统提示的目标是允许智能体在长时间跨度任务中相对自主地运行,同时仍然忠实地遵循用户提供的指令。
-该团队最初发现模型会产生冗长的输出,常常包含状态更新和任务后总结,这些内容虽然在技术上是相关的,却干扰了用户的自然流程;同时,工具调用中输出的代码质量很高,但由于过于简洁而有时难以阅读,单字母变量名居多。为了寻求更好的平衡,他们将API的冗长参数设为低,以保持文本输出的简洁,然后修改了提示词,仅在编码工具中强烈鼓励详细输出。
+团队最初发现模型会产生冗长的输出,经常包含状态更新和任务后摘要,虽然在技术上相关,但打乱了与用户的自然流程;与此同时,工具调用中输出的代码质量很高,但有时由于过于简略而难以阅读,单字母变量名占主导。为了寻找更好的平衡,他们将 verbosity API 参数设置为 low 以保持文本输出简洁,然后修改提示以强烈鼓励仅在编码工具中产生详细输出。
```text
Write code for clarity first. Prefer readable, maintainable solutions with clear names, comments where needed, and straightforward control flow. Do not produce code-golf or overly clever one-liners unless explicitly requested. Use high verbosity for writing code and code tools.
```
-这种参数与提示词的双重使用实现了均衡的格式,将高效简洁的状态更新和最终工作总结与更易读的代码差异结合起来。
+这种参数与提示的双重使用产生了一种平衡的格式,将高效简洁的状态更新和最终工作总结与更易读的代码 diff 结合起来。
-Cursor还发现,模型在采取行动前偶尔会向用户寻求澄清或确认下一步,这给较长任务的流程带来了不必要的阻碍。为了解决这个问题,他们发现不仅在提示词中包含可用工具和周围上下文,还加入更多关于产品行为的细节,能够鼓励模型以最少的打断和更大的自主性来执行较长的任务。突出Cursor功能的具体细节,如撤销/拒绝代码和用户偏好,通过明确指定GPT-5在其环境中应如何表现来帮助减少歧义。对于更长周期的任务,他们发现这个提示词提升了性能:
+Cursor 还发现,模型偶尔会在采取行动前向用户寻求澄清或下一步指示,这在较长任务流程中造成了不必要的摩擦。为了解决这个问题,他们发现不仅包含可用工具和周围上下文,还包括更多关于产品行为的细节,鼓励模型在最少中断和更高自主性的情况下执行更长的任务。突出 Cursor 功能的具体细节,例如 Undo/Reject 代码和用户偏好,有助于通过明确规定 GPT-5 在其环境中应如何行为来减少歧义。对于较长跨度的任务,他们发现该提示提升了性能:
```text
Be aware that the code edits you make will be displayed to the user as proposed changes, which means (a) your code edits can be quite proactive, as the user can always reject, and (b) your code should be well-written and easy to quickly review (e.g., appropriate variable names instead of single letters). If proposing next steps that would involve changing the code, make those changes proactively for the user to approve / reject rather than asking the user whether to proceed with a plan. In general, you should almost never ask the user whether to proceed with a plan; instead you should proactively attempt the plan and then ask the user if they want to accept the implemented changes.
```
-Cursor发现,他们的提示词中那些对早期模型有效的部分,需要进行调整才能充分发挥GPT-5的性能。以下是其中一个示例:
+Cursor 发现,他们提示中原本对早期模型有效的部分需要进行调整才能充分发挥 GPT-5 的潜力。下面是一个示例:
```text
@@ -266,9 +266,9 @@ Be THOROUGH when gathering information. Make sure you have the FULL picture befo
```
-虽然这在那些需要鼓励才能深入分析上下文的旧模型上效果不错,但他们发现这对GPT-5适得其反,因为GPT-5本身就已天然具备内省性和主动收集上下文的能力。在较小的任务上,这个提示词常常导致模型过度使用工具,反复调用搜索,而其实内部知识本已足够。
+虽然这对需要鼓励以彻底分析上下文的较老模型效果良好,但他们发现这在 GPT-5 上适得其反,因为 GPT-5 本来就具有内省和主动收集上下文的特性。在较小的任务上,此提示经常导致模型过度使用工具,反复调用搜索,而其内部知识本已足够。
-为了解决这个问题,他们精炼了提示词,移除了maximize\_ 前缀,并软化了关于彻底性的措辞。有了这一调整后的指令,Cursor团队看到GPT-5在何时依赖内部知识、何时调用外部工具方面做出了更好的决策。它保持了高度的自主性,同时没有不必要的工具使用,从而带来了更高效、更相关的行为。在Cursor的测试中,使用结构化的XML规范,如 `<[instruction]\_spec>` 改善了其提示词的指令遵循度,并使他们能够在提示词的其他部分明确引用之前的类别和章节。
+为了解决这个问题,他们通过移除 maximize\_ 前缀并软化围绕彻底性的措辞来优化提示。调整后的指令到位后,Cursor 团队看到 GPT-5 在何时依赖内部知识与何时使用外部工具之间做出了更好的决策。它在保持高度自主性的同时避免了不必要的工具使用,从而带来了更高效、更相关的行为。在 Cursor 的测试中,使用结构化 XML 规范(如 `<[instruction]\_spec>` )提升了其提示上的指令遵循性,并使他们能够在提示的其他位置清楚地引用先前的类别和章节。
```text
@@ -278,26 +278,26 @@ Bias towards not asking the user for help if you can find the answer yourself.
```
-虽然系统提示词提供了强大的默认基础,但用户提示词仍然是实现可控性的高效杠杆。GPT-5对直接明确的指令反应良好,Cursor团队也一贯观察到,结构化的、有针对性的提示词能产生最可靠的结果。这包括冗长控制、主观代码风格偏好和边界情况敏感性等领域。Cursor发现允许用户配置自己的 [自定义Cursor规则](https://docs.cursor.com/en/context/rules) 在GPT-5改进的可控性下尤其有效,为用户带来了更加个性化的体验。
+虽然系统提示提供了强大的默认基础,但用户提示仍然是可操控性的高效杠杆。GPT-5 对直接且明确的指令响应良好,Cursor 团队始终观察到结构化、有范围的提示能产生最可靠的结果。这包括冗长度控制、主观代码风格偏好以及对边缘情况的敏感性等方面。Cursor 发现允许用户配置自己的 [自定义 Cursor 规则](https://docs.cursor.com/en/context/rules) 对 GPT-5 改进的可操控性特别有效,为其用户带来了更个性化的体验。
-### 优化智能与指令遵循
+### 优化智能与指令遵循能力
#### 引导
-作为我们迄今最可操控的模型,GPT-5 对围绕详细程度、语气和工具调用行为的提示指令具有非凡的接受度。
+作为目前可控性最强的模型,GPT-5 能够出色地遵循有关冗长度、语气和工具调用行为的提示指令。
-##### 详细程度
+##### Verbosity
-除了像之前的推理模型那样能够控制 reasoning_effort 之外,在 GPT-5 中我们引入了一个新的 API 参数,名为 verbosity,它影响模型最终答案的长度,而非其思考的长度。我们的博客文章更详细地介绍了这一参数背后的理念——但在本指南中,我们想强调,虽然 API verbosity 参数是本次发布的默认设置,但 GPT-5 经过训练,能够在特定上下文中响应提示中的自然语言详细程度覆盖指令,以便在你希望模型偏离全局默认设置时使用。上面 Cursor 的例子——全局设置低详细程度,然后仅为编码工具指定高详细程度——正是此类上下文的典型示例。
+除了可以像在之前的推理模型中那样控制 reasoning_effort 之外,在 GPT-5 中我们引入了一个新的 API 参数 verbosity,它影响模型最终回答的长度,而不是其思考过程的长度。我们的博客文章更详细地介绍了该参数背后的理念——但在本指南中,我们想强调的是,虽然 API verbosity 参数是发布时的默认设置,但 GPT-5 经过训练,能够在特定上下文中响应提示中的自然语言 verbosity 覆盖,以适应你希望模型偏离全局默认设置的场景。上面 Cursor 展示的全局设置低 verbosity、然后仅为编码工具指定高 verbosity 的例子,就是这种场景的典型代表。
#### 指令遵循
-与 GPT-4.1 一样,GPT-5 会以手术般的精确度遵循提示指令,这使其能够灵活地融入各种类型的工作流。然而,其谨慎的指令遵循行为意味着,包含矛盾或模糊指令的构造不当的提示对 GPT-5 的损害可能大于对其他模型,因为它会耗费推理令牌来寻找调和矛盾的方法,而不是随机选择一条指令。
+与 GPT-4.1 一样,GPT-5 能够精准地遵循提示指令,这使它能够灵活地应用于各种工作流。然而,这种谨慎的指令遵循行为意味着,与其他模型相比,包含矛盾或模糊指令的劣质提示对 GPT-5 的损害可能更大,因为它会耗费推理 token 来寻找调和矛盾的方式,而不是随机选择其中一条指令。
-下面,我们给出一个常会损害 GPT-5 推理追踪的对抗性提示示例——虽然乍看之下它可能显得内部一致,但仔细检查会发现关于预约排期的指令存在冲突:
+下面给出一个对抗性示例,展示了常常损害 GPT-5 推理追踪的提示类型 —— 虽然乍看之下它在内部似乎是一致的,但仔细检查会发现其中包含了关于预约时间安排的相互冲突的指令:
- `Never schedule an appointment without explicit patient consent recorded in the chart` 与后续内容冲突 `auto-assign the earliest same-day slot without contacting the patient as the first action to reduce risk.`
-- 提示词中说 `Always look up the patient profile before taking any other actions to ensure they are an existing patient.` 但随后又给出矛盾指令 `When symptoms indicate high urgency, escalate as EMERGENCY and direct the patient to call 911 immediately before any scheduling step.`
+- 提示词中说 `Always look up the patient profile before taking any other actions to ensure they are an existing patient.` 但随后又给出了与之矛盾的指令 `When symptoms indicate high urgency, escalate as EMERGENCY and direct the patient to call 911 immediately before any scheduling step.`
```text
You are CareFlow Assistant, a virtual admin for a healthcare startup that schedules patients based on priority and symptoms. Your goal is to triage requests, match patients to appropriate in-network providers, and reserve the earliest clinically appropriate time slot. Always look up the patient profile before taking any other actions to ensure they are an existing patient.
@@ -313,23 +313,23 @@ You are CareFlow Assistant, a virtual admin for a healthcare startup that schedu
- For high-acuity Red and Orange cases, auto-assign the earliest same-day slot *after informing* the patient *of your actions.* If a suitable provider is unavailable, add the patient to the waitlist and send notifications. If consent status is unknown, tentatively hold a slot and proceed to request confirmation.
```
-通过解决指令层级冲突,GPT-5 能够实现更高效、更出色的推理。我们通过以下方式修复了这些矛盾:
+通过解决指令层级冲突,GPT-5 能够激发更高效且性能更优的推理。我们通过以下方式消除了这些矛盾:
-- 将自动分配改为在联系患者后进行,在告知患者你的操作后,自动安排当天最早的时段,以与仅在获得同意后才进行安排保持一致。
-- 添加“在紧急情况下不进行查询,立即提供 911 指导”的内容,让模型知道在紧急情况下可以不进行查询。
+- 将自动分配改为在与患者联系后再进行,在告知患者你的操作后,自动分配当天最早的可预约时段,以保持仅在获得同意后才安排预约。
+- 添加 在紧急情况下不要进行查询,直接提供 911 指导。 以让模型知道在紧急情况下可以不进行查询。
-我们理解构建提示词的过程是迭代式的,许多提示词是不同利益相关者不断更新的活文档——但这更有理由彻底审查它们,以发现措辞不当的指令。我们已经看到多位早期用户在进行此类审查后,发现了核心提示词库中的歧义和矛盾:消除这些歧义和矛盾显著简化并提升了他们的 GPT-5 性能。我们建议使用我们的 [提示词优化器工具](https://platform.openai.com/chat/edit?optimize=true) 来帮助识别这些类型的问题。
+我们理解构建提示词的过程是一个迭代过程,许多提示词是不断被不同利益相关方更新的动态文档——但这恰恰是我们更应该彻底审查其中措辞不当的指令的原因。我们已经看到,多位早期用户在开展此类审查时发现了其核心提示词库中存在的歧义与矛盾:移除这些问题后,他们的 GPT-5 性能得到了显著优化和提升。我们建议你使用我们的 [提示优化工具](https://platform.openai.com/chat/edit?optimize=true) 来帮助发现这类问题。
#### 最小推理
-在 GPT-5 中,我们首次引入了极简推理力度:这是我们最快的选项,同时仍能享受推理模型范式带来的优势。我们认为这是对延迟敏感用户以及当前 GPT-4.1 用户的最佳升级。
+在 GPT-5 中,我们首次引入了 minimal reasoning effort:这是我们最快的选项,同时仍能受益于推理模型范式。我们认为这是对延迟敏感的用户以及当前 GPT-4.1 用户的最佳升级。
-也许不足为奇,我们建议采用与 [GPT-4.1 类似的提示模式以获得最佳效果](https://developers.openai.com/cookbook/examples/gpt4-1_prompting_guide)。与更高推理级别相比,极简推理的性能可能因提示而异,因此需要强调的关键点包括:
+也许并不意外,我们建议使用与 [GPT-4.1 相似的提示模式以获得最佳效果](https://developers.openai.com/cookbook/examples/gpt4-1_prompting_guide). minimal reasoning 的性能可能因提示而异,且变化幅度高于更高的推理级别,因此需要强调的关键点包括:
-1. 在最终回答的开头提示模型给出简要说明,总结其思考过程,例如通过项目符号列表,可提升需要更高智能的任务的性能。
-2. 要求提供详尽且描述性的工具调用前言,持续向用户更新任务进度,可提升智能体工作流中的性能。
-3. 尽可能消除工具说明中的歧义,并如上所述插入智能体持久性提醒,在最低推理级别下尤为关键,以在长时间运行的 rollout 中最大化智能体能力并防止过早终止。
-4. 提示性规划同样更为重要,因为模型可用的推理 token 更少,无法进行内部规划。下面,你可以找到一个我们放在智能体任务开头的示例规划提示片段:第二段尤其确保智能体在交还给用户之前完整完成任务及所有子任务。
+1. 在最终答案开头提示模型先给出一段简要说明来概括其思路(例如使用项目符号列表),能够提升在需要更高智能的任务上的表现。
+2. 要求提供详尽且具有描述性的工具调用前言,持续向用户更新任务进度,能够提升在智能体工作流中的表现。
+3. 尽可能消除工具指令的歧义,并按上文所述插入智能体持久性提醒,这在最小推理时尤为关键,可以在长时间运行中最大化智能体的能力并防止提前终止。
+4. 提示性规划同样更为重要,因为模型用于内部规划的推理 token 较少。以下给出一段示例性的规划提示片段,我们将其放在智能体任务的开头:尤其是第二段,能够确保 智能体 在交还控制权给用户之前完整完成任务及其所有子任务。
```text
Remember, you are an agent - please keep going until the user's query is completely resolved, before ending your turn and yielding back to the user. Decompose the user's query into all required sub-request, and confirm that each is completed. Do not stop after completing only part of the request. Only terminate your turn when you are sure that the problem is solved. You must be prepared to answer multiple queries and only finish the call once the user has confirmed they're done.
@@ -339,20 +339,20 @@ You must plan extensively in accordance with the workflow steps before making su
#### Markdown 格式
-默认情况下,GPT-5 在 API 中不会以 Markdown 格式输出最终答案,以最大限度地保持与可能不支持 Markdown 渲染的开发者应用的兼容性。然而,类似以下的提示词在很大程度上能成功诱导生成层级化的 Markdown 最终答案。
+默认情况下,GPT-5 在 API 中不会将其最终答案格式化为 Markdown,以便最大程度地兼容那些应用可能不支持 Markdown 渲染的开发者。不过,像下面这样的提示通常能较为成功地诱导出具有层级结构的 Markdown 最终答案。
````text
- Use Markdown **only where semantically correct** (e.g., `inline code`, ```code fences```, lists, tables).
- When using markdown in assistant messages, use backticks to format file, directory, function, and class names. Use \( and \) for inline math, \[ and \] for block math.
````
-偶尔,在长对话过程中,对系统提示词中指定的 Markdown 指令的遵循可能会下降。如果你遇到这种情况,我们观察到每 3-5 条用户消息后追加一条 Markdown 指令可以保持一致的遵循。
+偶尔,对系统提示中指定的 Markdown 指令的遵循程度会在较长对话过程中逐渐下降。如果你遇到这种情况,我们观察到一种稳定有效的做法:每隔 3-5 条用户消息就附加一次 Markdown 指令。
-#### 元提示词
+#### Metaprompting
-最后,作为元层面的收尾,早期测试者发现,使用 GPT-5 作为自身的元提示器已取得很大成功。已有数位用户将提示词修订版本部署到生产环境,这些修订仅通过询问 GPT-5 即可生成,询问内容包括:为未能成功的提示词添加哪些元素以引出所需行为,或移除哪些元素以防止不必要的行为。
+最后,从元层面补充一点:早期测试者发现,将 GPT-5 用作自身的元提示器效果很好。已经有一些用户将提示词修订部署到了生产环境,这些修订只需通过询问 GPT-5“为了引发期望行为,可以向一条不成功的提示中添加哪些元素;为了避免不期望的行为,又可以移除哪些元素”即可生成。
-以下是我们喜欢的元提示模板示例:
+下面是我们喜欢的一个元提示模板示例:
```text
When asked to optimize prompts, give answers from your own perspective - explain what specific phrases could be added to, or deleted from, this prompt to more consistently elicit the desired behavior or prevent the undesired behavior.
@@ -364,7 +364,7 @@ The desired behavior from this prompt is for the agent to [DO DESIRED BEHAVIOR],
### 附录
-#### SWE-Bench 已验证的开发者说明
+#### SWE-Bench Verified 开发者说明
```text
In this environment, you can run `bash -lc ` to execute a diff/patch against a file, where is a specially formatted apply patch command representing the diff you wish to execute. A valid looks like:
@@ -425,7 +425,7 @@ wait_ms?: number, // default: 100
}) => any;
```
-如 GPT-4.1 提示指南中所述,所链接的 [`apply_patch` 实现](https://github.com/openai/openai-cookbook/tree/main/examples/gpt-5/apply_patch.py) 旨在匹配模型的训练分布。我们强烈建议使用 `apply_patch` 进行文件编辑。
+正如 GPT-4.1 提示指南中所分享的,所链接的 [`apply_patch` 实现](https://github.com/openai/openai-cookbook/tree/main/examples/gpt-5/apply_patch.py) 旨在匹配模型的训练分布。我们强烈推荐使用 `apply_patch` 进行文件编辑。
#### Taubench-Retail 最小推理说明
diff --git a/docs/zh/api/docs/guides/responses-multi-agent.md b/docs/zh/api/docs/guides/responses-multi-agent.md
index 1a103f9..d1cd635 100644
--- a/docs/zh/api/docs/guides/responses-multi-agent.md
+++ b/docs/zh/api/docs/guides/responses-multi-agent.md
@@ -1,48 +1,48 @@
# 多智能体
-> 完整文档索引请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。
+> 完整文档索引请参阅 [llms.txt](/llms.txt). 你可以在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
## 概述
-多智能体让模型能够并行启动并协调子智能体,综合它们的工作以提供最终响应。这对于包含复杂任务、受益于并行工作委派的应用尤为有效,例如代码库探索、文档编写和实现。
+Multi-智能体 允许模型并行启动并协调子智能体,综合它们的工作以给出最终响应。对于涉及代码库探索、文档编写和实现等需要并行任务委派的复杂任务应用,这一机制尤其有效。
-多智能体作为一项测试版功能,适用于所有 GPT-5.6 模型。在应用中启用多智能体之前,请查看模型页面。
+Multi-智能体 作为一项测试版功能,在所有 GPT-5.6 模型中均可使用。在你的应用中启用 Multi-智能体 之前,请查看模型页面。
## 何时使用多智能体
-任务通常可以划分为多个独立的工作部分,单个智能体会按顺序完成这些部分,但多个智能体能够并行处理这些部分。多智能体使根智能体能够将任务委托给多个并发完成工作的子智能体。这可以带来多种好处:
+任务通常可以划分为独立的工作模块,这些模块由单个智能体依次完成,但多个智能体能够并行处理。多智能体架构允许一个根智能体将任务委派给多个并发工作的子智能体。这可以带来多重优势:
- **并行执行。** 独立的研究、分析或实现任务可以同时进行,从而加快执行速度。
-- **聚焦的上下文。** 每个子智能体接收一个有界的任务并维护其自身的上下文,这减少了无关工作线之间上下文的干扰,并提高了性能。
-- **模型导向的协调。** 根智能体可以创建子智能体,向它们发送附加信息,等待结果,并综合出最终答案,而无需你的应用实现编排。
+- **聚焦的上下文。** 每个子智能体接收一个有界的任务并维护自己的上下文,这可以减少不相关工作线之间的上下文干扰并提升性能。
+- **模型主导的协调。** 根智能体可以创建子智能体、向它们发送额外信息、等待结果并综合出最终答案,而无需你的应用来实现编排逻辑。
-多智能体编排在任务可以划分为具体且独立的工作流时最为有用,例如:
+多智能体编排最适用于任务可以被划分为具体的、相互独立的工作流的场景,例如:
-- 探索大型代码库的独立部分
-- 比较多个提案、文档或假设
+- 并行探索大型代码库的不同部分
+- 并行比较多个方案、文档或假设
- 并行研究多个来源
-- 实现独立组件或编写独立测试套件
-- 并行调查失败的不同可能原因
-- 同时探索问题的不同解决方案
+- 并行实现独立组件或编写独立的测试套件
+- 并行调查失败可能的不同原因
+- 并行探索解决同一问题的不同方法
-请注意,添加子智能体可能会增加 token 使用量,并且对于依赖单一有序推理链、需要频繁写入共享可变状态或已被一个缓慢的外部操作主导的任务,可能不会有太大帮助。
+请注意,添加子智能体会增加 token 使用量,并且对于依赖单一有序推理链、需要频繁写入共享可变状态,或者已经由某个较慢的外部操作主导的任务,可能并不会带来明显收益。
-| 当以下情况时使用多智能体 | 当以下情况时优先使用单智能体 |
+| 在以下情况下使用多智能体 | 在以下情况下优先使用单个智能体 |
| ------------------------------------------------- | ----------------------------------------------------- |
-| 工作可以拆分为独立、有界任务 | 每一步直接依赖上一步 |
-| 独立的上下文有助于提升专注度 | 任务足够小,可在一次简短运行中完成 |
-| 并行探索可减少实际耗时 | 智能体会对同一可变资源产生竞争 |
-| 比较独立发现可提高覆盖率 | 你需要固定的、确定性的执行图 |
+| 工作可以拆分为有界限的独立任务 | 每个步骤都直接依赖前一步骤 |
+| 分离上下文有助于提升专注度 | 任务足够小,可以在一次短运行内完成 |
+| 并行探索可以缩短挂钟时间 | 多个智能体 会争抢同一可变资源 |
+| 比较独立得出的发现可以提升覆盖度 | 你需要固定且确定性的执行图 |
-## 快速开始
+## 快速入门
-Python 和 JavaScript 示例使用 beta Responses SDK。对于 HTTP
- 请求,请使用 `client.beta.responses` 并传递 `responses_multi_agent=v1` 作为
- 该 `betas` 参数。对于原始 HTTP 请求和 WebSocket 连接,请传递
- `OpenAI-Beta: responses_multi_agent=v1` 在请求或连接标头中。
- 项目模式可能在 Multi-智能体 处于测试阶段时发生变化。
+Python 和 JavaScript 示例使用 beta 版 Responses SDK。对于 HTTP
+ 请求,请使用 `client.beta.responses` 并传入 `responses_multi_agent=v1` 参数。对于原始 HTTP 请求和 WebSocket 连接,请在请求或连接头中传入
+ 该 `betas` 。
+ `OpenAI-Beta: responses_multi_agent=v1` 。
+ Multi-智能体 处于 beta 阶段时,条目 schema 可能会发生变化。
-在 Responses API 请求中启用 Multi-智能体,通过 `multi_agent.enabled`。当 `multi_agent.enabled` 为 `true`,时,根 智能体 可以生成子智能体树。子智能体共享请求的模型和可用工具,而 智能体 通过协作原语(如生成、消息传递和等待)进行协调(参见 [Multi-智能体 的工作原理](#how-multi-agent-works))。根 智能体 负责综合子智能体的响应并提供最终响应。
+在 Responses API 请求中通过 `multi_agent.enabled`。启用 Multi-智能体。当 `multi_agent.enabled` 为 `true`,时,根 智能体 就可以生成一个子智能体树。子智能体共享请求的模型和可用工具,而 智能体 通过生成、消息传递和等待等协作原语进行协作(参见 [Multi-智能体 的工作原理](#how-multi-agent-works))。根 智能体 负责综合子智能体的响应并提供最终响应。
使用子智能体审查拉取请求
@@ -119,20 +119,20 @@ def review_pull_request(diff: str) -> str:
```
-`max_concurrent_subagents` 设置在整个 智能体 树中可以同时活跃的子智能体最大数量。它包含所有后代——子级、孙级和更深的子智能体——但不包括根 智能体。
+`max_concurrent_subagents` 设置整个 智能体 树中可同时处于活动状态的子智能体数量的上限。它包括所有后代——子级、孙级以及更深层级的子智能体——但不包括根 智能体。
-API 对此设置没有固定上限。默认值为 `3`,这对大多数工作负载来说是推荐的。Multi-智能体 运行对树深度或一次运行中创建的子智能体总数也没有固定限制。
+API 对此设置没有固定的硬性上限。默认值为 `3`,建议大多数工作负载使用此值。Multi-智能体 运行对树深度或单次运行中创建的子智能体总数也没有固定限制。
-添加开发者消息以调整根模型何时应生成子智能体。此开发者消息是对根 智能体 和子智能体注入的说明的补充。
+添加开发者消息以调整根模型何时应生成子智能体。此开发者消息是对为根 智能体 和子智能体注入的指令的补充。
-开发者消息的示例包括:
+开发者消息示例包括:
-- “除非用户明确要求子智能体、委派或并行智能体工作,否则不要生成子智能体。”
-- “主动多智能体委派已启用。当并行工作能显著提升速度或质量时,使用子智能体。”
+- "除非用户明确要求使用子智能体、委派或并行智能体工作,否则不要派生子智能体。"
+- "主动的多智能体委派已启用。当并行工作能够显著提升速度或质量时,请使用子智能体。"
-## 多智能体如何运作
+## 多智能体工作原理
-Responses API 为根智能体和子智能体提供托管编排操作及使用说明。根智能体被命名为 `/root`。生成的子智能体使用层级路径,例如:
+Responses API 为根智能体和子智能体模型提供托管编排操作及相关使用说明。根智能体命名为 `/root`。生成的子智能体使用如下层级路径:
```text
/root
@@ -141,50 +141,50 @@ Responses API 为根智能体和子智能体提供托管编排操作及使用说
└── /root/reviewer/tester
```
-多智能体模式对子智能体的总数或树深度没有固定限制。对于大多数任务,使用默认的 `max_concurrent_subagents` 值 `3`。此设置限制整个树中活跃子智能体轮次的数量,包括子节点和更深层的后代。
+多智能体对子智能体总数或树的深度不设固定上限。对于大多数任务,使用默认的 `max_concurrent_subagents` 值 `3`。该设置会限制整个树中(包括子级及更深的后代)的活动子智能体轮次数。
-启用多智能体模式时,Responses API提供六个托管协作操作。你可能会在 `multi_agent_call` 条目中看到这些操作。你的应用程序不应执行这些操作或为其提交输出结果。
+启用多智能体模式后,Responses API 提供六项托管协作操作。你可能会看到这些操作以 `multi_agent_call` 项的形式出现。你的应用程序不应执行这些操作,也无需为其提交输出。
-| 操作 | 用途 |
+| Action | Purpose |
| ----------------- | ------------------------------------------------------------------------------ |
-| `spawn_agent` | 创建子智能体并分配其初始任务。 |
-| `send_message` | 为现有智能体排队消息,且不启动新的回合。 |
-| `followup_task` | 为现有非根智能体分配更多工作,并启动或恢复其回合。 |
-| `wait_agent` | 等待调用智能体邮箱中的更新。 |
-| `interrupt_agent` | 中断另一个智能体的活动回合而不删除其上下文。 |
+| `spawn_agent` | 创建一个子智能体并为其分配初始任务。 |
+| `send_message` | 为现有智能体排入一条消息,但不开启新一轮。 |
+| `followup_task` | 为现有非根智能体分配更多工作,并开始或继续其新一轮。 |
+| `wait_agent` | 等待调用方智能体邮箱中的更新。 |
+| `interrupt_agent` | 中断另一个智能体正在进行的轮次,但不删除其上下文。 |
| `list_agents` | 返回当前智能体树、状态以及每个智能体的 `last_task_message`. |
-处理开发者定义的工具调用的方式与未启用 Multi-智能体 时相同。树中的任何 智能体 都可能发出 `function_call`。你的应用必须执行该调用并提交匹配的 `function_call_output`.
+处理开发者自定义的工具调用的方式与未启用 Multi-智能体 时相同。树中的任何 智能体 都可以发出 `function_call`。你的应用程序必须执行该调用,并提交一个匹配的 `function_call_output`.
请注意,树中的所有 智能体 都可以访问 API 请求的模型调用中配置的工具。
-## 在 Responses API 中使用多智能体
+## 在 Responses API 中使用多 智能体
-### HTTP 与 WebSocket 性能
+### HTTP 与 WebSocket 性能对比
-HTTP 和 WebSocket 支持相同的多智能体能力,但对于工具密集型或长时间运行的工作流,推荐使用 WebSocket。其持久连接使你的应用程序能够及时返回函数输出,从而减少延续开销,并让智能体减少等待时间。
+HTTP 和 WebSocket 支持相同的 Multi-智能体 能力,但对于工具密集型或长时间运行的智能体工作流,建议使用 WebSocket。其持久连接允许你的应用在函数输出可用时立即返回,从而减少延续开销,并让智能体花费更少的时间等待。
-使用 HTTP 时,当每个活动的智能体要么完成,要么暂停以等待客户端执行的函数调用时,响应即完成。然后,你的应用程序执行所有未完成的函数调用,并在新的Responses API请求中提交其输出,从而允许暂停的智能体继续执行。
+使用 HTTP 时,响应会在每个活跃智能体完成或暂停以等待客户端执行的函数调用后结束。然后你的应用会执行所有未完成的函数调用,并在新的Responses API请求中提交它们的输出,从而使暂停的智能体能够恢复。
-使用 WebSocket 时,你的应用程序可以在每个函数输出可用时立即将其注入响应中,而无需等待当前响应完成。等待中的智能体可以立即恢复,同时其他智能体继续工作。这减少了协调延迟,并在智能体完成或请求工具的时间不同步时避免了额外的请求往返。
+使用 WebSocket 时,你的应用可以在函数输出可用时立即将其注入响应,无需等待当前响应完成。处于等待中的智能体可以立即恢复,而其他智能体则继续工作。当智能体在不同时间完成或请求工具时,这能减少协调延迟并避免额外的请求往返。
-对于需要调用多个托管工具(如并行网页搜索)或函数调用较少的单请求工作流,HTTP 可能就足够了。对于大多数多智能体工作流,WebSocket 可能提供更低的延迟和更好的端到端性能。
+对于需要调用多个托管工具(例如并行网页搜索)的工作流,或函数调用较少的单请求工作流,HTTP 可能已经足够。但对于大多数 Multi-智能体工作流,WebSocket 更有可能提供更低的延迟和更好的端到端性能。
-#### HTTP 函数调用执行
+#### HTTP function call execution
-
+
#### WebSocket 函数调用执行
-
+
### HTTP
-这些示例需要公开测试版 SDK 构建,这些构建暴露了测试版 Responses API。对于 HTTP 流式传输,调用 `client.beta.responses.create` 并传递 `responses_multi_agent=v1` 以及 `betas` 参数;这将启用测试版类型和自动补全。在 Python 中,从 `openai.types.beta` 导入测试版响应条目类型,以添加类型注解。
+这些示例需要暴露 beta SDK 构建以及 beta Responses API。对于 HTTP 流式传输,调用 `client.beta.responses.create` 并传入 `responses_multi_agent=v1` 时附带 `betas` 参数;这会启用 beta 类型和自动补全。在 Python 中,从 `openai.types.beta` 导入 beta response item 类型用于添加类型注解。
客户端代码示例:
-处理 HTTP 流式工具调用
+处理 HTTP 流式传输工具调用
```javascript
import OpenAI from "openai";
@@ -421,11 +421,11 @@ while True:
```
-如果一个或多个智能体调用开发者定义的函数,执行每个挂起的调用,并创建一个包含其输出的延续请求。
+如果有一个或多个 智能体 调用开发者定义的函数,请执行所有待处理的调用,并创建一个包含其输出的 延续 请求。
### WebSocket
-在 WebSocket 模式下,当 智能体 调用开发者定义的函数时,在你的应用中执行该函数,并将结果通过 `response.inject` 事件发送到活动响应。等待中的 智能体 随后即可恢复,无需等待整个多 智能体 响应完成。
+在 WebSocket 模式下,当 智能体 调用开发者定义的函数时,在你的应用中执行该函数,并通过一个 `response.inject` 事件将其结果发送到当前响应中。处于等待状态的 智能体 随后可以继续执行,无需等待整个多 智能体 响应完成。
```json
{
@@ -441,10 +441,10 @@ while True:
}
```
-对于有效的 `response.inject` 请求,服务器会回复以下两种事件之一:
+对于一个有效的 `response.inject` 请求,服务器会回复以下两种事件之一:
-- `response.inject.created`:输入已通过验证并接受注入
-- `response.inject.failed`:输入未被注入;请检查 `error.code`
+- `response.inject.created`: 输入已通过校验并接受注入
+- `response.inject.failed`: 输入未被注入;请检查 `error.code`
```json
{
@@ -473,11 +473,11 @@ while True:
}
```
-如果请求不符合 `response.inject` schema,服务器会发送一个带有 status 的通用错误 `400` 并关闭 WebSocket 连接。修复请求并在发送另一个事件之前打开一个新的 WebSocket 连接。
+如果请求不符合 `response.inject` 模式,服务端会发送一个通用错误响应,状态码为 `400` ,并关闭 WebSocket 连接。请修正请求,然后开启一个新的 WebSocket 连接,再发送其他事件。
-Python beta SDK 通过以下方式暴露 WebSocket 模式 `client.beta.responses.connect`。TypeScript beta SDK 通过以下方式暴露它 `ResponsesWS`。传递 `OpenAI-Beta: responses_multi_agent=v1` 在连接头中;与 HTTP 流式传输不同,WebSocket 连接器尚不接受 `betas` 参数。
+Python 测试版 SDK 通过 `client.beta.responses.connect`。暴露 WebSocket 模式。TypeScript 测试版 SDK 通过 `ResponsesWS`。暴露该模式。在连接头中传入 `OpenAI-Beta: responses_multi_agent=v1` ;与 HTTP 流式响应不同,WebSocket 连接器目前还不接受 `betas` 参数。
-保存来自 `response.created` 事件的响应 ID,并将其包含在每次 `response.inject` 你为该响应发送的事件中。发送注入项后,继续从 WebSocket 读取,直到响应完成并且每个注入都已产生一个 `response.inject.created` 或 `response.inject.failed` 事件。
+从 `response.created` 事件中保存响应 ID,并在该响应的每个 `response.inject` 事件中包含该 ID。发送注入项后,继续从 WebSocket 读取,直到响应完成,并且每个注入项都已生成 `response.inject.created` 或 `response.inject.failed` 事件。
通过 WebSocket 注入工具输出
@@ -750,25 +750,25 @@ with client.beta.responses.connect(
发送 `response.inject` 事件后,继续从 WebSocket 读取并处理确认:
-- **`response.inject.created`**:函数输出已添加到当前响应中。继续读取该响应的事件。
-- **`response.inject.failed` with `response_already_completed`**:响应在函数输出能够被添加之前已完成。获取 `input` 在失败事件中返回的内容,并将其发送到新的 `response.create` 请求中,该请求从已完成的响应继续。
-- **`response.inject.failed` with `response_not_found`**:服务器无法找到由 `response_id`。标识的响应。确认你使用的是从 `response.created`.
+- **`response.inject.created`**: 函数输出已添加到当前响应中。请继续读取该响应的事件流。
+- **`response.inject.failed` 并附上 `response_already_completed`**: 响应在函数输出添加之前就已完成。请获取失败事件中 `input` 返回的 ID,并将其发送到一个新的 `response.create` 请求中,从已完成的响应继续执行。
+- **`response.inject.failed` 并附上 `response_not_found`**: 服务端无法找到由 `response_id`。指定的响应。请确认你使用的是从 `response.created`.
-单个Multi-智能体运行可能跨越多个Responses API请求。在HTTP中,当智能体调用开发人员定义的函数时,你的应用程序执行该函数并将输出提交到一个新的 `response.create` 调用中。通过WebSocket,你的应用程序则会将函数输出注入到活动响应中。
+单次 Multi-智能体 运行可能跨越多个 Responses API 请求。通过 HTTP,当 智能体 调用开发者定义的函数时,你的应用程序会执行该函数,并在新的 `response.create` 调用中提交其输出。通过 WebSocket 时,你的应用程序改为将该函数输出注入到当前进行中的 response 中。
-## 新的多智能体输出条目
+## 新的多智能体输出项
-多智能体响应可以包含三种额外的输出项类型:
+多智能体响应可以包含另外三种输出项类型:
-- `multi_agent_call`: 记录一个托管智能体动作,例如 `spawn_agent`.
-- `multi_agent_call_output`: 包含托管动作执行的结果。
-- `agent_message`: 携带从智能体到另一个智能体的加密消息。
+- `multi_agent_call`:记录一项托管的 Multi-智能体 操作,例如 `spawn_agent`.
+- `multi_agent_call_output`:包含某项托管操作的执行结果。
+- `agent_message`:携带从一个 智能体 到另一个智能体的加密消息。
-该 `call_id` 字段将每个 `multi_agent_call` 链接到其对应的 `multi_agent_call_output`.
+该 `call_id` field 字段将每个 `multi_agent_call` 链接到对应的 `multi_agent_call_output`.
-每个项还包括一个 `agent` 属性。对于 `agent_message`, `agent.agent_name` 标识接收方 智能体。使用 `author` 和 `recipient` 来 追踪 消息方向。
+每一项还包含一个 `agent` 属性。对于一个 `agent_message`, `agent.agent_name` 用于标识接收方 智能体。使用 `author` 和 `recipient` 来 追踪 消息方向。
-当你的应用接收到 `multi_agent_call`,时,请勿将其作为函数调用执行或返回结果。Responses API 会执行托管操作并返回相应的 `multi_agent_call_output`。如果你的应用需要用于重放或 追踪,请同时保留这两项。
+当你的应用程序收到一个 `multi_agent_call`,时,不要将其作为函数调用执行或回传结果。Responses API 会执行该托管动作并返回相应的 `multi_agent_call_output`。如果你的应用程序需要它们用于回放或 追踪,请同时保留这两项。
```json
[
@@ -811,7 +811,7 @@ with client.beta.responses.connect(
]
```
-智能体 归属的 SSE 事件包含一个顶层 `agent` 属性。对于 `agent_message` 事件, `agent.agent_name` 标识接收方 智能体。响应生命周期事件(如 `response.created` 和 `response.completed` )描述整体响应而非单个 智能体,因此它们不包括 `agent` 属性。
+归属 智能体 的 SSE 事件包含一个顶层 `agent` 属性。对于一个 `agent_message` 事件, `agent.agent_name` 用于标识接收方 智能体。响应生命周期事件(例如 `response.created` 和 `response.completed` )描述的是整个响应而非单个 智能体,因此它们不包含 `agent` 属性。
```json
{
@@ -835,18 +835,18 @@ with client.beta.responses.connect(
## 限制
-1. 压缩:
- 1. 该 `/responses/compact` 当启用多智能体时,不支持该端点。
- 2. 当 `multi_agent.enabled` 被设置为 `true`,时,即使请求未配置,也会隐式启用自动服务端压缩。 `context_management`。压缩独立应用于根智能体和每个子智能体,保留它们各自的上下文。用户仍可覆盖 `compact_threshold` 通过设置显式的 `context_management.compact_threshold` 在请求中。
-2. `reasoning.summary` 在启用多智能体时不支持。
-3. `max_tool_calls` 在启用多智能体时不支持。
-4. `max_concurrent_subagents` 默认为 `3`,这是推荐设置。
+1. Compaction:
+ 1. 该 `/responses/compact` endpoint is not supported when Multi-智能体 is enabled.
+ 2. When `multi_agent.enabled` is set to `true`, automatic 服务端 compaction is enabled implicitly, even if the request does not configure `context_management`. Compaction is applied independently to the root 智能体 and each subagent, preserving their separate contexts. Users can still override `compact_threshold` by setting an explicit `context_management.compact_threshold` in the request.
+2. `reasoning.summary` is not supported when Multi-智能体 is enabled.
+3. `max_tool_calls` is not supported when Multi-智能体 is enabled.
+4. `max_concurrent_subagents` defaults to `3`, which is the recommended setting.
## 提示词指南
-当启用 Multi-智能体时,我们的系统会自动将这些指令作为新的开发者消息附加到根智能体和子智能体上。你无法编辑或移除这些指令,但应将你的开发者指令视为对这些自动注入指令的补充。
+启用多智能体(Multi-智能体)后,我们的系统会自动将这些指令作为一条新的开发者消息追加到根智能体和子智能体中。你无法编辑或删除这些指令,但应将你的开发者指令组织成对这些自动注入指令的补充。
-### 根智能体
+### 根智能体 智能体
````text
You are `/root`, the primary agent in a team of agents collaborating to fulfill the user's goals.
@@ -872,7 +872,7 @@ They may be addressed as to=/root
There are {max_concurrent_subagents + 1} available concurrency slots, meaning that up to {max_concurrent_subagents + 1} agents can be active at once, including you.
````
-### 子代理
+### 子智能体
````text
You are an agent in a team of agents collaborating to complete a task.
diff --git a/docs/zh/api/docs/guides/rft-use-cases.md b/docs/zh/api/docs/guides/rft-use-cases.md
index 4dcbffc..3e85f12 100644
--- a/docs/zh/api/docs/guides/rft-use-cases.md
+++ b/docs/zh/api/docs/guides/rft-use-cases.md
@@ -1,35 +1,35 @@
-# 强化微调使用场景
+# 强化微调应用场景
-> 完整的文档索引参见 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获取该页面的 Markdown 版本。
-[强化微调](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning) (RFT)提供了一种提升模型在特定任务上表现的方法。任务必须清晰且具有可验证的答案。
+[强化微调](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning) (RFT) 提供了一种方法来提升模型在特定任务上的表现。该任务必须明确且具备可验证的答案。
-OpenAI正在逐步关闭微调平台。该平台不再
- 对新用户开放,但现有微调平台用户仍可
- 在未来数月内创建训练作业。
+OpenAI 正在逐步停用微调平台。该平台已不再
+ 对新的用户开放,但现有的微调平台用户在
+ 未来数月内仍可创建训练任务。
- 所有微调模型将继续可用于推理,直到其基础
- 模型 [弃用](https://developers.openai.com/api/docs/deprecations)。完整时间线见
+ 所有经过微调的模型在其基础
+ 模型被 [弃用](https://developers.openai.com/api/docs/deprecations)。之前仍可继续用于推理。完整的时间表请参见
[此处](https://developers.openai.com/api/docs/deprecations).
## 何时使用强化微调
-智能体工作流旨在做出既正确又可验证的决策。强化微调可以通过提供明确的评分标准,并使用基于代码或基于大语言模型的评分器来衡量功能成功度、事实准确性或策略合规性来提供帮助。
+智能体工作流旨在做出既正确又可验证的决策。RFT 可以通过提供明确的评分标准,并使用基于代码或基于 LLM 的评分器来衡量功能正确性、事实准确性或策略合规性,从而提供帮助。
-在早期用户中,已浮现出三个明确的用例:
+在早期用户中,三个明确的用例已经浮现:
1. **将指令转化为可运行的代码**:将开放式提示转化为必须通过确定性测试的结构化代码、配置或模板。
-1. **将事实提取为干净的格式**:从杂乱无序的文本中提取可验证的事实和摘要,并返回 JSON 结构化或其他基于 schema 的输出。
-1. **正确应用复杂规则**:当所提供的信息细微、量大、层级复杂或具有高风险时,做出细粒度的标签或政策决策。
+1. **将事实提炼为干净的格式**:从杂乱、非结构化的文本中提取可验证的事实和摘要,并以 JSON 结构化输出或其他基于 schema 的输出形式返回。
+1. **正确应用复杂规则**:在所提供信息细致、量大、分层或影响重大时,做出精细的标签或策略决策。
-[准备好使用强化微调了吗?跳转到指南 →](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning)
+[已准备好使用强化微调?直接跳转到指南 →](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning)
-### 1. 将指令转化为可工作的代码
+### 1. 将指令转化为可运行的代码
-在此用例中,模型对隐藏的领域约束进行推理,以生成代码、查询或基础设施模板等结构化输出。输出必须满足多个正确性条件,且成功通常以确定性方式评定:产物要么能编译、通过测试,要么符合明确的模式。
+在此用例中,模型对隐藏的领域约束进行推理,以生成结构化输出,例如代码、查询或基础设施模板。输出必须满足多个正确性条件,并且成功通常以确定性方式评估:产物要么能够编译、通过测试,要么符合明确的模式。
-#### 为半导体设计接线验证 IP
+#### 为半导体设计连接验证 IP
@@ -37,11 +37,11 @@ OpenAI正在逐步关闭微调平台。该平台不再
-> **公司**: [ChipStack](https://www.chipstack.ai) 正在构建用于芯片设计和验证的下一代人工智能驱动工具,旨在显著缩短开发和验证复杂半导体芯片所需的时间与成本。
+> **公司**: [ChipStack](https://www.chipstack.ai) 正在构建面向芯片设计与验证的下一代 AI 驱动工具,旨在显著缩短复杂半导体芯片的开发与验证时间并降低成本。
>
-> **待解决的问题**: 对人类而言,一项具有挑战性且耗时的任务是设计接口与验证 IP(预先创建的验证组件,若应用得当,可显著提升验证的质量和覆盖率)的绑定。验证 IP 众多,每个 IP 可能包含数十到数百个可映射的信号。要正确应用验证 IP,必须有人对此领域有深入了解。
+> **待解决的问题**:对于人类而言,一项既困难又耗时的任务是将设计接口绑定到验证 IP(预先创建的验证组件,若正确使用,可以显著提升验证的质量与覆盖率)。验证 IP 数量众多,且每个验证 IP 可能包含数十到数百个需要映射的信号。必须深入理解该领域,才能正确应用验证 IP。
>
-> **目标**: 为了训练OpenAI推理模型来完成这项工作,ChipStack 准备了少于 50 个样本的数据集,然后进行了多种 RFT 变体实验。在最终评估报告中,他们对每个模型和变体——o1-mini 基础版与微调版、o3-mini 基础版与微调版——分别运行了该评估集三次,并先按样本取平均结果,再计算整体平均。
+> **目标**:为训练OpenAI推理模型来完成这项任务,ChipStack 准备了一个包含不到 50 个样本的数据集,然后进行了若干 RFT 变体实验。在最终的评估报告中,他们针对每个模型与变体——o1-mini 基础版与微调版、o3-mini 基础版与微调版——将该评估集运行了三次,并按样本再按总体对结果取平均值。
@@ -53,7 +53,7 @@ OpenAI正在逐步关闭微调平台。该平台不再
-> 以下是提供的一段示例数据。
+> 以下是一段提供的示例数据。
```
[
@@ -68,13 +68,13 @@ OpenAI正在逐步关闭微调平台。该平台不再
-评分代码
+评分器代码
-> 以下是 Python 中一个字符串映射的评分器定义,表示为对象列表,其中包含 `name` 以及 `value` 属性。
+> 下面是一个 Python 中字符串映射的评分器定义,表示为具有以下属性的对象列表 `name` 和 `value` 属性。
>
-> 从概念上讲,这旨在建模类似于 `Dict[str, str]`.
+> 从概念上讲,这是为了对如下类型进行建模: `Dict[str, str]`.
```python
{
@@ -109,34 +109,34 @@ def grade(sample: dict[str, str], item: dict[str, str]) -> float:
-结果
+Results
-> 对于 o1-mini 和 o3-mini 两者来说,性能提升了约 12 个百分点。微调后的变体在识别何时不应施加布线方面表现明显更好。许多商业验证 IP 可能包含数百个可选信号,其中大多数并不打算被施加。
+> 对于 o1-mini 和 o3-mini,性能均提升了约 12 个百分点。经过微调的变体在判断何时不应应用连线方面有了明显改善。许多商用验证 IP 可能包含数百个可选信号,其中大多数并不应被应用。
>
-> “得益于强大的基础模型和易于使用的强化微调 API,我们能够利用一小批高质量样本显著提升任务性能。”
+> “得益于强大的基础模型和易用的强化微调 API,我们仅用少量高质量样本就显著提升了任务性能。”
>
-> —[ChipStack](https://www.chipstack.ai),下一代用于芯片设计和验证的 AI 驱动工具
+> —[ChipStack](https://www.chipstack.ai),面向芯片设计与验证的下一代 AI 驱动工具
-#### 可编译并通过 AST 检查的生产级 API 代码片段
+#### 开箱即用的 API 代码片段,可编译并通过 AST 检查
-使用场景
+用例
-> **公司**: [Runloop](https://www.runloop.ai) 是一个用于将 AI 驱动的编码智能体部署到生产环境,并通过公共和自定义基准测试能力来优化性能的平台。
+> **公司**: [Runloop](https://www.runloop.ai) 是一个供 AI 驱动的编码智能体投入生产环境的平台,并通过公开和自定义的基准测试能力来打磨其性能。
>
-> **要解决的问题**:Runloop 希望提高模型在使用第三方API(如 Stripe API)时的性能,这些 接口 可能庞大且复杂,且没有人类参与其中。如果他们能够训练一个模型来使用 Stripe API,Runloop 就可以将具有经济影响力的业务案例转化为可工作的代码。
+> **待解决的问题**:Runloop 希望提升模型在使用第三方 API(例如 Stripe API)时的表现,这类 接口 在缺少人工介入的情况下可能非常庞大且复杂。如果他们能训练模型来使用 Stripe API,Runloop 就能将具有重要经济价值的业务场景转化为可运行的代码。
>
-> **目标**:他们的目标是教会模型掌握 Stripe API 的使用,包括通过改编现有集成指南中的信息、合并多个指南中的信息或推断指南中未明确说明的信息,为任意用户请求编写完整的代码片段。他们使用了 RFT,并有两个主要奖励:
+> **目标**:他们的目标是教会模型熟练使用 Stripe API,包括针对任意用户请求编写完整的代码片段——可以通过改编现有集成指南中的信息、合并多份指南中的信息,或推断指南中未明确说明的信息来实现。他们使用 RFT 并设置了两类主要奖励:
>
-> 1. 奖励模型以符合“动态”集成指南预期外观的 Markdown 格式输出答案。
-> 1. 通过 AST Grep 验证输出的代码来奖励模型生成“正确”的代码片段。这使他们能够确认模型正在使用正确的参数调用正确的 Stripe SDK,在某些情况下甚至以正确的顺序调用。
+> 1. 奖励模型以 Markdown 格式输出答案,并符合对“动态”集成指南外观的预期。
+> 1. 通过对模型输出的代码使用 AST Grep 进行校验,奖励模型生成“正确”的代码片段。这使得他们能够确认模型使用了正确的 Stripe SDK 调用,并带有正确的参数,在某些情况下甚至按正确的顺序进行调用。
@@ -422,33 +422,33 @@ def grade(sample: Any, item: Any) -> float:
-结果
+Results
-> 综合来看总奖励(格式和 AST Grep),Runloop 观察到平均提升了 **12%** RFT 模型在基准测试上相较于基础 o3-mini 模型的表现。
+> 综合考量格式与 AST Grep 的总奖励,Runloop 相比基准 o3-mini 模型平均提升 **12%** 。
>
-> 他们实现了两类测试,一类提供来自集成指南的显式内容(评估推理和指令遵循),另一类不提供(评估知识回忆)。两种变体均提升了超过 **8%**.
+> 他们实现了两类测试:一类提供集成指南中的明确内容(评估推理与指令遵循能力),另一类不提供(评估知识回忆能力)。两种变体均取得了超过 **8%**.
>
-> “OpenAIs RFT 平台让我们得以访问全球最优秀的通用推理模型,并配备工具集,在对我们业务重要的问题领域上增强该推理能力。”
+> “OpenAI 的 RFT 平台让我们能够使用全球最强的通用推理模型,并提供可在我们业务重要的问题领域为该推理大幅提速的工具集。”
>
> —[Runloop](https://www.runloop.ai/)
-#### 在调度管理器中正确处理冲突和重复项
+#### 在日程管理器中正确处理冲突和重复项
-使用场景
+用例
-> **公司**: [Milo](https://www.joinmilo.com) 通过将杂乱输入(如包含待办事项的文本对话、学校通讯 PDF、每周提醒、体育赛程邮件)转化为可靠的日历和列表操作,帮助忙碌的父母管理混乱的家庭日程。
+> **公司**: [Milo](https://www.joinmilo.com) 帮助忙碌的父母管理混乱的家庭日程,把凌乱的输入——比如包含待办事项的文字对话、学校通讯 PDF、每周提醒、运动赛程邮件——转化为可靠的日历和清单操作。
>
-> **待解决的问题**:基础 GPT-4o 提示和 SFT 未达到信任阈值。
+> **待解决的问题**:基础的 GPT-4o 提示和 SFT 未达到信任阈值。
>
-> **目标**:Milo 使用 RFT 来正确创建编码任务,如事件与列表分类、重复规则生成、准确的更新和删除、冲突检测以及严格的输出格式。他们定义了一个评分器,用于检查生成的条目对象是否完整、分类是否正确,以及是否重复或存在日历冲突。
+> **目标**:Milo 使用 RFT 来正确创建编码任务,例如事件与清单的分类、重复规则生成、准确的更新与删除、冲突检测以及严格的输出格式。他们定义了一个评分器,用于检查生成的项目对象是否完整、分类是否正确,以及是否存在重复或日历冲突。
@@ -456,37 +456,37 @@ def grade(sample: Any, item: Any) -> float:
-结果
+Results
-> 结果显示各项指标均有所提升,平均正确率得分 **从 0.86 提高到 0.91**,而最具挑战性的场景从 **0.46 提高到 0.71** (其中满分=1)。
+> 结果显示各项性能均有提升,平均正确率得分 **从 0.86 提升到 0.91**,而最具挑战性的场景则从 **0.46 提升到 0.71** (满分=1)。
>
-> “准确率不仅仅是一个指标——它是忙碌家长们的一颗定心丸。这仍处于早期阶段,但基础性能有了如此重要的改进,我们能够更积极地推进复杂的推理需求。”
+> "准确性不仅仅是一个指标——它为忙碌的父母带来安心。虽然这仍处于早期阶段,但基础性能取得了如此重要的提升,使我们能够更积极地推进更复杂的推理需求。"
>
-> “处理和支持家庭动态涉及理解数据的细微含义。以冲突为例——知道伊桑的足球课与艾拉的独奏会冲突,是因为爸爸必须开车送两个孩子,这比简单的时间重叠要深入得多。”
+> "理解和支持家庭动态需要理解数据背后的细微含义。以冲突为例——知道 Ethan 的足球训练与 Ella 的朗诵会冲突,因为爸爸必须同时接送两个孩子,这比单纯的时间重叠要复杂得多。"
>
> —[Milo](https://www.joinmilo.com),面向家庭的 AI 日程安排工具
-### 2. 将事实提取为整洁格式
+### 2. 将事实提取为简洁格式
-这些任务通常涉及微妙区别,需要清晰的分类指南。成功的框架设计需要通过领域专家共识来定义明确且分层的标注方案。若缺乏一致性共识,评分信号会变得嘈杂,削弱 RFT 的有效性。
+这些任务通常涉及细微的区分,需要清晰的分类准则。成功的框架设计需要由领域专家通过共识定义的显式且分层的标注方案。如果没有一致的共识,评分信号会变得嘈杂,从而削弱 RFT 的有效性。
-#### 分配 ICD-10 医疗代码
+#### 分配 ICD-10 医疗编码
-使用场景
+用例
-> **公司**: [Ambience](https://www.ambiencehealthcare.com) 是一个AI平台,为临床医生消除行政负担,并确保跨100多个专科的准确、合规文档记录,帮助医生专注于患者护理,同时提高文档质量并降低医疗系统的合规风险。
+> **公司**: [Ambience](https://www.ambiencehealthcare.com) 是一个 AI 平台,可消除临床医生的行政负担,并确保在 100 多个专科中提供准确、合规的文档,帮助医生专注于患者护理,同时提高文档质量并降低医疗系统的合规风险。
>
-> **要解决的问题**:ICD-10编码是医学中最复杂的行政任务之一。每次患者就诊后,临床医生必须将每个诊断映射到约70,000个代码之一——处理付款方关于特异性、护理场所和互斥配对的特定规则。错误可能引发审计和罚款,金额可达九位数。
+> **待解决的问题**:ICD-10 编码是医学中最复杂的行政任务之一。每次患者就诊结束后,临床医生必须将每个诊断映射到约 70,000 个代码之一——应对针对特异性、就诊地点和互斥配对的支付方特定规则。错误可能触发审计和高达九位数的罚款。
>
-> **目标**:利用对OpenAI前沿模型的强化微调,Ambience希望训练一个推理系统,该系统能听取就诊音频,提取相关EHR上下文,并以超过专家临床医生的准确性推荐ICD-10代码。
+> **目标**:Ambience 希望使用 OpenAI 前沿模型进行强化微调,训练一个推理系统,监听就诊音频,引入相关的 EHR 上下文,并推荐准确率超过专家临床医生的 ICD-10 代码。
@@ -494,40 +494,40 @@ def grade(sample: Any, item: Any) -> float:
-结果
+Results
-> Ambience 通过模型改进达到了可媲美人类专家的水平。
+> Ambience 实现了可以领先人类专家的模型改进。
>
-> 在一个涵盖数百次就诊的金标准测试集上,强化微调使模型从落后于人类转变为领先人类 **12 个百分点——消除了受训医生所犯编码错误中约四分之一的部分**:
+> 在一个涵盖数百次就诊的金标准测试集上,强化微调使模型从落后于人类变为领先人类 **12 分——消除了训练有素的医生所犯的大约四分之一的编码错误**:
>
-> - o3-mini(基线):0.39(-6 分)
+> - o3-mini(基础版):0.39(-6 分)
> - 医师基线:0.45
-> - RFT 微调后的 o3-mini:0.57(+12 分)
+> - 经 RFT 调优的 o3-mini:0.57(+12 分)
>
-> 结果是实时的临床护理点编码支持,能够在降低合规风险的同时提高报销完整性。
+> 这一结果是一种实时的、临床场景下的编码支持,既能提升计费完整性,也能降低合规风险。
>
-> “准确的 ICD-10 选择对于合规文档编制至关重要。RFT 解锁了我们在任何基础模型上都未曾见过的编码精度新水平,并为自动化编码设立了新的标杆。”
+> “准确的 ICD-10 编码选择对于合规文档至关重要。RFT 让我们看到了以往任何基础模型都未曾达到的编码精度新高度,并为自动化编码树立了全新标杆。”
>
> —[Ambience Healthcare](https://www.ambiencehealthcare.com)
-#### 提取摘录以支持法律主张
+#### 提取支持法律主张的摘录
-使用案例
+用例
-> **公司**: [Harvey](https://www.harvey.ai) 正在构建法律团队信赖的 AI——而这种信赖取决于能否从庞大的合同、法规和判例法语料库中精准检索出正确的证据。法律专业人士并不满足于仅能生成听起来合理摘要或转述答案的模型。他们要求可验证的引用——即能直接追溯到源文档的段落。
+> **公司**: [Harvey](https://www.harvey.ai) 正在构建值得法律团队信赖的 AI——而这种信赖,取决于能否从庞大的合同、法规与判例语料中精准检索到恰当的证据。法律专业人士并不满足于仅能生成听起来合理或转述作答的模型,他们要求提供可核验的引用——即那些可以直接追溯回源文档的段落。
>
-> **要解决的问题**:Harvey 的客户使用其模型对诉讼风险进行分类、构建法律论点,并为法律专业人士提供尽职调查支持——在这些任务中,任何一句遗漏或误引都可能改变结果。模型必须能够解析冗长、密集的法律文档,并仅提取重要的部分。
-> 在实践中,这些输入往往杂乱且不一致:有些索赔表述模糊,而另一些则依赖于深藏在模板条款中的罕见法律原则。
+> **待解决的问题**:Harvey 的客户使用其模型来甄别诉讼风险、构建法律论证,并为法律专业人士的尽职调查提供支持——这些任务中,遗漏或误引一句话都可能扭转结局。模型必须能够解析冗长而密集的法律文档,并仅提取出关键的部分。
+> 实际上,这些输入往往杂乱且不一致:有些主张含糊其辞,而另一些则取决于深藏在样板条款中的冷僻法学理论。
>
-> **目标**:任务要求是解读微妙的法律主张、浏览长文档,并选择附带逐字摘录的切题支持材料。
+> **目标**:该任务的要求是解读细微的法律主张、导航长篇文档,并选取贴切的支撑证据,使用逐字摘录。
@@ -617,42 +617,42 @@ def grade(sample: dict, item: dict) -> float:
-结果
+Results
-> 经过强化微调后,Harvey 看到了 **F1 分数提升 20%** :
+> 经过强化微调后,Harvey 获得了 **20% 的提升** 在 F1 分数上:
>
> - 基线 F1:0.563
-> - RFT 后 F1 - 0.6765
+> - RFT 之后 F1 - 0.6765
>
-> 通过使用 RFT,Harvey 显著提升了法律事实提取的性能,超越了 GPT-4o 的效率和准确性。早期试验表明 RFT **在 93% 的对比中胜出或持平** 相对于 GPT-4o。
+> 使用 RFT,Harvey 显著提升了法律事实抽取性能,在效率和准确性上均超越了 GPT-4o。早期试验显示 RFT **在 93% 的对比中获胜或打平** GPT-4o。
>
-> “RFT 模型表现出与 GPT-4o 相当或更优的性能,但推理速度显著更快,对现实世界的法律应用尤为有益。
+> “RFT 模型表现与 GPT-4o 相当或更优,同时推理速度显著更快,对现实中的法律用例尤为有益。
>
-> —[Harvey](https://www.harvey.ai),AI 助力法律团队
+> —[Harvey](https://www.harvey.ai),法律团队的 AI
### 3. 正确应用复杂规则
-该用例涉及将非结构化输入中的可验证事实或实体抽取到明确定义的架构中(例如,JSON 对象、条件代码、医疗代码、法律引用或财务指标)。
+该用例涉及从非结构化输入中提取可验证的事实或实体,并放入明确定义的模式中(例如 JSON 对象、条件码、医学编码、法律引文或财务指标)。
-成功的抽取任务通常受益于精确、连续的评分方法——如片段级 F1 分数、模糊文本匹配指标或数值准确性检查——以评估抽取信息与真实情况的对齐准确度。定义明确的成功标准和详细评分细则。然后,模型即可实现可靠、可重复的改进。
+成功的提取任务通常受益于精确、连续的评分方法——例如 span 级 F1 分数、模糊文本匹配指标或数值准确性检查——以评估提取的信息与真实值的对齐程度。定义明确的成功标准和详细的评分细则。然后,模型就能获得可靠、可复现的提升。
#### 税务分析中的专家级推理
-使用场景
+用例
> **公司**: [Accordance](https://www.accordance.com) 正在为税务、审计和 CPA 团队构建一个平台。
>
-> **要解决的问题**:税务是一个高度复杂的领域,需要针对细微的事实模式和复杂的法规进行深度推理。这也是一个持续变化的领域。
+> **待解决的问题**:税务是一个高度复杂的领域,需要在细致的事实模式和错综复杂的法规之间进行深度推理。这也是个持续变化的领域。
>
-> **目标**:Accordance 希望为复杂的税务场景构建一个高信任度系统,同时保持准确性。与传统的硬编码软件不同,其数据提取工具需要随着税务环境的变化而适应,这一点很重要。
+> **目标**:Accordance 希望为复杂的税务场景建立一个高信任度的系统,同时保持准确性。与传统的硬编码软件不同,重要的是让其数据提取工具能够随着税务环境的变化而适应。
@@ -660,7 +660,7 @@ def grade(sample: dict, item: dict) -> float:
-评分代码
+评分器代码
@@ -685,35 +685,35 @@ def grade(sample: dict, item: dict) -> float:
-结果
+Results
-> 通过与OpenAI及其内部税务专家合作,Accordance 实现了:
+> 通过与 OpenAI 及其内部税务专家合作,Accordance 实现了:
>
-> - 近乎 **40% 的提升** 在税务分析任务中,相较于基础模型
-> - 在 TaxBench 等基准测试中,性能优于所有其他领先模型
-> - 经过RFT训练的模型展现出以高准确率处理高级税务场景的能力——经税务专业人士评估,Accordance 的微调模型表现出专家级推理水平,有望节省数千小时的人工工作量
+> - 近 **40% 的提升** 在税务分析任务上相比基模的表现
+> - 在 TaxBench 等基准测试中优于所有其他领先模型
+> - 经 RFT 训练的模型展示了以高准确率处理复杂税务场景的能力——经税务专业人士评估,Accordance 的微调模型表现出专家级推理水平,有望节省数千小时的人工工作
>
-> “与基础模型相比,我们在税务分析任务上实现了 38.89% 的提升,并在关键税务基准(包括 TaxBench)上显著优于所有其他领先模型。经过 RFT 训练的模型在处理复杂税务场景的同时保持准确性的能力,证明了强化微调——以及更广泛的人工智能——已为专业应用做好准备。最重要的是,RFT 为随着税务环境演变而持续适应奠定了基础,确保持久价值和相关性。经税务专家评估,我们微调的模型展现出了专家级的推理能力,这将节省数千个专业工时——这不仅是渐进式改进,更是税务工作方式的范式转变。”
+> “我们在税务分析任务上相较基础模型取得了 38.89% 的提升,并在关键税务基准(包括 TaxBench)上显著优于所有其他领先模型。经过 RFT 训练的模型既能处理复杂的税务场景,又能保持准确性,这表明强化微调——以及更广泛的 AI——已具备投入专业应用的条件。最重要的是,RFT 为持续适配提供了基础,使模型能够随税务领域的演变不断进化,从而确保持久的价值与相关性。在税务专家的评估下,我们微调后的模型展现出了专家级的推理能力,这将节省数千个专业工时——这不仅仅是一次渐进式的改进,而是税务工作方式的一次范式转变。”
>
> —[Accordance](https://www.accordance.com/),AI 税务会计公司
-#### 精细内容审核策略的执行
+#### 执行细致的内容审核策略
-使用场景
+用例
> **公司**: [SafetyKit](https://www.safetykit.com) 是一个风险与合规平台,帮助组织在复杂的内容审核工作流中做出决策。
>
-> **要解决的问题**:这些系统必须处理大量内容,并应用需要多步骤推理的复杂策略逻辑。由于数据量庞大且标注中存在细微差别,这类任务对通用模型来说可能难以完成。
+> **待解决的问题**:这些系统必须处理海量内容,并应用需要多步推理的复杂策略逻辑。由于数据量大以及标签之间存在细微差别,这类任务对通用模型而言可能颇具挑战。
>
-> **目标**:SafetyKit 旨在用单一推理智能体(基于强化学习微调模型)替换其最复杂工作流中的多个节点。目标是在即使具有挑战性且细微的领域,也能缩短 SafetyKit 对新策略执行的上线时间。
+> **目标**: SafetyKit 旨在使用经过强化学习微调的模型,将其最复杂工作流中的多个节点替换为单个推理智能体。目标是缩短 SafetyKit 在即使是具有挑战性且细致的领域中,针对新策略落地所需的时间。
@@ -721,35 +721,35 @@ def grade(sample: dict, item: dict) -> float:
-结果
+Results
-> SafetyKit 正在使用他们的 o3-mini RFT 模型来支持先进的内容审核能力,确保全球最大的人工智能聊天机器人公司之一的用户安全。他们已成功将 F1 分数提升 **从 86% 提升到 90%**,很快将取代其生产管线中的数十次 4o 调用。
+> SafetyKit 正在使用其 o3-mini RFT 模型来支持高级内容审核能力,为全球最大的 AI 聊天机器人公司之一保障用户安全。他们已成功将 F1 分数 **从 86% 提升到 90%**,并即将替代其生产管线中数十次 4o 调用。
>
-> “SafetyKit 基于 RFT 的内容审核在细微的内容审核任务中取得了显著改进,对于在动态、真实的场景中保护用户安全至关重要。”
+> "SafetyKit 基于 RFT 的审核能力在细致的内容审核任务中取得了显著提升,对于在动态的真实场景中保护用户至关重要。"
>
> —[SafetyKit](https://www.safetykit.com)
-#### 法律文档审阅、比较与摘要
+#### 法律文档审阅、对比与摘要
-使用场景
+用例
-> **公司**: [Thomson Reuters](https://www.thomsonreuters.com) 是一家 AI 和技术公司,通过可信内容和 工作流自动化赋能专业人士。
+> **公司**: [Thomson Reuters](https://www.thomsonreuters.com) 是一家 AI 与科技公司,通过值得信赖的内容和工作流自动化赋能专业人士。
>
-> **要解决的问题**:法律专业人士在做出任何决定之前必须阅读大量内容。Thomson Reuters 的 CoCounsel 产品旨在通过提供具备内容和行业知识的 AI 助手,帮助这些专家更快行动。驱动该工具的模型必须理解复杂的法律规则。
+> **待解决的问题**:法律专业人士必须在做出任何决策之前阅读大量内容。Thomson Reuters 的 CoCounsel 产品旨在通过提供一个具备内容和行业知识的 AI 助手来帮助这些专家更快地推进工作。驱动该工具的模型必须理解复杂的法律规则。
>
-> **目标**:Thomson Reuters 旨在创建一个在法律 AI 技能方面表现出色的强化微调模型。他们使用来自三个高频使用的面向法律专业人士的 CoCounsel Legal AI 技能的专业数据集,对 RFT 进行了初步评估,以检验能否实现模型性能提升:
+> **目标**:Thomson Reuters 旨在打造一款在法律 AI 技能方面表现出色的强化微调模型。他们对 RFT 进行了初步评估,以考察是否能利用面向法律专业人士的三项高使用率 CoCounsel 法律 AI 技能的专用数据集实现模型性能提升:
>
-> 1. 审查文档:针对合同、记录和其他法律文件中的提问生成详细回答
-> 1. 比较文档:突出两份或多份不同合同或文档之间的实质性差异
-> 1. 摘要:对一份或多份文档中的最重要信息进行总结,以支持快速法律审查
+> 1. 审阅文档:针对合同、笔录和其他法律文档提出的问题生成详细解答
+> 1. 对比文档:突出显示两个或更多不同合同或文档之间的实质性差异
+> 1. 总结:总结一份或多份文档中最重要的信息,以便快速进行法律审阅
@@ -757,57 +757,57 @@ def grade(sample: dict, item: dict) -> float:
-结果
+Results
-> 
+> 
>
-> “LLM 作为评判者有助于证明改进推理模型的可能性——在初步评估中,RFT 模型的表现始终优于基线 o3-mini 和 o1 模型”
+> "LLM 作为评判模型在证明推理模型可被改进的可能性方面发挥了很大作用——在初步评估中,RFT 模型的表现始终优于基线的 o3-mini 和 o1 模型"
>
-> —[Thomson Reuters](https://www.thomsonreuters.com/),一家人工智能与技术公司
+> —[Thomson Reuters](https://www.thomsonreuters.com/),人工智能与科技公司
-## 评估是基础
+## Evals 是基础
-**在实施 RFT 之前,我们强烈建议为你打算微调的任务创建并运行一个评估**。如果你打算微调的模型得分处于绝对最低或绝对最高可能分数,那么 RFT 对你不会有用。
+**在实施 RFT 之前,我们强烈建议你为计划进行微调的任务创建并运行一个评估**。如果你计划进行微调的模型得分处于可能得分的绝对最小值或绝对最大值,那么 RFT 对你来说就没有用处。
-RFT 通过强化对给定提示的更好答案来工作。如果我们无法区分不同答案的质量(即,如果它们都获得最低或最高可能分数),那么就没有可供学习训练信号。然而,如果你的评估得分介于最低和最高可能分数之间的某个范围,就有足够的数据可供使用。
+RFT 的工作原理是强化针对所提供提示的更优回答。如果我们无法区分不同回答的质量(即所有回答都获得可能的最小值或最大值),那么就没有可供学习的训练信号。但是,如果你的评估得分处于最小值和最大值之间的某个区间,那么就有足够的数据可以使用。
-一个有效的评估能揭示人类专家始终一致认同但当前前沿模型却难以应对的机会,这为 RFT 提供了一个有价值的差距来弥合。 [开始使用评估](https://developers.openai.com/api/docs/guides/evals).
+一个有效的评估能够揭示人类专家始终达成一致而当前前沿模型仍然表现不佳的机会,从而形成一个可供 RFT 弥合的宝贵差距。 [开始使用评估](https://developers.openai.com/api/docs/guides/evals).
-## 如何从 RFT 获得更好的结果
+## 如何通过 RFT 获得更好的结果
-要让微调模型看到改进,有两个主要的方面需要重新审视和完善:确保任务定义明确,以及使评分机制更加稳健。
+要看到微调模型的改进效果,有两个主要的方面需要回顾并优化:确保任务定义清晰,以及让评分方案更加稳健。
-### 重新表述或澄清你的任务
+### 重新框定或澄清你的任务
-好的任务能让模型有公平的学习机会,并让你能够量化改进。
+好的任务能让模型获得公平的学习机会,并让你量化改进效果。
-- **从模型偶尔能完成的任务开始**。RFT 的工作原理是采样多个答案,保留看起来最好的,并推动模型向这些答案靠拢。如果模型目前从未答对过,它就无法改进。
-- **确保每个答案都可以被评分**。评分器必须能够读取答案并给出分数,而无需人工介入。我们支持多种 [评分器类型](https://developers.openai.com/api/docs/guides/graders),包括自定义 Python 评分器和 LLM 评判。如果你无法用现有的评分器编写代码来评判答案,那么 RFT 就不是合适的工具。
-- **消除对“正确”答案的疑虑**。如果两个细心的人经常对解决方案意见不一,说明任务过于模糊。重写提示词、补充上下文,或将任务拆分为更清晰的部分,直到领域专家达成一致。
-- **限制侥幸猜测**。如果任务是只有一个明显最佳选项的单选题,模型可能靠猜就赢。增加更多选项类别、要求简短开放式文本,或调整格式使猜测代价高昂。
+- **从一个模型偶尔已经能解决的任务入手**。RFT 通过采样大量答案、保留看起来最好的,并引导模型朝这些答案靠拢来工作。如果模型目前从未给出正确答案,它就无法提升。
+- **确保每个答案都可以被评分**。评分器必须能够读取一个答案并给出分数,全程无需人工介入。我们支持多种 [评分器类型](https://developers.openai.com/api/docs/guides/graders),包括自定义 Python 评分器和 LLM 评判模型。如果你无法用现有的评分器编写代码来评判答案,那么 RFT 就不适合你。
+- **消除对“正确答案”的疑虑**。如果两个认真的人在解答上经常意见不一,说明任务过于模糊。请改写提示、补充上下文,或将任务拆分成更清晰的部分,直到领域专家达成一致。
+- **限制侥幸猜中**。如果任务是只有一个明显最佳选项的单选题,模型可能凭运气获胜。可以增加类别、要求简短开放式文本,或调整格式,让猜测变得代价高昂。
### 强化你的评分器
-清晰、稳健的评分方案对于 RFT 至关重要。
+清晰、稳健的评分方案对 RFT 至关重要。
-- **生成平滑的评分,而非通过/不通过的标记**。随着答案改进而逐渐变化的评分能提供更好的训练信号。
-- **防范奖励黑客**。当模型找到不依赖真实技能即可获得高分的捷径时,就会出现这种情况。
-- **避免数据偏差**。若数据集中某一标签在大多数情况下出现,模型会倾向于猜测该标签。平衡数据集或提高稀有案例的权重,迫使模型进行思考。
-- **当代码无法胜任时,使用LLM评判器**。对于丰富、开放式答案,让 [独立的 OpenAI 模型评分](https://developers.openai.com/api/docs/guides/graders#model-graders) 你微调模型的答案。确保你:
- - **评估评判器**:通过LLM评判器运行多个候选答案和正确答案,确保返回的评分稳定且符合偏好。
- - **提供少量示例**。在提示中包含优秀、一般和较差的答案,以提高评分器的有效性。
+- **输出平滑的分数,而不是通过/不通过的二值判定**。随着答案质量提升而平滑变化的分数,能提供更好的训练信号。
+- **防范奖励作弊**。当模型找到能在缺乏真实能力的情况下获得高分的捷径时,就会发生这种情况。
+- **避免数据倾斜**。如果数据集中某一类标签出现得最多,模型就会倾向于直接猜该标签。请对数据集进行平衡,或对稀有样本进行上加权,以迫使模型进行思考。
+- **当代码评分不够用时,使用 LLM 评分**。对于内容丰富、开放式的答案,可以让一个独立的 OpenAI 模型来对 [你的微调模型的答案进行评分](https://developers.openai.com/api/docs/guides/graders#model-graders) 。请确保你:
+ - **评估评分模型**:让多个候选回答和正确答案通过你的 LLM 评分模型,确保返回的分数稳定且与偏好一致。
+ - **提供少样本示例**。在提示中同时包含优秀、中等和较差的答案,以提升评分模型的有效性。
-了解更多关于 [评分器类型](https://developers.openai.com/api/docs/guides/graders).
+了解有关 [评分器类型](https://developers.openai.com/api/docs/guides/graders).
## 其他资源
-如需更多灵感,请访问 [OpenAI Cookbook](https://developers.openai.com/cookbook),其中包含示例代码和第三方资源链接,或进一步了解我们的模型与推理能力:
+如需更多灵感,请访问 [OpenAI Cookbook](https://developers.openai.com/cookbook),其中包含示例代码和指向第三方资源的链接,或详细了解我们的模型与推理能力:
-- [了解模型](https://developers.openai.com/api/docs/models)
+- [认识模型](https://developers.openai.com/api/docs/models)
- [强化微调指南](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning)
- [评分器](https://developers.openai.com/api/docs/guides/graders)
- [模型优化概述](https://developers.openai.com/api/docs/guides/model-optimization)
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/token-counting.md b/docs/zh/api/docs/guides/token-counting.md
index 4b16229..6fa2da3 100644
--- a/docs/zh/api/docs/guides/token-counting.md
+++ b/docs/zh/api/docs/guides/token-counting.md
@@ -1,29 +1,29 @@
-# 统计令牌数
+# 计算 token
-> 有关完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取文档页面的 Markdown 版本。
+> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
-令牌计数可让你在向模型发送请求之前,确定该请求将使用多少个输入令牌。可用于:
+Token counting 允许你在向模型发送请求之前确定该请求将使用多少输入令牌。用于:
- **优化提示词** 以适配上下文限制
-- **估算成本** 在发起API调用前
-- **路由请求** 基于大小(例如,将较小的提示词路由到较快的模型)
-- **避免意外** 对于图像和文件——不再基于字符进行估算
+- **估算成本** 在进行 API 调用之前
+- **路由请求** 依据大小路由(例如,将较小的提示词路由到更快的模型)
+- **避免意外情况** 处理图像和文件时——不再依赖基于字符数的估算
-该 [输入令牌计数端点](https://developers.openai.com/api/reference/python/resources/responses/subresources/input_tokens/methods/count) 接受与 [Responses API](https://developers.openai.com/api/reference/resources/responses/methods/create)。相同的输入格式。传递文本、消息、图像、文件、工具或对话——API 会返回模型将接收到的精确数量。
+该 [输入令牌计数端点](https://developers.openai.com/api/reference/python/resources/responses/subresources/input_tokens/methods/count) 接受与 [Responses API](https://developers.openai.com/api/reference/resources/responses/methods/create)。相同的输入格式。传入文本、消息、图像、文件、工具或对话——API 会返回模型将接收到的确切令牌数量。
-该数量包括用于表示请求结构的格式令牌,如消息角色和边界。这些令牌可能不会出现在你本地进行分词处理的文本或字段中。
+该计数包括用于表示请求结构的格式化令牌,例如消息角色和边界。这些令牌可能不会出现在你在本地进行分词的文本或字段中。
-## 为何使用令牌计数API?
+## 为什么要使用 token 计数 API?
-像 tiktoken 这样的本地分词器 [tiktoken](https://github.com/openai/tiktoken) 适用于纯文本,但存在一定限制:
+类似 [tiktoken](https://github.com/openai/tiktoken) 的分词器适用于纯文本,但它们存在一些限制:
-- **图像和文件** 不受支持——像 `characters / 4` 这样的估算不准确
-- **工具和模式** 会增加难以在本地计算的令牌数
-- **模型特定行为** 可能改变令牌化(例如,推理、缓存)
+- **图片和文件** 不被支持——像这样的估算 `characters / 4` 是不准确的
+- **工具和架构** 添加的 token 难以在本地精确计数
+- **特定模型的行为** 会改变分词方式(例如推理、缓存)
-令牌计数 API 处理所有这些情况。使用你本会发送的相同请求负载 `responses.create` ,即可获得准确计数。然后将结果用于你的消息验证或成本估算流程。
+令牌计数 API 会处理所有这些情况。请使用与你要发送的相同的载荷 `responses.create` 从而得到准确的计数。然后将该结果接入你的消息校验或成本估算流程。
-## 统计基础消息中的 token 数
+## 计算基础消息中的 token 数
简单文本输入
@@ -125,7 +125,7 @@ openai responses:input-tokens count \
```
-## 统计对话中的 token 数量
+## 统计对话中的 token 数
多轮对话
@@ -276,9 +276,9 @@ YAML
```
-## 使用指令统计 token 数
+## 使用指令统计 token
-带系统指令的输入
+使用系统指令进行输入
```javascript
import OpenAI from "openai";
@@ -387,11 +387,11 @@ YAML
```
-## 使用图像统计令牌数
+## 计算包含图片的 tokens 数量
-图像根据大小和细节级别消耗令牌。令牌计数 API 返回精确计数,无需猜测。
+图像会根据大小和细节级别消耗 token。token 计数 API 会返回精确数量——无需猜测。
-带图像的输入
+附带图像的输入
```javascript
import OpenAI from "openai";
@@ -565,13 +565,13 @@ YAML
```
-你可以使用 `file_id` (来自 [文件 API](https://developers.openai.com/api/reference/resources/files))或 `image_url` (一个 URL 或 base64 数据 URL)。请参阅 [图像与视觉](https://developers.openai.com/api/docs/guides/images-vision) 了解详情。
+你可以使用 `file_id` (来自 [Files API](https://developers.openai.com/api/reference/resources/files)) 或 `image_url` (URL 或 base64 data URL)。详见 [图像与视觉](https://developers.openai.com/api/docs/guides/images-vision) 。
-## 使用工具计算 token 数
+## 使用工具统计 token 数量
-工具定义(函数架构、MCP 服务器等)会向上下文中添加令牌。请将它们与你的输入一起计算:
+工具定义(函数 schema、MCP 服务器等)会增加上下文的 token。请将它们与你的输入一起统计:
-带函数工具的输入
+包含函数工具的输入
```javascript
import OpenAI from "openai";
@@ -767,24 +767,24 @@ YAML
```
-## 使用文件计算令牌数
+## 使用文件统计 token 数
-[文件输入](https://developers.openai.com/api/docs/guides/file-inputs)——目前支持 PDF——。传入 `file_id`, `file_url`,或 `file_data` 正如你为 `responses.create`。令牌计数反映模型处理的完整输入。
+[文件输入](https://developers.openai.com/api/docs/guides/file-inputs)——目前支持 PDF。传入 `file_id`, `file_url`,或者 `file_data` 的方式与 `responses.create`。相同。Token 数量反映了模型完整处理后的输入。
## 了解输出 token 数量
-报告的输出 token 用量包括模型生成的所有 token,而不仅仅是响应中可见的文本。Responses API 将此总数报告为 `output_tokens`,而 Chat Completions API 则将其报告为 `completion_tokens`.
+报告的输出 token 使用量包含模型生成的所有 token,而不仅仅是响应中可见的文本。Responses API 将该总量报告为 `output_tokens`,而 Chat Completions API 将其报告为 `completion_tokens`.
-某些模型(包括 GPT-5 模型)会生成用于格式化或分隔响应通道、工具调用和其他消息结构的 token。这些格式化 token 不会出现在消息内容或 `logprobs`,中,也不一定在用量中单独列出。因此,报告的输出或完成 token 计数可能高于可见 token 的数量或包含在 `logprobs`,中的 token 数量,即使报告的 `reasoning_tokens` 值为 `0`.
+某些模型(包括 GPT-5 模型)会生成用于格式化或分隔响应通道、工具调用以及其他消息结构的 token。这些格式化 token 不会出现在消息内容中,也不会出现在 `logprobs`,中,并且未必在使用量数据中单独列出。因此,报告的输出或 completion token 计数可能高于可见 token 数或包含在 `logprobs`,中的 token 数,即使报告的 `reasoning_tokens` 值为 `0`.
-该 `max_output_tokens` 和 `max_completion_tokens` 参数限制了模型生成的所有 token,包括不可见的 token。不可见 token 的数量因模型和响应形态而异,因此不要假设报告用量与可见输出之间存在固定的差异。当你需要特定数量的可见输出时,请在这些限制中留出余量。
+该 `max_output_tokens` 和 `max_completion_tokens` 参数会限制模型生成的所有 token,包括不可见的 token。不可见 token 的数量因模型和响应形态而异,因此不要假设报告的使用量与可见输出之间存在固定的差异。当你需要特定数量的可见输出时,请在这些限制中预留余量。
## API 参考
-有关完整参数和响应结构,请参阅 [计算输入令牌 API 参考](https://developers.openai.com/api/reference/python/resources/responses/subresources/input_tokens/methods/count)。端点为:
+有关完整参数和响应格式,请参阅 [Count input tokens API 参考](https://developers.openai.com/api/reference/python/resources/responses/subresources/input_tokens/methods/count)。该端点为:
```
POST /v1/responses/input_tokens
```
-响应包括 `input_tokens` (整数)和 `object: "response.input_tokens"`.
\ No newline at end of file
+响应包含 `input_tokens` (整数)和 `object: "response.input_tokens"`.
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/tools-programmatic-tool-calling.md b/docs/zh/api/docs/guides/tools-programmatic-tool-calling.md
index 93fc017..156f247 100644
--- a/docs/zh/api/docs/guides/tools-programmatic-tool-calling.md
+++ b/docs/zh/api/docs/guides/tools-programmatic-tool-calling.md
@@ -1,35 +1,35 @@
-# 编程工具调用
+# 程序化工具调用
-> 有关完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。你可以在页面 URL 末尾追加 `.md` 来获取 Markdown 版本的文档页面。
-编程式工具调用(Programmatic Tool Calling)允许模型编写并运行 JavaScript,以协调 Responses API 请求中的工具。程序可以并行调用工具、使用循环和条件,并在托管运行时中保留中间结果。当任务需要一系列相关的工具调用,或在返回结果前需要处理大量工具输出时,这一功能非常有用。
+Programmatic Tool Calling 让模型能够编写并运行 JavaScript,以协调 Responses API 请求中的工具。程序可以并行调用工具,使用循环和条件,并将中间结果保存在托管运行时中。当任务需要一系列相关工具调用,或需要在返回结果之前处理大量工具输出时,这非常有用。
-你的应用程序决定编程式工具调用是否可用,以及模型可以调用哪些符合条件的工具——是直接调用、通过程序调用,还是两种方式均可。应用程序仍会运行任何客户端拥有的工具调用。
+你的应用决定是否启用 Programmatic Tool Calling,以及模型可以从程序中直接调用哪些符合条件的工具,或两种方式均可。它会继续运行任何由客户端拥有的工具调用。
-在启用编程式工具调用之前,请查看 [模型页面](https://developers.openai.com/api/docs/models) 。
+请查看 [模型页面](https://developers.openai.com/api/docs/models) 后再启用 Programmatic Tool Calling。
## 了解运行时环境
-OpenAI 会在全新且隔离的 V8 运行时中运行每个生成的程序。该运行时支持带有顶层 `await`,的 JavaScript,但不提供 Node.js、包安装、直接网络访问、通用文件系统、子进程执行、控制台,也不在程序执行间保留 JavaScript 状态。程序只能通过请求中启用的工具与外部系统交互,并可通过 `text(...)` 或 `image(...)`.
+OpenAI 在全新且隔离的 V8 运行时中运行每个生成的程序。该运行时支持使用顶层 await 的 JavaScript,但不提供 Node.js、 `await`、包安装、直接网络访问、通用的文件系统、子进程执行、控制台,也不提供程序执行之间的持久化 JavaScript 状态。程序只能通过请求中启用的工具与外部系统交互,并可以通过 `text(...)` 或 `image(...)`.
-输出结果。编程工具调用支持零数据保留(ZDR)工作流,无需持久化的代码执行容器。必须为组织或项目启用 ZDR;设置 `store: false` 可启用无状态延续,但本身不会启用 ZDR。资格和保留取决于完整请求,包括其模型、工具和第三方服务;请参见 [数据控制](https://developers.openai.com/api/docs/guides/your-data).
+程序化工具调用支持零数据保留(Zero Data Retention, ZDR)工作流,无需持久化的代码执行容器。必须在组织或项目中启用 ZDR;设置 `store: false` 可启用无状态的 延续,但本身不会启用 ZDR。资格和保留策略取决于完整的请求,包括其模型、工具和第三方服务;请参阅 [数据控制](https://developers.openai.com/api/docs/guides/your-data).
-## 选择何时使用编程式工具调用
+## 选择何时使用程序化工具调用
-当某个阶段具有可预测的控制流,且代码能返回较小的结构化结果时,使用编程式工具调用。当一次调用就足够、每个结果都需要模型重新判断,或工作需经审批或保留引用来源或原生产物时,使用直接工具调用。
+当某个阶段具有可预测的控制流且代码可以返回更小的结构化结果时,使用程序化工具调用。当一次调用即可满足、每个结果都需要模型重新判断,或工作需要审批或保留引用或原生制品时,使用直接工具调用。
| 任务形态 | 推荐模式 |
| ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- |
-| 单个查找或操作 | 使用直接工具调用。 |
-| 多项结果,代码可进行筛选、连接、排序、去重、聚合或验证 | 当程序能返回更小的结构化结果时,使用程序化工具调用。 |
-| 数据流可预测的依赖调用 | 当代码能推导后续参数且限制与失败行为明确时,使用程序化工具调用。 |
+| 单次查找或操作 | 使用直接工具调用。 |
+| 代码可进行筛选、连接、排序、去重、聚合或校验的多个结果 | 当程序能够返回更小的结构化结果时,使用程序化工具调用。 |
+| 具有可预测数据流的依赖调用 | 当代码能够推导后续参数,并且限制与失败行为明确时,使用程序化工具调用。 |
| 自适应搜索或语义评估 | 当每个结果都应影响模型的下一步决策时,使用直接工具调用。 |
-| 写入操作或需审批的操作 | 默认使用直接工具调用,以保持明确的授权边界。 |
-| 最终引用或原生产物验证 | 除非程序保留原生输出并验证所有必需项,否则使用直接工具调用。 |
+| 写入或审批敏感的操作 | 默认使用直接工具调用以保持清晰的授权边界。 |
+| 最终引用或原生产物校验 | 除非程序能保留原生输出并校验每一项必需内容,否则使用直接工具调用。 |
-## 配置编程式工具调用
+## 配置程序化工具调用
-将 `programmatic_tool_calling` 托管工具添加到请求中。然后在 `allowed_callers` 上为程序可调用的每个符合条件的工具设置。
+将 `programmatic_tool_calling` 托管工具 添加到请求中。然后在程序可以调用的每个符合条件的工具上设置 `allowed_callers` 。
启用程序化工具调用
@@ -67,15 +67,15 @@ OpenAI 会在全新且隔离的 V8 运行时中运行每个生成的程序。该
`allowed_callers` 控制模型如何调用工具:
-| 值 | 行为 |
+| 取值 | 行为 |
| ---------------------------- | ------------------------------------------------------- |
| 省略或 `["direct"]` | 模型可以直接调用该工具。 |
-| `["programmatic"]` | 只有代码中的 `program` 项才能调用该工具。 |
+| `["programmatic"]` | 只有 `program` item 中的代码才能调用该工具。 |
| `["direct", "programmatic"]` | 模型可以直接或通过程序调用该工具。 |
-`parameters` 描述函数参数。当函数返回可预测的结构化数据时, `output_schema` 描述其 `function_call_output.output` 字符串中编码的 JSON 对象。同时定义二者,以便生成的 JavaScript 能可靠地使用返回的字段。
+`parameters` 描述函数参数。当函数返回可预测的结构化数据时, `output_schema` 描述其字符串中编码的 JSON 对象。 `function_call_output.output` 同时定义两者,以便生成的 JavaScript 能够可靠地使用返回的字段。
-### 支持的平台
+### 支持的工具
以下工具类型支持 `allowed_callers: ["programmatic"]`:
@@ -85,17 +85,17 @@ OpenAI 会在全新且隔离的 V8 运行时中运行每个生成的程序。该
- 本地和托管 `shell`
- `code_interpreter`
-对于 MCP 工具,该工具的 `require_approval` 策略可以暂停程序,直到你批准该调用。
+对于 MCP 工具,工具的 `require_approval` 策略可以暂停程序,直到你批准该调用。
-对于 OpenAI 托管的工具,在程序中启用前,请查阅工具的数据保留和安全指南。
+对于 OpenAI 托管工具,请在程序中启用前查看该工具的数据保留和安全指引。
-### 与工具搜索结合
+### 与工具搜索结合使用
-[工具搜索](https://developers.openai.com/api/docs/guides/tools-tool-search) 作为顶层 Responses API 工具运行,而不是从生成的 JavaScript 内部运行。具有 `defer_loading: true` 的函数、自定义和 MCP 工具最初不适用于程序。模型加载匹配的工具后,后续程序可通过 `tools.*` 在其 `allowed_callers` 包含 `"programmatic"`。时调用它。已运行的程序无法调用工具搜索,因此模型必须在启动需要它们的程序之前加载延迟工具。
+[工具搜索](https://developers.openai.com/api/docs/guides/tools-tool-search) 作为顶层 Responses API 工具运行,而不是在生成的 JavaScript 内部运行。函数、自定义和 MCP 工具,除非 `defer_loading: true` 最初对程序不可用。模型加载匹配的工具后,后续程序可以通过 `tools.*` 调用它,当其 `allowed_callers` 包含 `"programmatic"`。时。已经运行的程序无法调用工具搜索,因此模型必须在启动需要延迟加载工具的程序之前先加载它们。
-## 两种模式均可用时的指南路由
+## 在两种模式都可用时指导路由
-当你的应用程序允许模型直接或从程序调用某个函数时,请将每条路由分配给特定的工作流阶段。像“高效使用程序化工具调用”这样的通用指令并不能指明预期的边界。例如:
+当你的应用让模型直接或通过程序调用函数时,将每个路由分配到一个特定的工作流阶段。像“高效地使用程序化工具调用”这类通用指令并不能明确指出预期的边界。例如:
```text
@@ -114,7 +114,7 @@ Use direct tool calls for [semantic judgment, approval, or final validation].
```
-以下是使用此模板的示例:
+下面是使用此模板的示例:
```text
@@ -136,21 +136,21 @@ Use direct tool calls only for approval before any inventory-changing action.
```
-对于需要两种模式的工作流,请定义一个交接,并避免切换路由或重复工作。如果存在安全的回退方案,请定义一次并限制其重试次数。
+对于同时需要两种模式的交接,请定义一次交接并避免切换路由或重复工作。如果存在安全的回退方案,请定义一次并限制其重试次数。
-## 了解程序响应条目
+## 了解程序响应项
-每次 API 调用仍返回标准的 [Responses API 对象](https://developers.openai.com/api/reference/resources/responses/methods/create)。程序化工具调用不会引入单独的响应封装。当模型使用程序化工具调用时,响应的 `output` 数组可以包含:
+每次 API 调用仍会返回标准的 [Responses API 对象](https://developers.openai.com/api/reference/resources/responses/methods/create)。Programmatic Tool Calling 不会引入单独的回包结构。当模型使用 Programmatic Tool Calling 时,响应的 `output` 数组可以包含:
-- 一个 `program` 包含所生成 JavaScript 的条目、一个 `call_id`,以及一个不透明的 `fingerprint` ,用于恢复或重放该程序。
-- 一个 `function_call` 由程序创建的条目。它有自己的 `call_id`,你的应用程序用它来返回函数结果。它的 `caller.caller_id` 与程序的 `call_id`.
-- 一个 `program_output` 包含程序最终结果和状态的条目。它的 `call_id` 与程序的 `call_id`,匹配,且其 `status` 为 `completed` 或 `incomplete`.
+- 一个 `program` 包含生成的 JavaScript 的项,a `call_id`,以及一个不透明的 `fingerprint` 用于恢复或重放程序。
+- 一个 `function_call` 程序生成的项。它有自己的 `call_id`,你的应用使用它来返回函数结果。它的 `caller.caller_id` 与程序的 `call_id`.
+- 一个 `program_output` 包含程序最终结果和状态的项。它的 `call_id` 与程序的 `call_id`,以及它的 `status` 为 `completed` 或 `incomplete`.
-这些是独立的顶级项,位于 `response.output`; `caller` 字段记录它们的执行关系。
+这些是 `response.output`;中的独立顶级项; `caller` 字段记录了它们的执行关系。
-例如,程序可以在你的应用运行时暂停, `get_inventory` 以及 `get_demand`:
+例如,程序可以在你的应用运行 `get_inventory` 和 `get_demand`:
-Program 和嵌套函数调用
+程序与嵌套函数调用时暂停
```json
[
@@ -187,9 +187,9 @@ Program 和嵌套函数调用
```
-这些示例仅展示了来自 `response.output`;的相关项;它们省略了周围的标准 Responses 对象。在你的应用返回嵌套函数结果后,后续响应可以包含完整的 `program_output` 项:
+这些示例仅展示了 `response.output`;中的相关项;省略了外层的标准 Responses 对象。在你的应用返回嵌套函数结果之后,后续响应可以包含完整的 `program_output` 项:
-Program 输出
+程序输出
```json
{
@@ -202,24 +202,24 @@ Program 输出
```
-中的 JSON 字符串 `program_output.result` 遵循你指令中的程序结果形状。周围的 `program_output` 项遵循上述 API 契约。这些是独立的契约。最终的 `message` 可以随程序输出或稍后的响应到达,因此请持续处理,直到收到该消息。
+中的 JSON 字符串遵循你指令中定义 `program_output.result` 的程序结果结构。外层的 `program_output` 项遵循上文所示的 API 契约。这些是相互独立的契约。最终的 `message` 可以随程序输出一起到达,也可以在后续响应中到达,因此请继续直到收到该消息。
-OpenAI 在托管运行时中运行模型生成的 JavaScript。你的应用执行返回的客户端拥有的函数调用;它不执行生成的 JavaScript。
+OpenAI 在托管运行时中执行模型生成的 JavaScript。你的应用执行返回的客户端自有函数调用;它不会执行生成的 JavaScript。
-将函数结果作为 `function_call_output`。返回。复制 `caller` ,不要修改。服务使用该值来恢复正确的程序。
+将函数结果作为 `function_call_output`。返回。原样拷贝函数调用 `caller` 中的值,不要修改它。服务将使用该值来恢复正确的程序。
-## 在客户端拥有的函数调用后继续
+## 在客户端自有函数调用之后继续
-当程序到达客户端拥有的工具时,它可以暂停多次。持续直到响应包含最终助手消息:
+程序在到达客户端拥有的工具时可能会暂停多次。请继续,直到响应中包含一条最终的助手消息:
-1. 使用允许编程调用的 托管工具和函数发送请求。
+1. 使用 托管工具 和允许程序化调用的函数发送请求。
1. 运行每个返回的客户端拥有的函数调用。
-1. 将每个函数结果与原始 `call_id` 和 `caller`.
-1. 在继续之前处理不完整的响应。
-1. 如果响应中没有待处理的 `function_call` 项且没有最终的 `message` 项,则从该响应继续。使用 `store: false`,重放其输出项;对于存储的响应,使用 `previous_response_id`.
-1. 当响应包含最终的 `message` 项时停止。读取 `response.output_text` 或消息的拒绝内容。
+1. 使用原始 ID 返回每个函数结果 `call_id` 和 `caller`.
+1. 在继续之前处理未完成的响应。
+1. 如果响应不包含待处理的 `function_call` items 并且没有最终 `message` 项时,从该响应继续。若使用 `store: false`,则回放其输出项;若使用存储的响应,则使用 `previous_response_id`.
+1. 当响应包含最终 `message` 项时停止。读取 `response.output_text` 或该消息的拒绝内容。
-以下示例使用 `store: false`,保留每个响应条目,并将每个函数结果返回给程序:
+以下示例使用 `store: false`,保留每个响应项,并将每个函数结果返回给程序:
运行程序化工具调用循环
@@ -460,41 +460,41 @@ while True:
```
-存储响应后,你可以从 `previous_response_id` 继续,而无需重新发送所有较早的响应条目。将新的 `function_call_output` 条目作为下一个输入。使用 `store: false`,时,按顺序重放完整序列,包括每个 `program`、推理、函数调用、函数调用输出,以及 `program_output` 条目。
+当你存储响应时,可以从 `previous_response_id` 处继续,而不是重新发送所有先前的响应项。将新的 `function_call_output` 项作为下一个输入发送。使用 `store: false`,按顺序回放完整序列,包括每个 `program`、推理、函数调用、函数调用输出和 `program_output` 项。
-对于无状态推理模型请求,重放每个返回的推理条目。每个条目默认包含 `encrypted_content` 。请参阅 [对话状态](https://developers.openai.com/api/docs/guides/conversation-state#manually-manage-conversation-state) 了解通用的无状态模式。
+对于无状态的推理模型请求,回放每个返回的推理项。每个项默认包含 `encrypted_content` 。参见 [会话状态](https://developers.openai.com/api/docs/guides/conversation-state#manually-manage-conversation-state) 了解通用无状态模式。
## 为程序设计工具
-- 返回结构化、紧凑的数据,让 JavaScript 无需解析叙述文本即可检查。
-- 使用 `output_schema` 来定义每个工具的预期返回字段和类型,并记录其错误行为。如果返回结构事先未知,请保持工具直接,以便模型可以检查结果。
-- 定义确切的程序结果结构和所需证据。当程序无法生成有效结果时,返回清晰的结构化失败信息。
-- 尽可能使函数调用幂等。重试或重放不应重复不安全的副作用。
-- 即使调用来自托管程序,也要在你的应用程序中检查每次调用的参数和权限。
-- 为工具提供具体的名称和描述,以便模型能够正确组合它们。
-- 无论调用者是谁,在高影响操作前都要求应用程序级别的批准。
+- 返回结构化、紧凑的数据,便于 JavaScript 在不解析文本的情况下进行检查。
+- 使用 `output_schema` 来定义每个工具期望的返回字段和类型,并记录其错误行为。如果返回结构无法提前确定,请保持工具直接调用,以便模型可以检查结果。
+- 定义精确的程序结果结构和所需的证据。当程序无法产生有效结果时,返回明确的结构化失败。
+- 尽可能让函数调用具备幂等性。重试或重放不应重复不安全的副作用。
+- 在应用程序中为每次调用检查参数和权限,即使调用来自托管程序。
+- 为工具提供明确的名称和描述,以便模型能够正确地组合它们。
+- 无论调用方是谁,在执行高影响操作前都需要应用层面的审批。
{/* vale Vale.Terms = NO */}
-## 评估编程式工具调用
+## 评估程序化工具调用
-程序化工具调用可以减少添加到模型上下文中的中间工具输出量,但效果取决于任务和工具响应。以直接工具调用作为基线开始,然后在代表性任务上比较这两种方法。
+程序化工具调用可以减少添加到模型上下文中的中间工具输出量,但实际效果取决于任务和工具响应。先以直接工具调用作为基线,然后在代表性任务上对比两种方法。
-在衡量效率之前,定义最终答案的质量标准和所需证据。评估令牌使用和工具调用,同时评估正确性、完整性和证据覆盖范围,并对任何接受的质量权衡进行明确说明。
+在衡量效率之前,先明确最终答案的质量标准和所需证据。在评估 token 使用量和工具调用次数的同时,也要评估正确性、完整性和证据覆盖度,并明确说明任何已被接受的质量权衡。
{/* vale Vale.Terms = YES */}
-衡量:
+衡量指标:
-- 最终答案的正确性、完整性以及证据覆盖范围。
+- 最终答案的正确性、完整性和证据覆盖度。
- 输入和总 token 数、端到端延迟以及成本。
-- 模型回合、工具调用、重试以及恢复行为。
-- 安全结果,尤其是副作用和审批要求方面的结果。
-- 实际运行的路由是否与预期的 工作流 阶段相匹配。
+- 模型轮次、工具调用、重试以及恢复行为。
+- 安全结果,特别是副作用和审批要求相关的结果。
+- 实际运行的路径是否与预期的工作流阶段匹配。
## 相关指南
-- 使用 [函数调用](https://developers.openai.com/api/docs/guides/function-calling) 来定义客户端拥有的函数。
-- 使用 [工具搜索](https://developers.openai.com/api/docs/guides/tools-tool-search) 来延迟加载大型工具定义,直到模型需要它们。
-- 使用 [对话状态](https://developers.openai.com/api/docs/guides/conversation-state) 来延续存储的或无状态的 Responses API 请求。
-- 在选择存储模式之前,请查看 [数据控制](https://developers.openai.com/api/docs/guides/your-data) 。
\ No newline at end of file
+- 使用 [function calling](https://developers.openai.com/api/docs/guides/function-calling) 以定义客户端拥有的函数。
+- 使用 [工具搜索](https://developers.openai.com/api/docs/guides/tools-tool-search) 以将大型工具定义延迟到模型需要时再加载。
+- 使用 [会话状态](https://developers.openai.com/api/docs/guides/conversation-state) 以继续存储的或无状态的 Responses API 请求。
+- 查看 [数据控制](https://developers.openai.com/api/docs/guides/your-data) ,再选择存储模式。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/tools-shell.md b/docs/zh/api/docs/guides/tools-shell.md
index be915a8..7aeb4bc 100644
--- a/docs/zh/api/docs/guides/tools-shell.md
+++ b/docs/zh/api/docs/guides/tools-shell.md
@@ -1,27 +1,27 @@
# Shell
-> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt). 你也可以在页面 URL 末尾追加 `.md` 以获取该页的 Markdown 版本。
-shell 工具让模型能够在完整的终端环境中工作。我们支持 shell 用于本地执行以及通过 Responses API 进行托管执行。
+shell 工具使模型能够在完整的终端环境中工作。我们支持本地执行的 shell,以及通过 Responses API 进行的托管执行。
shell 工具允许模型通过以下任一方式运行命令:
-- 由 OpenAI 管理的托管 shell 容器。
-- [本地 shell 运行时](#local-shell-mode) 由你自行托管和执行。
+- 由 OpenAI 管理的托管 Shell 容器。
+- [本地 Shell 运行时](#local-shell-mode) 由你自己托管和执行。
-Shell 可通过 [Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses)。使用,但不可通过 Chat Completions API 使用。
+Shell 可通过 [Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses)。使用。它不通过 Chat Completions API 提供。
-运行任意 shell 命令可能很危险。务必在沙箱中执行,
- 尽可能使用允许列表或拒绝列表,并记录工具活动以供
+运行任意 shell 命令可能存在危险。请务必对执行进行沙箱隔离,
+ 在可行的情况下使用允许列表或拒绝列表,并记录工具活动以便
审计。
## 托管 shell 快速入门
-托管 Shell 是一种原生且精简的选项,适用于需要更丰富、确定性处理的任务,从运行计算到处理多媒体均可。
+托管 Shell 是一种原生且简化的选项,适用于需要更丰富、确定性更强的处理任务,从运行计算到处理多媒体。
-当你希望 `container_auto` OpenAI 为请求配置并管理容器时,请使用。
+使用 `container_auto` 当你希望 OpenAI 为该请求配置并管理容器时。
-带有 container_auto 的 Shell 工具
+使用 container_auto 的 Shell 工具
```bash
curl -L 'https://api.openai.com/v1/responses' \
@@ -165,12 +165,12 @@ puts(response.output_text)
- 运行时当前基于 `Debian 12` ,并可能随时间变化。
- 默认工作目录为 `/mnt/data`.
-- `/mnt/data` 始终存在,是用户可下载制品的受支持路径。
+- `/mnt/data` 始终存在,并且是支持的用户可下载制品的路径。
- 托管 shell 不支持交互式 TTY 会话。
-- 托管 shell 命令不通过 `sudo`.
-- 当你的工作流需要服务时,你可以在容器内运行它们。
+- 托管 shell 命令不使用 `sudo`.
+- 当你的工作流需要时,你可以在容器内运行服务。
-当前预装的语言包括:
+当前预装语言包括:
- Python `3.11`
- Node.js `22.16`
@@ -181,11 +181,11 @@ puts(response.output_text)
## 跨请求复用容器
-如果你需要一个长期运行的环境来进行迭代式工作流,可以先创建一个容器,然后在后续的 Responses API 调用中引用它。
+如果需要用于迭代工作流的长时间运行环境,可以创建一个容器,然后在后续的 Responses API 调用中引用它。
-### 1. 创建容器
+### 1. 创建一个容器
-创建可复用的容器
+创建一个可复用的容器
```bash
curl -L 'https://api.openai.com/v1/containers' \
@@ -285,7 +285,7 @@ puts(container.id)
### 2. 在 Responses 中引用容器
-使用带有 container_reference 的 shell
+使用 shell 与 container_reference
```bash
curl -L 'https://api.openai.com/v1/responses' \
@@ -413,13 +413,13 @@ puts(response.output_text)
```
-## 附加技能
+## Attach skills
-技能是可复用、带版本号的捆绑包,你可以将其挂载到托管 Shell 环境中。这定义了可用的技能,在 Shell 执行时,模型会决定是否调用它们。
+Skills 是可复用的、带有版本管理的资源包,你可以在托管 shell 环境中挂载它们。该字段用于定义可用的 skills,在 shell 执行时由模型决定是否调用它们。
-有关上传和版本管理的详细信息,请参阅 [技能指南](https://developers.openai.com/api/docs/guides/tools-skills) 。
+请参阅 [Skills 指南](https://developers.openai.com/api/docs/guides/tools-skills) 了解上传和版本管理的详细信息。
-创建带附加技能的容器
+创建一个挂载了 skills 的容器
```bash
curl -L 'https://api.openai.com/v1/containers' \
@@ -558,10 +558,10 @@ puts(container.id)
托管容器默认没有出站网络访问权限。
-要启用它:
+启用方法:
-1. 管理员必须在仪表盘中配置你所在组织的允许列表。
-2. 你必须显式设置 `network_policy` 在请求中的容器环境上。
+1. 管理员必须在控制台中配置你组织的允许列表。
+2. 你必须显式设置 `network_policy` 于请求中的容器环境上。
带网络白名单的 Shell 工具
@@ -752,34 +752,34 @@ puts(response.output_text)
```
-设置域名白名单会引入诸如提示词
- 注入驱动的数据外泄等安全风险。只白名单化你信任的且攻击者
- 无法用于接收外泄数据的域名。请仔细审查 [风险
- 与安全](#risks-and-safety) 部分后再使用此工具。
+将域名加入白名单会引入安全风险,例如通过提示词注入进行的数据外泄。仅将你信任的、且攻击者无法用来接收外泄数据的域名加入白名单。使用此工具前,请仔细查看下方
+ 的
+ 风险与安全 [风险
+ 与安全](#risks-and-safety) 章节。
## 网络策略优先级
当存在多个控件时:
- 你的组织允许列表定义了完整的 `allowed_domains`.
-- 请求级 `network_policy` 进一步限制访问。
-- 如果 `allowed_domains` 包含组织允许列表之外的域,请求将会失败。
+- 请求级别 `network_policy` 进一步限制访问。
+- 如果请求 `allowed_domains` 包含组织允许列表之外的域名,则请求失败。
## 数据保留与容器生命周期
-托管 Shell 和代码解释器使用的托管容器在容器活动期间可能会将临时应用程序状态写入容器文件系统(由临时块存储支持)。容器到期或被明确删除时,容器数据将被删除。
+Hosted Shell 和 Code Interpreter 使用的托管容器在容器处于活动状态时,可能会将临时应用状态写入容器文件系统(由临时块存储提供支持)。容器数据会在容器到期或被显式删除时被删除。
-有关数据控制的更多详细信息,请参阅 [ZDR 和数据驻留](https://developers.openai.com/api/docs/guides/your-data).
+有关数据控制的更多详情,请参阅 [ZDR 和数据驻留](https://developers.openai.com/api/docs/guides/your-data).
-### 下载工件
+### Download artifacts
-托管 shell 可以生成可下载的文件。使用与代码解释器相同的容器/文件 API 来检索写入以下路径的工件 `/mnt/data`.
+Hosted shell 可以生成可下载的文件。使用与 code interpreter 相同的容器/文件 API 来检索写入以下路径的制品 `/mnt/data`.
### 其他数据控制
-如果希望内容和文件在托管生命周期内保持临时性,可以在请求中内联文件,并在容器中挂载内联技能。
+如果你希望内容和文件在托管生命周期内保持临时性,可以在请求中内联文件,并在容器中挂载内联 skills。
-使用内联文件和内联技能
+使用内联文件和内联 skills
```bash
INLINE_ZIP=$(base64 -i ./csv_insights.zip)
@@ -959,11 +959,11 @@ print(response.output_text)
```
-对于后续请求,传递相同的 `container_id` 以及 `container_reference`。在容器处于活动状态期间,挂载的技能和现有容器文件仍然可用。
+对于后续请求,请传递相同的 `container_id` 以及 `container_reference`。在容器处于活动状态期间,挂载的 skills 和现有容器文件始终可用。
### 主动删除容器
-工作完成后,你可以显式删除容器,而不必等待不活动过期。
+你可以在工作完成后显式删除容器,而不必等待不活动过期。
删除容器
@@ -1033,25 +1033,25 @@ puts("Deleted container_id")
```
-## 域机密
+## 域密钥
-使用 `domain_secrets` 当你的 `allowed_domains` 列表中的某个域需要私有授权标头时,例如 `Authorization: Bearer `.
+使用 `domain_secrets` 当你的 `allowed_domains` 列表中需要私有授权请求头时,例如 `Authorization: Bearer `.
-每个密钥条目包括:
+每个 secret 条目包含:
- 目标域名
-- 友好密钥名称
+- 友好的密钥名称
- 密钥值
在运行时:
-- 模型和运行时看到的是占位符名称(例如, `$API_KEY`)而不是原始凭证。
-- 认证转换 sidecar 仅对批准的接收方应用原始秘密值。
-- 原始秘密值不会持久化在 API 服务器上,也不会出现在模型可见的上下文中。
+- 模型和运行时看到的是占位符名称(例如, `$API_KEY`)而不是原始凭据。
+- 鉴权转换 sidecar 仅对经过批准的目标应用原始密钥值。
+- 原始密钥值不会在 API 服务器上持久化,也不会出现在模型可见的上下文中。
-这让智能体可以调用受保护的服务,同时降低泄露风险。
+这让助手可以调用受保护的服务,同时降低信息泄露的风险。
-带 domain_secrets 的 Shell 工具
+使用 domain_secrets 的 Shell 工具
```bash
curl -L 'https://api.openai.com/v1/responses' \
@@ -1278,9 +1278,9 @@ puts(response.output_text)
## 多轮工作流
-要在同一托管环境中继续工作,请复用容器并传递 `previous_response_id`.
+要在同一托管环境中继续工作,请重复使用该容器并传入 `previous_response_id`.
-延续一个 shell 工作流
+继续 shell 工作流
```bash
curl -L 'https://api.openai.com/v1/responses' \
@@ -1423,12 +1423,12 @@ puts(response.output_text)
## Responses 中的 Shell 输出
-托管 shell 和本地 shell 使用相同的输出项类型。Shell 运行由成对的输出项表示:
+托管 shell 和本地 shell 使用相同的输出项类型。Shell 运行由配对的输出项表示:
- `shell_call`: 模型请求的命令。
- `shell_call_output`: 命令输出和退出结果。
-示例 shell_call 项
+Example shell_call item
```json
{
@@ -1444,11 +1444,11 @@ puts(response.output_text)
```
-## 本地 Shell 模式
+## 本地 shell 模式
-你还可以通过执行 `shell_call` 操作并在自己的本地运行时中运行 shell 命令,将 `shell_call_output` 发送回模型。
+你也可以在本地运行时中执行 shell 命令,通过执行 `shell_call` 操作并将结果 `shell_call_output` 发送回模型。
-当你需要完全控制执行环境、文件系统访问或现有的内部工具时,请使用此模式。
+当你需要对执行环境、文件系统访问或现有内部工具拥有完全控制权时,请使用此模式。
本地 shell 请求
@@ -1566,10 +1566,10 @@ puts(response.output)
当你收到 `shell_call` 输出项时:
- 在你的运行时中执行请求的命令。
-- 捕获 `stdout`, `stderr`,和结果。
-- 在下一次请求中返回结果作为 `shell_call_output` 。
+- 捕获 `stdout`, `stderr`,以及结果。
+- 以 `shell_call_output` 的形式在下一个请求中返回。
-本地 Shell 执行器示例
+本地 shell 执行器示例
```javascript
import { exec as execCallback } from "node:child_process";
@@ -1735,7 +1735,7 @@ puts(ShellExecutor.new.run("printf shell-executor-ready"))
```
-示例 shell_call_output 负载
+shell_call_output 负载示例
```json
{
@@ -1763,13 +1763,13 @@ puts(ShellExecutor.new.run("printf shell-executor-ready"))
```
-关于旧版迁移详情,请参阅 [本地 Shell 指南](https://developers.openai.com/api/docs/guides/tools-local-shell).
+有关旧版迁移的详细信息,请参阅旧版 [Local shell 指南](https://developers.openai.com/api/docs/guides/tools-local-shell).
-## 使用本地 shell 搭配 Agents SDK
+## 使用本地 shell 与 Agents SDK
-如果你正在使用 [Agents SDK](https://developers.openai.com/api/docs/guides/tools#usage-in-the-agents-sdk),你可以将自己的 shell 执行器实现传递给 shell 工具辅助函数。
+如果你使用的是 [Agents SDK](https://developers.openai.com/api/docs/guides/tools#usage-in-the-agents-sdk),可以将你自己的 shell 执行器实现传递给 shell 工具助手。
-使用本地 shell 与 Agents SDK
+在 Agents SDK 中使用本地 shell
```javascript
import { Agent, run, withTrace, shellTool } from "@openai/agents";
@@ -1871,7 +1871,7 @@ if __name__ == "__main__":
```
-你可以在 SDK 仓库中找到可用的示例。
+你可以在 SDK 仓库中找到可运行的示例。
[Shell 工具示例 - TypeScript
@@ -1887,29 +1887,29 @@ if __name__ == "__main__":
## 处理常见错误
-- 如果命令执行超过超时时间,返回超时结果并包含部分捕获的输出。
-- 如果 `max_output_length` 存在于 `shell_call`,则将其包含在 `shell_call_output`.
-- 不要依赖交互式命令;shell 工具执行应是非交互式的。
-- 保留非零退出输出,以便模型能够推理恢复步骤。
+- 如果某个命令超出你的执行超时时间,请返回超时结果并包含已捕获的部分输出。
+- 如果 `max_output_length` 中包含在 `shell_call`,请将其包含在 `shell_call_output`.
+- 不要依赖交互式命令;shell 工具的执行应当是非交互式的。
+- 保留非零退出输出,以便模型可以推理恢复步骤。
## 风险与安全
-在 Containers API 中启用网络访问是一项强大的功能,但它也带来了重大的安全和数据治理风险。默认情况下,网络访问未启用。启用后,出站访问应严格限制在任务所需的受信任域内。
+在 Containers API 中启用网络访问是一项强大的能力,但它会带来显著的安全与数据治理风险。默认情况下,网络访问并未启用。启用后,外部访问应严格限定在任务所需的可信域名范围内。
-启用网络的容器可以与第三方服务和软件包注册表交互。这会带来数据泄露、提示注入驱动的工具滥用以及意外越界访问等风险。当策略过于宽泛、静态或不一致执行时,这些风险会增加。
+启用网络访问的容器可与第三方服务和软件包注册中心交互。这会带来包括数据泄露、提示注入驱动的工具误用,以及意外超出预期边界的访问等风险。当策略过于宽泛、静态或执行不一致时,这些风险会进一步加剧。
-#### 了解网络检索内容带来的提示注入风险
+#### 了解网络检索内容中的提示注入风险
-通过网络获取的任何外部内容都可能包含旨在操纵模型行为的隐藏指令。将不受信任的网络内容视为潜在对抗性内容,并对可能修改数据或系统的操作需要格外谨慎。
+任何通过网络获取的外部内容都可能包含旨在操纵模型行为的隐藏指令。应将不可信的网络内容视为潜在的对抗性内容,并在执行可能修改数据或系统的操作时格外谨慎。
#### 仅连接到受信任的目标
-仅允许你信任并积极维护的域名。对于代理到其他服务的中介和聚合器要保持谨慎,在将其添加到你的允许域名列表之前,请审查其数据处理和保留实践。
+仅允许你信任且持续维护的域名。对于代理其他服务的中间商和聚合服务要保持谨慎,在将其加入允许的域名列表之前,请先审核它们的数据处理和保留实践。
-#### 在请求执行前后内置审查
+#### 在请求执行前后内置审查环节
-查看Responses API响应中提供的shell工具命令和执行输出。捕获每个会话请求的主机和实际出站目的地。定期审查日志,以验证访问模式是否符合预期、检测偏差并识别可疑行为。
+查看 shell 工具命令及执行输出,这些内容在 Responses API 响应中提供。记录每个会话的请求主机和实际出站目的地。定期审查日志以验证访问模式是否符合预期、检测偏差并识别可疑行为。
-#### 验证数据驻留和保留要求
+#### 验证数据驻留与保留要求
-[OpenAI 数据控制](https://developers.openai.com/api/docs/guides/your-data) 在 OpenAI 边界内适用。但是,通过网络连接传输给第三方服务的数据受其数据保留策略的约束。请确保外部端点满足你的驻留、保留和合规要求。
\ No newline at end of file
+[OpenAI 数据控制](https://developers.openai.com/api/docs/guides/your-data) 仅在 OpenAI 范围内生效。但是,通过网络连接传输到第三方服务的数据将受其数据保留策略约束。请确保外部端点符合你的驻留、保留和合规要求。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/tools-tool-search.md b/docs/zh/api/docs/guides/tools-tool-search.md
index 4221d00..6cbcb77 100644
--- a/docs/zh/api/docs/guides/tools-tool-search.md
+++ b/docs/zh/api/docs/guides/tools-tool-search.md
@@ -1,25 +1,25 @@
-# 工具搜索
+# Tool search
-> 如需完整的文档索引,请参见 [llms.txt](/llms.txt)。各文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 完整文档索引请参阅 [llms.txt](/llms.txt). 页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。
-工具搜索允许模型在需要时动态搜索工具并将其加载到模型的上下文中。这样可以避免一开始就将所有工具定义加载到模型的上下文中, **并可能有助于减少总体令牌使用量和成本**。为了获得最佳成本和延迟,工具搜索设计为 **保留模型的缓存**。当模型发现新工具时,它们会被注入到上下文窗口的末尾。
+Tool search 允许模型根据需要动态搜索并将工具加载到模型的上下文中。这样可以避免预先将所有工具定义加载到模型的上下文中,并且 **有助于降低整体的 token 用量和成本**。为了在成本和延迟方面达到最佳效果,tool search 旨在 **保留模型的缓存**。当模型发现新工具时,这些工具会被注入到上下文窗口的末尾。
仅 `gpt-5.4` 及更高版本的模型支持 `tool_search`.
-要激活工具搜索,你必须做两件事:
+要启用 tool search,你需要完成两件事:
-1. 添加 `tool_search` 作为工具放入你的 `tools` 数组中。
-2. 如果你在使用 [functions](https://developers.openai.com/api/docs/guides/function-calling#defining-functions),请用 `defer_loading: true`。标记你想要延迟的那些。如果你在使用 [MCP servers](https://developers.openai.com/api/docs/guides/tools-connectors-mcp),在 MCP 服务器工具定义上设置 `defer_loading: true` 。
+1. Add `tool_search` 作为工具添加到你的 `tools` 数组中。
+2. 如果你使用的是 [functions](https://developers.openai.com/api/docs/guides/function-calling#defining-functions),请将需要延迟的工具标记为 `defer_loading: true`。如果你使用的是 [MCP servers](https://developers.openai.com/api/docs/guides/tools-connectors-mcp),请在 MCP 服务器工具定义上设置 `defer_loading: true` 。
### 尽可能使用命名空间
-您可以结合延迟的 [函数](https://developers.openai.com/api/docs/guides/function-calling#defining-functions), [命名空间](https://developers.openai.com/api/docs/guides/function-calling#defining-namespaces),或 [MCP 服务器](https://developers.openai.com/api/docs/guides/tools-connectors-mcp),但我们建议在可能的情况下使用命名空间或 MCP 服务器。我们的模型主要经过训练以搜索这些表面,并且在此处的令牌节省通常更可观。
+你可以使用带延时的工具搜索(tool search)与延迟(deferred) [函数](https://developers.openai.com/api/docs/guides/function-calling#defining-functions), [命名空间](https://developers.openai.com/api/docs/guides/function-calling#defining-namespaces),或 [MCP 服务器](https://developers.openai.com/api/docs/guides/tools-connectors-mcp),但我们建议尽可能使用命名空间或 MCP 服务器。我们的模型主要针对这些表面进行训练,并且在这些场景下的 token 节省通常更为可观。
-对于命名空间, `defer_loading` 适用于命名空间内的函数,而不是命名空间对象本身。
+对于命名空间, `defer_loading` 适用于命名空间内的函数,而不适用于命名空间对象本身。
-在请求开始时,模型仍然会看到可搜索内容的名称和描述。对于命名空间或 MCP 服务器,这意味着模型在开始时仅看到命名空间或服务器名称和描述,而不会显示其中包含的各个函数的详细信息,直到工具搜索工具加载它们。对于单独的延迟函数,模型仍然会看到函数名称和描述,因此实际上工具搜索主要是在延迟参数模式。
+在请求开始时,模型仍然可以看到所有可搜索内容的名称和描述。对于命名空间或 MCP 服务器来说,这意味着模型在开始时只能看到命名空间或服务器的名称与描述,而不会显示其内部各个函数的详细信息,直到工具搜索工具加载它们为止。对于单个延迟函数,模型仍然可以看到函数名称和描述,因此在实践中,工具搜索主要是在延迟参数 schema 的加载。
-为了最大程度地节省令牌,我们建议将延迟函数分组到具有清晰、高级描述的命名空间或 MCP 服务器中,以便让模型对其中包含的内容有很好的概述,从而可以有效地搜索和仅加载相关函数。作为最佳实践,尽量将每个命名空间保持少于 10 个函数,以获得更好的令牌效率和模型性能。
+为了最大限度地节省 token,我们建议将延迟函数分组到具有清晰高层描述的命名空间或 MCP 服务器中,从而为模型提供其所含内容的整体概览,使其能够有效地搜索并仅加载相关函数。最佳实践是,尽量将每个命名空间中的函数控制在 10 个以下,以获得更好的 token 效率和模型性能。
```json
{
@@ -57,23 +57,23 @@
```
-命名空间可以混合使用延迟和不延迟的工具。没有 `defer_loading: true` 的工具可以立即调用,而同一命名空间中的延迟工具则通过工具搜索加载。
+命名空间可以混合包含延迟和非延迟的工具。未设置 `defer_loading: true` 的工具可以立即调用,而同一命名空间中的延迟工具则通过工具搜索加载。
-### 工具搜索类型
+### Tool search types
使用工具搜索有两种方式:
-- **托管工具搜索:** OpenAI 会在你在请求中声明的延迟工具中进行搜索,并在同一响应中返回加载的子集。
-- **客户端执行工具搜索:** 模型发出 `tool_search_call`,你的应用程序执行查找,然后你返回匹配的 `tool_search_output`.
+- **托管工具搜索:** OpenAI 会在请求中声明的延迟工具中进行搜索,并在同一响应中返回已加载的子集。
+- **客户端执行的工具搜索:** 模型发出一个 `tool_search_call`,由你的应用执行查找,并返回一个匹配的 `tool_search_output`.
-如果在创建请求时候选工具已经明确,请从托管工具搜索开始。
- 在需要工具发现时,使用客户端执行的工具搜索。
- 取决于项目状态、租户状态或你的应用程序所控制的另一个系统
- 。
+如果在你创建请求时候选工具已经确定,请从 托管工具 search 开始。
+ 当工具发现依赖于项目状态、租户状态或你的应用程序控制的
+ 其他系统时,请使用客户端执行的工具搜索。
+ 系统时使用客户端执行的工具搜索。
## 托管工具搜索
-当你已经知道完整的 [函数](https://developers.openai.com/api/docs/guides/function-calling#defining-functions), [命名空间](https://developers.openai.com/api/docs/guides/function-calling#defining-namespaces),列表,或 [MCP 服务器](https://developers.openai.com/api/docs/guides/tools-connectors-mcp) 清单时,托管工具搜索是最简单的路径。你提前声明它们,添加 `{"type": "tool_search"}`,然后让 API 决定加载什么。
+当你已经清楚想要模型搜索的完整工具清单时,托管工具搜索是最简单的途径。你可以预先声明这些工具,添加 [函数](https://developers.openai.com/api/docs/guides/function-calling#defining-functions), [命名空间](https://developers.openai.com/api/docs/guides/function-calling#defining-namespaces),或 [MCP 服务器](https://developers.openai.com/api/docs/guides/tools-connectors-mcp) ,让 API 自行决定加载哪些。 `{"type": "tool_search"}`, and let the 接口 decide what to load.
配置 托管工具 搜索
@@ -337,10 +337,10 @@ puts(response.output)
```
-如果模型决定需要延迟工具,响应中会在最终函数调用之前包含两个额外的输出项:
+如果模型判定需要某个延迟加载的工具,响应会在最终函数调用之前包含两个额外的输出项:
-- `tool_search_call`,其中记录了托管搜索步骤。
-- `tool_search_output`,其中包含已加载且可调用的子集。
+- `tool_search_call`,用于记录托管搜索步骤。
+- `tool_search_output`,其中包含已加载的、可被调用的子集。
托管工具搜索响应
@@ -399,15 +399,15 @@ puts(response.output)
```
-在托管模式下, `execution` 被设置为 `server` 以及 `call_id` 被设置为 `null`.
+在托管模式下, `execution` 被设置为 `server` 和 `call_id` 被设置为 `null`.
-对于更复杂的任务,模型还可以在同一个 `tool_search_call`。中加载多个命名空间或 MCP 服务器。例如,如果它需要来自不同命名空间的函数来完成一个任务,它可能会选择在后续函数调用之前一起搜索并加载这些表面。
+对于更复杂的任务,模型还可以在同一次 `tool_search_call`。中加载多个命名空间或 MCP 服务器。例如,如果它需要来自不同命名空间的函数来完成一项任务,可以选择先一起搜索并加载这些接口,然后再发起后续的函数调用。
## 客户端执行的工具搜索
-客户端执行的工具搜索让您的应用完全控制工具发现的工作方式。当可用工具依赖于在初始中声明不切实际的信息时,这非常有用 `tools` 列表。
+客户端执行的工具搜索让你的应用可以完全掌控工具发现的方式。当可用工具依赖于在初始请求中不便声明的信息时,这种方式非常有用。 `tools` 列表。
-配置 `tool_search` 工具与 `execution: "client"` 以及您的应用期望的搜索参数架构:
+使用以下方式配置该 `tool_search` 工具,并提供 `execution: "client"` 以及你的应用所期望的搜索参数 schema:
配置客户端执行的工具搜索
@@ -773,7 +773,7 @@ end
```
-在第一轮,模型发出一个 `tool_search_call` 并在那里停止:
+在第一轮中,模型会发出一个 `tool_search_call` 并在此停止:
客户端工具搜索调用
@@ -792,7 +792,7 @@ end
```
-然后,您的应用程序执行搜索并返回一个 `tool_search_output` 使用它想要加载的工具:
+然后你的应用执行搜索并返回 `tool_search_output` 其中包含它想要加载的工具:
返回 tool_search_output
@@ -826,7 +826,7 @@ end
在下一轮中,加载的工具可以像普通函数一样被调用:
-加载的函数调用
+已加载的函数调用
```json
[
@@ -841,31 +841,31 @@ end
```
-在客户端模式下, `execution` 设置为 `client` 并且 `call_id` 已定义。从 `call_id` 中回显相同的 `tool_search_call` 在你的 `tool_search_output`.
+在客户端模式下, `execution` 被设置为 `client` 和 `call_id` 已定义。回显相同的 `call_id` 来自 `tool_search_call` 在你的 `tool_search_output`.
## 高级用法
### 保持命名空间描述清晰
-让命名空间描述清晰且能说明其用例,因为模型依赖该描述来决定何时加载该命名空间中的函数子集。避免过长的描述。相反,将更丰富的细节放在按需加载的延迟函数描述中。
+让命名空间描述清晰并能体现其用例,因为模型依赖该描述来决定何时加载该命名空间中的函数子集。避免使用过长的描述,而是将更丰富的信息放在按需加载的延迟函数描述中。
### 了解加载的内容
-`tool_search_output.tools` 包含模型动态加载的工具列表。模型在后续轮次中将能调用这些工具中的任何一个,因此在客户端模式下,你无需在每一轮中重新加载相同的工具。未列入此数组的工具将不可供模型使用。如果你想禁用某个已加载的工具,可以从 `tool_search_output` 定义已加载工具集的条目中移除它,但请注意,更改已加载的工具集将从此处开始破坏模型的缓存。
+`tool_search_output.tools` 包含模型动态加载的工具列表。模型将在后续轮次中能够调用这些工具中的任何一个,因此在客户端模式下,你无需在多轮之间重复加载同一工具。未作为此数组一部分列出的工具将对模型不可用。如果你想禁用某个已加载的工具,可以从定义已加载工具集的 `tool_search_output` 项中移除它,但请注意,更改已加载工具集将从该点开始破坏模型的缓存。
### 高级注入模式
-大多数集成在请求的 `tools` 参数中声明工具。客户端执行的工具搜索还支持更高级的模式,即你的应用程序返回原始请求中不存在的工具。将其视为高级工作流:仔细验证返回的模式,并仅暴露受信任的工具定义。
+大多数集成在请求的 `tools` 参数中声明工具。由客户端执行的工具搜索还支持更高级的模式,允许你的应用返回原始请求中未包含的工具。请将此视为高级 工作流:务必仔细校验返回的 schema,并且只暴露受信任的工具定义。
### 工具搜索与缓存
-所有工具都在模型上下文窗口的末尾加载。这对托管工具搜索和客户端执行的工具搜索都适用。这使得模型的缓存可以在请求之间得以保留,从而降低总体成本并提高速度。
+所有工具都会在模型的上下文窗口末尾加载。托管工具 搜索和客户端执行的工具搜索都遵循此规则。这样可以使模型的缓存在多次请求之间得以保留,从而降低成本并提升速度。
### 在输入中的特定位置添加工具
-对于高级工作流,你可以使用 `additional_tools` 输入项,在对话的特定位置使工具可用。当你的应用在正常工具搜索流程之外加载工具,或需要保留之前响应中添加的工具顺序时,这很有用。
+对于高级工作流,你可以使用 `additional_tools` 输入项,使工具在对话中的特定位置可用。当你的应用在常规工具搜索流程之外加载工具,或者需要保留上一次响应中添加工具的顺序时,这非常有用。
-设置 `role` 为 `developer` ,并在该项的 `tools` 数组中包含要添加的工具:
+设置为 `role` 并将需要添加的工具放在该项的 `developer` 数组中: `tools` :
```json
{
@@ -890,9 +890,9 @@ end
```
-中的工具 `additional_tools` 仅在该项出现在输入中后才可用。当你手动往返对话项时,请保留该项的位置,以便模型在对话中的相同位置看到相同的工具。
+包含在 `additional_tools` 项中的工具仅在该项出现在输入中之后才可用。当你手动往返传递对话项时,请保留该项的位置,以便模型在对话中的同一位置看到相同的工具。
## 相关指南
-- 使用 [函数调用](https://developers.openai.com/api/docs/guides/function-calling) 来定义可调用函数和自定义工具。
-- 请参阅 [使用工具](https://developers.openai.com/api/docs/guides/tools) 了解 Responses 中更广泛的工具生态。
\ No newline at end of file
+- 使用 [function calling](https://developers.openai.com/api/docs/guides/function-calling) 来定义可调用的函数和自定义工具。
+- 使用 [使用工具](https://developers.openai.com/api/docs/guides/tools) 了解 Responses 中更广泛的工具生态。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/tools-web-search.md b/docs/zh/api/docs/guides/tools-web-search.md
index 2f8d447..c152276 100644
--- a/docs/zh/api/docs/guides/tools-web-search.md
+++ b/docs/zh/api/docs/guides/tools-web-search.md
@@ -1,26 +1,26 @@
# 网页搜索
-> 完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取文档页面的 Markdown 版本。
-网页搜索允许模型访问互联网上的最新信息,并提供带有引用来源的答案。要启用此功能,请在 Responses API 中使用 网页搜索 工具,或在某些情况下使用 Chat Completions。
+网页搜索允许模型从互联网获取最新信息,并提供带有来源引用的回答。要启用此功能,可在 Responses API 或在某些情况下在 Chat Completions 中使用 网页搜索 工具。
-OpenAI 模型提供三种主要的 网页搜索 类型:
+使用 OpenAI 模型可用的 网页搜索 主要有三种类型:
-1. 非推理型网页搜索:非推理模型将用户的查询发送给网页搜索工具,该工具基于顶部结果返回响应。没有内部规划,模型只是直接传递搜索工具的响应。这种方法速度快,非常适合快速查询。
-2. 使用推理模型进行智能体搜索是一种模型主动管理搜索过程的方法。它可以在思维链中执行网页搜索,分析结果,并决定是否继续搜索。这种灵活性使智能体搜索非常适合复杂的工作流,但也意味着搜索比快速查询耗时更长。例如,你可以在以下模型上调整推理等级 `gpt-5.5` 来同时改变搜索的深度和延迟。
-3. 深度研究是一种由智能体驱动的专用方法,用于推理模型进行深入、扩展的调查。模型在思维链中执行网页搜索,通常涉及数百个来源。深度研究可能运行几分钟,最适合在后台模式下使用。使用 `gpt-5.5` 并将推理设置为 `high` 或 `xhigh`.
+1. 非推理 网页搜索:非推理模型将用户的查询发送到 网页搜索 工具,该工具根据排名靠前的结果返回响应。该方法不进行内部规划,模型只是直接传递搜索工具的响应。这种方式速度快,非常适合快速查询。
+2. 使用推理模型进行智能体搜索是一种由模型主动管理搜索过程的方法。模型可以在其思维链中执行网页搜索,分析结果,并决定是否继续搜索。这种灵活性使智能体搜索非常适合复杂工作流,但也意味着搜索所需时间比快速查询更长。例如,你可以对以下模型调整推理级别 `gpt-5.5` 来同时改变搜索的深度和延迟。
+3. 深度研究是一种由推理模型驱动的、专门用于深入、长时间调查的 智能体 方法。模型会在其思维链中进行网页搜索,通常会查阅数百个来源。深度研究可能持续运行数分钟,最好与后台模式配合使用。可结合使用 `gpt-5.5` 并将推理设置为 `high` 或 `xhigh`.
-## 选择一个集成
+## 选择集成方式
-| 使用场景 | 推荐路径 | 备注 |
+| 用例 | 推荐路径 | 备注 |
| --------------------------------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| 新的网页搜索集成 | Responses API 搭配 `web_search` 和 `gpt-5.5` | 支持托管的网页搜索控制,如过滤器、来源、实时访问控制以及更长时间的研究运行 |
-| 现有的 Chat Completions 搜索集成 | Chat Completions 搭配 `gpt-5-search-api` | 仅当你需要保留 Chat Completions 集成时使用此路径 |
-| 多步骤研究或长时间运行的报告 | `gpt-5.5` 搭配 `high` 或 `xhigh` 推理 | 对于可能需要几分钟的报告,请使用后台模式 |
+| 新增 网页搜索 集成 | Responses API 配合 `web_search` 和 `gpt-5.5` | 支持托管 网页搜索 控制项,例如筛选器、来源、实时访问控制以及更长的研究运行 |
+| 现有的 Chat Completions 搜索集成 | Chat Completions 配合 `gpt-5-search-api` | 仅在需要保留 Chat Completions 集成时使用 |
+| 多步研究或长时间运行的报告 | `gpt-5.5` 配合 `high` 或 `xhigh` 推理 | 对于可能耗时数分钟的报告,请使用后台模式 |
-使用 [Responses API](https://developers.openai.com/api/reference/resources/responses),时,你可以通过在 `tools` 数组中配置 网页搜索,并在 API 请求中启用它来生成内容。与其他工具一样,模型可以根据输入提示词的内容选择是否进行网页搜索。
+使用 [Responses API](https://developers.openai.com/api/reference/resources/responses),你可以通过在 API 请求的数组中配置来启用网页搜索。 `tools` 与任何其他工具一样,模型可以根据输入提示的内容自行决定是否进行网页搜索。
-对于新的 Responses API 集成,请使用 `{ "type": "web_search" }`。较早的 `web_search_preview` 工具仍可用于旧版集成,但它不支持较新的控制项,例如 `filters`, `external_web_access`,以及 `return_token_budget`.
+对于新的Responses API集成,请使用 `{ "type": "web_search" }`。此前的 `web_search_preview` 工具仍然可用于旧版集成,但它不支持较新的控件,例如 `filters`, `external_web_access`,以及 `return_token_budget`.
网页搜索工具示例
@@ -157,19 +157,19 @@ YAML
使用网页搜索工具的模型响应将包含两个部分:
-- 一个 `web_search_call` 输出项包含搜索调用的 ID,以及所采取的操作 `web_search_call.action`。操作是以下之一:
- - `search`,代表网页搜索。它通常(但不总是)包含搜索 `queries` 被搜索的内容。搜索操作会产生工具调用费用(参见 [定价](https://developers.openai.com/api/docs/pricing#built-in-tools)).
- - `open_page`,代表打开页面。在推理模型中支持。
- - `find_in_page`,代表在页面内搜索。在推理模型中支持。
-- 一个 `message` 输出项包含:
+- 一个 `web_search_call` 包含搜索调用 ID 的输出项,以及所执行的操作 `web_search_call.action`。该操作是以下之一:
+ - `search`,表示一次网页搜索。通常(但不总是)包含搜索查询以及被搜索的域名列表。 `queries` 被搜索的内容。搜索操作会产生工具调用费用(参见 [定价](https://developers.openai.com/api/docs/pricing#built-in-tools)).
+ - `open_page`,表示打开了一个页面。推理模型支持此操作。
+ - `find_in_page`,表示在页面内进行搜索。推理模型支持此操作。
+- 一个 `message` 包含以下内容的输出项:
- 文本结果位于 `message.content[0].text`
- - 注释 `message.content[0].annotations` 用于引用的 URL
+ - 批注 `message.content[0].annotations` 中,用于引用来源的 URL
-默认情况下,模型的响应将包含 网页搜索结果中找到的 URL 的内联引用。除此之外, `url_citation` 注记对象将包含所引用来源的 URL、标题和位置。
+默认情况下,模型的响应将包含对 网页搜索 结果中所含 URL 的内联引用。除此之外, `url_citation` annotation 对象将包含所引用来源的 URL、标题和位置。
-当向最终用户显示网页结果或网页结果中包含的信息时
- 用户必须能够清晰看到并点击应用中的内联引用,
- 即在用户界面中。
+当向最终用户展示网页结果或网页结果中包含的信息时,
+ 内联引用必须在你的用户界面中清晰可见且可点击。
+ 用户界面。
```json
[
@@ -210,17 +210,17 @@ YAML
-## 从旧版网页搜索迁移
+## 从旧版 网页搜索 迁移
| 如果你使用 | 推荐路径 | 备注 |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `web_search_preview` 在 Responses 中 | 迁移到 `web_search` | `web_search` 支持更新的控制项,如 `filters`, `external_web_access`,以及 `return_token_budget` |
-| `gpt-4o-search-preview` 或 `gpt-4o-mini-search-preview` | 迁移到 Responses `web_search`,或使用 `gpt-5-search-api` 如果你必须继续使用 Chat Completions | 预览搜索模型已弃用,将于 2026-07-23 关闭 |
-| Chat Completions 搜索集成 | 使用 `gpt-5-search-api`,或迁移到 Responses `web_search` 以获得更多工具控制项和可选搜索 | Chat Completions 搜索模型在响应前始终进行搜索;Responses 搜索是一个工具 |
+| `web_search_preview` 在 Responses 中 | 迁移到 `web_search` | `web_search` 支持较新的控制项,例如 `filters`, `external_web_access`,以及 `return_token_budget` |
+| `gpt-4o-search-preview` 或 `gpt-4o-mini-search-preview` | 迁移到 Responses `web_search`,或使用 `gpt-5-search-api` 如果你必须继续使用 Chat Completions | 预览版搜索模型已弃用并于 2026-07-23 下线 |
+| Chat Completions 搜索集成 | 使用 `gpt-5-search-api`,或迁移到 Responses `web_search` 以获得更多工具控制和可选的搜索功能 | Chat Completions 搜索模型总是在响应前执行搜索;Responses 中的搜索是一个工具 |
## 搜索上下文大小
-`search_context_size` 控制模型在生成响应前可从网页搜索结果中获得的上下文量。使用 `low` 适用于简单的查询, `medium` 适用于均衡的默认设置,以及 `high` 当答案可能需要从搜索结果中获取更多细节时使用。此设置不设定确切的 token 数量,也不保证特定的来源或引用数量。
+`search_context_size` 控制在模型生成响应之前,网页搜索结果中有多少上下文可供模型使用。使用 `low` 进行简单查询, `medium` 作为平衡的默认值,以及 `high` 在答案可能需要更多搜索结果细节时使用。此设置不会设定确切的 token 数量,也无法保证具体的来源或引用数量。
@@ -366,18 +366,18 @@ curl "https://api.openai.com/v1/responses" \
-## 运行更长时间的网页研究
+## 运行更长时间的网络研究
-`return_token_budget` 控制在网页搜索过程中,工具可以返回多少Responses API搜索结果内容,当与GPT-5+推理模型一起使用时。对于大多数请求,保持默认值。将其设置为 `unlimited` 仅用于需要检查大量页面且可能因标准返回令牌上限而停止的高强度研究或评估运行。
+`return_token_budget` 控制工具在 GPT-5+ 推理模型运行的 Responses API 搜索过程中可以返回多少 网页搜索 结果内容。对于大多数请求,请保留默认值。将其设置为 `unlimited` 仅适用于需要查看多个页面且可能在标准返回 token 上限处停止的高强度研究或评估运行。
-使用 `unlimited` 时应谨慎,因为它可能增加延迟和成本。对于长时间运行的多搜索任务,使用后台模式(`background: true`)以便请求可以异步继续运行,你可以在之后检索最终响应。
+请谨慎使用 `unlimited` ,因为它可能会增加延迟和成本。对于长时间运行的多搜索任务,请使用后台模式(`background: true`),以便请求可以异步持续运行,并在稍后获取最终响应。
| 值 | 行为 |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `default` | 对网页搜索结果使用标准的返回令牌预算。这与省略 `return_token_budget`. |
-| `unlimited` | 移除网页搜索运行的默认返回令牌预算。 |
+| `default` | 对 网页搜索 结果使用标准的返回 token 预算。这与省略时的行为相同 `return_token_budget`. |
+| `unlimited` | 移除 网页搜索 运行的默认返回 token 预算。 |
-此参数仅适用于托管Responses API `web_search` 中支持 GPT-5+ 推理的网页搜索工具。它不会改变搜索上下文窗口,也不适用于非推理网页搜索、旧版搜索API路径、容器网页搜索、Chat Completions 搜索模型或 `web_search_preview`。仅 `default` 和 `unlimited` 是支持的值; `null`、数字和其他字符串会被拒绝。
+此参数仅适用于托管的Responses API `web_search` 工具中的 GPT-5+ 推理 网页搜索。它不会更改搜索上下文窗口,也不适用于非推理 网页搜索、旧版 Search API 路径、容器 网页搜索、Chat Completions 搜索模型或 `web_search_preview`. Only `default` 和 `unlimited` 是受支持的值; `null`,数字和其他字符串将被拒绝。
@@ -541,18 +541,18 @@ curl "https://api.openai.com/v1/responses" \
-## 域过滤
+## Domain filtering
-网页搜索中的域过滤可让你将结果限制在特定的域集合内。通过 `filters` 参数,你可以配置最多 100 个 `allowed_domains` 或最多 100 个 `blocked_domains`。格式化域时,请省略 HTTP 或 HTTPS 前缀。例如,使用 `openai.com` 而不是 `https://openai.com/`。此方法还会在搜索中包含子域。请注意,域过滤仅在 Responses API 中可用,并与 `web_search` 工具配合使用。
+在 网页搜索 中进行域名过滤可将结果限制在特定的域名集合内。通过 `filters` 参数,你可以配置最多 100 个 `allowed_domains` ,或者最多 100 个 `blocked_domains`。在格式化域名时,请省略 HTTP 或 HTTPS 前缀。例如,使用 `openai.com` 而不是 `https://openai.com/`。这种方式还会将子域名纳入搜索范围。请注意,域名过滤仅在使用 Responses API 的 `web_search` 工具时可用。
## 来源
-要查看在网页搜索期间检索到的所有 URL,请使用 `sources` 字段。与仅显示最相关引用的内联引用不同,sources 返回模型在形成响应时查阅的完整 URL 列表。
-sources 的数量通常多于引用的数量。实时第三方信息源也会在此处显示,并标记为 `oai-sports`, `oai-weather`,或 `oai-finance`。sources 字段可用于 `web_search` 和 `web_search_preview` 工具。
+若要查看 网页搜索 期间检索到的所有 URL,请使用 `sources` 字段。与内联引用不同,内联引用仅展示最相关的参考资料,而 sources 会返回模型在生成回答时所参考的完整 URL 列表。
+来源的数量通常大于引用的数量。实时第三方信息源也会在此处显示,并标记为 `oai-sports`, `oai-weather`,或 `oai-finance`。sources 字段在以下两种情况下都可用: `web_search` 和 `web_search_preview` 工具。
-列出信息源
+来源列表
```javascript
import OpenAI from "openai";
@@ -780,18 +780,18 @@ curl "https://api.openai.com/v1/responses" \
-## 图像搜索结果
+## Image search results
-网页搜索可以在常规文本结果之外返回图像结果。当你的应用需要当前或基于网络的视觉内容(例如产品照片、地标、地点、事件或视觉参考)时,可使用图像搜索。
+网页搜索除了返回常规文本结果外,还可以返回图片结果。当你的应用需要基于网络的最新视觉内容时,可使用图片搜索,例如商品照片、地标、地点、事件或视觉参考资料。
-要使用图像搜索,请设置 `search_content_types` 以包含 `image`。添加 `text` 当你还希望获得支持性文本结果以帮助模型总结、排序或解释检索到的图像时。
+要使用图片搜索,请设置 `search_content_types` 以包含 `image`,再添加 `text` ,即可同时获取帮助模型总结、排序或解释检索到的图片的支持性文本结果。
-使用 `image_settings` 控制图像特定行为:
+请谨慎使用 `image_settings` 参数来控制与图片相关的行为:
-- `max_results`: 请求正数的图片结果数量。
+- `max_results`: 请求返回正数的图片结果。
- `caption`: 在可用时请求简短的图片描述。
-要检查原始图像结果,请在请求中包含 `web_search_call.results` 并读取 `web_search_call.results[]` 从响应中的内容。图像结果与助手消息分开返回,因此 `web_search_call` 项应在你的应用需要URL或元数据时直接解析。
+若要检查原始图片结果,请在请求中传入 `web_search_call.results` ,并从响应中读取 `web_search_call.results[]` 。图片结果与助手消息分开返回,因此当你的应用需要这些 URL 或元数据时,请直接解析 `web_search_call` 项。
搜索图片
@@ -959,12 +959,12 @@ curl "https://api.openai.com/v1/responses" \
```
-每个 `image_result` 包括:
+每个 `image_result` 包含:
- `image_url`:结果的规范图片 URL。
-- `source_website_url`:找到图片的页面。
-- `thumbnail_url`:可用的缩略图 URL。
-- `caption`:可用的简短标题或描述。
+- `source_website_url`:找到该图片的页面。
+- `thumbnail_url`:可用时的缩略图 URL。
+- `caption`:可用时的简短标题或描述。
```json
{
@@ -988,16 +988,16 @@ curl "https://api.openai.com/v1/responses" \
-## 用户位置
+## User location
-要根据地理位置优化搜索结果,你可以使用国家、城市、地区和/或时区来指定大致的用户位置。
+若要根据地理位置优化搜索结果,你可以使用国家、城市、地区和/或时区来指定一个近似用户位置。
-- 该 `city` 和 `region` 字段是自由文本字符串,如 `Minneapolis` 和 `Minnesota` 分别。
-- 该 `country` 字段是两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1),如 `US`.
-- 该 `timezone` 字段是 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 如 `America/Chicago`.
+- 该 `city` 以及 `region` 字段为自由文本字符串,例如 `Minneapolis` 以及 `Minnesota` 。
+- 该 `country` 字段是一个两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1),例如 `US`.
+- 该 `timezone` 字段是一个 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如 `America/Chicago`.
-请注意,使用网页
- 搜索的深度研究模型不支持用户位置。
+请注意,使用网页搜索的深度研究模型不支持用户位置。
+ search.
@@ -1185,13 +1185,13 @@ curl "https://api.openai.com/v1/responses" \
-## 实时互联网访问
+## 实时联网访问
-控制网页搜索工具在Responses API中是获取实时内容还是仅使用缓存/索引结果。
+控制 网页搜索 工具是抓取实时内容,还是仅使用缓存或索引结果,在 Responses API 中。
-- 设置 `external_web_access: false` 在 `web_search` 工具以运行于离线/仅缓存模式。
-- 默认值为 `true` (实时访问),如果你不设置它。
-- 预览变体(`web_search_preview`)忽略此参数,行为如同 `external_web_access` 为 `true`.
+- Set `external_web_access: false` on the `web_search` tool to run in offline/cache‑only mode.
+- Default is `true` (live access) if you do not set it.
+- Preview variants (`web_search_preview`) ignore this parameter and behave as if `external_web_access` is `true`.
@@ -1308,37 +1308,37 @@ puts(response.output_text)
-## 局限性
+## 限制
#### Chat Completions API
-Chat Completions API 仅支持专门的搜索模型用于网页搜索。这些模型不支持 Responses API `web_search` 功能,如域名过滤器、完整来源列表、实时访问控制和返回令牌预算控制。
+Chat Completions API 仅支持用于网页搜索 的专用搜索模型。这些模型不支持 Responses API `web_search` 特性,例如域名过滤器、完整的来源列表、实时访问控制以及返回令牌预算控制。
| 模型 | 上下文窗口 | 限制 |
| ---------------------------- | -------------: | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| `gpt-5-search-api` | 200k | 使用 聊天补全接口 搜索模型路径 |
-| `gpt-4o-search-preview` | 128k | 使用 聊天补全接口 搜索模型路径; [已弃用,将于 2026-07-23 关闭](https://developers.openai.com/api/docs/deprecations#2026-04-22-legacy-gpt-model-snapshots) |
-| `gpt-4o-mini-search-preview` | 128k | 使用 聊天补全接口 搜索模型路径; [已弃用,将于 2026-07-23 关闭](https://developers.openai.com/api/docs/deprecations#2026-04-22-legacy-gpt-model-snapshots) |
+| `gpt-5-search-api` | 200k | 使用 Chat Completions 搜索模型路径 |
+| `gpt-4o-search-preview` | 128k | 使用 Chat Completions 搜索模型路径; [已弃用,将于 2026-07-23 停止服务](https://developers.openai.com/api/docs/deprecations#2026-04-22-legacy-gpt-model-snapshots) |
+| `gpt-4o-mini-search-preview` | 128k | 使用 Chat Completions 搜索模型路径; [已弃用,将于 2026-07-23 停止服务](https://developers.openai.com/api/docs/deprecations#2026-04-22-legacy-gpt-model-snapshots) |
#### Responses API
-使用托管 `web_search` 工具。Responses API 仍接受 `web_search_preview` 用于旧版集成,但新集成请使用 `web_search` 。
+使用托管 `web_search` 工具。Responses API 仍然接受 `web_search_preview` 用于旧版集成,但请使用 `web_search` 用于新的集成。
-如需更大的模型上下文窗口,请使用 `gpt-5.5`。网页搜索 的上下文窗口仍为 128k。
+如果需要更大的模型上下文窗口,请使用 `gpt-5.5`。网页搜索 的上下文窗口仍为 128k。
| 模型 | 模型上下文窗口 | 限制 |
| -------------- | -------------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
| `gpt-4.1` | 1M | 搜索上下文限制为 128k |
| `gpt-4.1-mini` | 1M | 搜索上下文限制为 128k |
-| `o4-mini` | 200k | 搜索上下文限制为 128k; [已弃用,2026-10-23 关闭](https://developers.openai.com/api/docs/deprecations#2026-04-22-legacy-gpt-model-snapshots) |
+| `o4-mini` | 200k | 搜索上下文限制为 128k; [已弃用,2026-10-23 关停](https://developers.openai.com/api/docs/deprecations#2026-04-22-legacy-gpt-model-snapshots) |
-对于 Responses API 的 网页搜索,搜索上下文窗口限制为 128k,即使模型上下文窗口更大也是如此。
+对于 Responses API 网页搜索,搜索上下文窗口上限为 128k,即使模型上下文窗口更大也是如此。
-- 网页搜索不支持 [`gpt-5`](https://developers.openai.com/api/docs/models/gpt-5) 与 `minimal` 推理。
-- [`gpt-5.4`](https://developers.openai.com/api/docs/models/gpt-5.4) 当推理力度设置为 `none` 时,可能会产生较低质量的结果。
-- Responses API 网页搜索 使用底层模型的分层速率限制。
+- 网页搜索不支持 [`gpt-5`](https://developers.openai.com/api/docs/models/gpt-5) 配合 `minimal` 推理。
+- [`gpt-5.4`](https://developers.openai.com/api/docs/models/gpt-5.4) 在推理力度设置为 `none` 时,可能会产生质量较低的结果。
+- Responses API 网页搜索 使用底层模型的分级速率限制。
- `web_search_preview` 不支持 `filters` 或 `return_token_budget`,并忽略 `external_web_access`.
-- 使用 `tool_choice: "auto"`,时,搜索为可选项。请使用 `tool_choice: "required"` 或特定的 网页搜索 工具选择以确保搜索执行。
+- 使用 `tool_choice: "auto"`,时,搜索为可选项。当必须执行搜索时,请使用 `tool_choice: "required"` 或特定的 网页搜索 工具选择。
## 使用说明
diff --git a/docs/zh/api/docs/guides/upgrading-to-gpt-5p6-sol.md b/docs/zh/api/docs/guides/upgrading-to-gpt-5p6-sol.md
index 57b4223..683754f 100644
--- a/docs/zh/api/docs/guides/upgrading-to-gpt-5p6-sol.md
+++ b/docs/zh/api/docs/guides/upgrading-to-gpt-5p6-sol.md
@@ -1,146 +1,146 @@
# 升级到 GPT-5.6 Sol
-> 关于完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 末尾追加 `.md` 获取。
# 升级到 GPT-5.6 Sol
-当用户要求将现有的 OpenAI API 集成、仓库、提示词栈、智能体、模型路由器或模型选择器迁移到 GPT-5.6 Sol 或 GPT-5.6 系列时,请参阅本指南。
+当用户要求将现有的 OpenAI API 集成、代码仓库、提示词栈、智能体、模型路由器或模型选择器迁移到 GPT-5.6 Sol 或 GPT-5.6 系列时,请使用本指南。
-默认的显式目标是 `gpt-5.6-sol`。别名 `gpt-5.6` 路由到 Sol;仅在仓库有意优先使用系列别名时才使用它。不要将每个旧模型用法都视为 Sol 的候选:GPT-5.6 是一个系列,具有不同的成本、延迟、上下文和质量角色。
+默认的显式目标是 `gpt-5.6-sol`。该别名 `gpt-5.6` 会路由到 Sol;仅当代码仓库刻意偏好使用系列别名时才使用它。不要把每一次旧的模型使用都当作 Sol 候选:GPT-5.6 是一个系列,在成本、延迟、上下文和质量角色方面各有不同。
-在修改代码之前,使用 OpenAI Docs MCP 获取当前的实时 GPT-5.6 模型指南:
+在修改代码之前,使用 OpenAI Docs MCP 获取当前实时的 GPT-5.6 模型指南:
/api/docs/guides/latest-model?model=gpt-5.6
-对于提示词更改,也请仅阅读 `## Prompting Best Practices` 部分,来自:
+对于提示词的修改,还应仅阅读其中的 `## Prompting Best Practices` 章节,来源为:
/api/docs/guides/latest-model?model=gpt-5.6#prompting-best-practices
-将实时文档视为当前模型 ID、参数、限制、定价和功能可用性的权威来源。本文件提供迁移判断:在哪里查找、可能破坏什么、保留什么、不应自动采用什么,以及如何验证结果。
+请将实时文档视为模型 ID、参数、限制、定价和功能可用性的权威依据。本文件提供迁移方面的判断依据:在哪里查阅、哪些地方可能出错、哪些内容需要保留、哪些内容不应自动采用,以及如何验证最终结果。
## 核心原则
-不要盲目地进行模型字符串替换。
+不要直接对模型字符串进行盲目替换。
-首先保留每个使用站点的行为、延迟类别、成本类别、推理级别、端点契约、工具语义、缓存行为和输出契约。然后进行最小安全迁移。仅当新 GPT-5.6 能力解决了已测量的实际问题或用户明确要求时,才采用它们。
+首先保留每个使用点的行为、延迟等级、成本等级、推理级别、端点契约、工具语义、缓存行为以及输出契约,然后再进行最小且安全的迁移。只有当新的 GPT-5.6 能力能够解决已测量出的问题,或用户明确要求使用时,才采用它们。
-仅升级模型本身并不足以授权添加推理字段、更改请求模式或重写测试。只有在旧的有效行为已确立且省略会改变 GPT-5.6 上的行为时,才添加显式推理。
+仅升级模型本身并不等同于授权添加推理字段、修改请求架构或重写测试。只有在旧的等效行为已确定,且遗漏推理会在 GPT-5.6 上改变行为时,才应显式添加推理。
5.6 迁移的主要风险包括:
-- 为有意保持微型、纳米级、低成本或对延迟敏感的工作负载选择 Sol;
-- 继承 5.6 的默认 `medium` 推理设置,而旧版有效推理强度为 `none`;
-- 使用带函数工具的 Chat Completions,而未显式将有效推理强度设置为 `none`;
-- 当稳定前缀后接变化的后缀时,丢失提示缓存命中;
-- 因省略或 `auto` 细节参数行为不同,导致图像或 PDF 输入令牌增加;
-- 将新的缓存、持久推理、Pro、程序化工具调用或多智能体字段应用于不支持这些字段的路由;
-- 更新模型字符串但忘记更新注册表、允许列表、定价元数据、能力标志、测试和 UI 模型选择器。
+- 为那些刻意追求 mini、nano、低成本或对延迟敏感的工作负载选择 Sol;
+- 继承 5.6 的默认 `medium` 而原有有效推理力度为的推理设置 `none`;
+- 在 Chat Completions 中使用函数工具,但未显式将有效推理力度设置为 `none`;
+- 当稳定前缀后跟随变化后缀时,丢失提示缓存命中;
+- 因为省略了或 `auto` detail 字段表现不同而导致图像或 PDF 输入 token 增加;
+- 将新的缓存、持久推理、Pro、Programmatic Tool Calling 或多智能体字段应用于不支持这些字段的路由;
+- 更新了模型字符串却忘了同步更新注册表、白名单、定价元数据、能力开关、测试以及 UI 模型选择器。
## 迁移策略
-编辑前对每个使用位置进行分类:
+在编辑之前,先对每个使用位置进行分类:
1. `simple Sol migration`
- - 一个旗舰模型的使用。
- - 相同的端点和请求结构可以保持不变。
- - 推理努力是明确的,或其旧的有效值已知。
- - 无需对缓存、视觉、文件、工具或解析器行为进行实现更改。
+ - 使用一款旗舰模型。
+ - 可以保留相同的端点和请求结构。
+ - 推理强度是显式的,或其原有的有效值是已知的。
+ - 无需对缓存、视觉、文件、工具或解析器的行为进行实现层面的改动。
2. `tier-aware family migration`
- - 仓库暴露了多个模型角色、模型选择、回退、路由器、定价数据或能力元数据。
- - 将每个角色映射到 Sol、Terra 或 Luna,而不是用 Sol 替换所有内容。
+ - 代码仓库对外暴露多个模型角色、模型选择、回退机制、路由器、定价数据或能力元数据。
+ - 将每个角色映射到 Sol、Terra 或 Luna,而不是全部替换为 Sol。
3. `compatibility migration`
- - 安全操作需要参数、端点、缓存、状态、工具循环或多模态细节更改。
- - 仅当实现工作在用户请求的范围内时才进行这些更改。否则,报告确切的阻塞点和最小的后续工作。
+ - 安全迁移需要更改参数、端点、缓存、状态、工具循环或多模态细节。
+ - 仅在实现工作属于用户请求的范围内时才进行这些更改。否则报告具体的阻碍点和最小的后续动作。
4. `prompt migration`
- - API 结构可以保持不变,但代表性追踪显示特定于提示的回归。
- - 针对该失败进行精准的提示编辑;不要整体重写有效的提示堆栈。
- - 当任务涉及更新提示指导时,仅编辑直接相关的提示表面。除非提示更改需要,否则不要修改运行时请求代码、模型模式或测试。
+ - API 的结构可以保持不变,但代表性追踪显示存在针对特定提示的回归。
+ - 针对该失败进行精准的提示编辑;不要整体重写可正常工作的提示栈。
+ - 当任务是更新提示词指南时,仅编辑直接关联的提示表面。除非提示变更需要,否则不要修改运行时请求代码、模型结构或测试。
5. `optional feature adoption`
- - 正在有意添加 Pro 模式、持久推理、显式缓存、程序化工具调用或多智能体行为。
- - 将其与基线迁移分开,以便可以衡量其效果。
+ - Pro 模式、持久化推理、显式缓存、Programmatic Tool Calling 或多智能体行为是被刻意新增的。
+ - 将其与基线迁移分开处理,以便衡量其效果。
6. `leave unchanged`
- - 历史示例、关于旧模型的文档、快照、夹具、评估基线、比较代码、故意固定的回退、不支持的提供者或模糊用法。
+ - 历史示例、有关旧模型的文档、快照、固定测试数据、评估基线、对比代码、刻意固定的回退、不受支持的提供方,或存在歧义的用法。
-当意图不明确时,宁可保留用法不变并将其列出以供确认,也不要默默改变其作用。
+当意图不明确时,宁可保留用法不变并将其列出待确认,也不要悄悄改变其角色。
## 编辑前清单
-搜索范围不限于字面模型 ID。清单:
-
-- 模型字符串、别名、环境变量、CLI 标志、配置默认值和部署设置;
-- 对 Responses、Chat Completions、Batch 或提供商适配器的 SDK 调用;
-- 推理设置、令牌预算、采样设置和延迟超时;
-- 函数工具、托管工具、结构化输出、响应解析器和重放逻辑;
-- 与每次使用相关的系统、开发者、用户和工具描述提示词;
-- 路由器、回退、模型允许列表、枚举、正则表达式、验证模式和能力映射;
-- 模型选择器 UI、显示标签、描述、上下文限制、定价元数据和提供商目录;
-- 提示缓存键、保留选项、稳定前缀构建和缓存指标;
-- 图像、PDF、文件、OCR 和计算机使用输入;
-- 测试、fixtures、快照、评估、分析标签、计费表和文档。
-
-更改默认模型时,需搜索所有活跃的默认设置位置:运行时配置、环境/配置文件、设置文档、测试、CLI 默认值以及部署示例。确保这些地方同时更新。
-
-对于每个使用位置,记录:
-
-- 源模型及其看似被使用的原因;
-- 端点和 SDK/客户端表面;
-- 提示表面;
-- 有效推理力度,包括默认值;
-- 延迟、成本、上下文和质量角色;
-- 工具、结构化输出、缓存、状态重放和多模态输入;
-- 下游解析器或用户可见契约;
+搜索的字面意义不限于模型 ID。清点清单:
+
+- 模型字符串、别名、环境变量、CLI 标志、配置默认值以及部署设置;
+- 对 Responses、Chat Completions、Batch 或 provider 适配器的 SDK 调用;
+- 推理设置、token 预算、采样设置以及延迟超时;
+- 函数工具、托管工具、结构化输出、响应解析器以及重放逻辑;
+- 与每次使用关联的 system、developer、user 和工具描述提示词;
+- 路由器、回退机制、模型允许列表、枚举、正则表达式、校验 schema 以及能力映射;
+- 模型选择器 UI、显示标签、描述、上下文限制、价格元数据和 provider 目录;
+- prompt 缓存键、保留选项、稳定前缀构建以及缓存指标;
+- 图像、PDF、文件、OCR 以及 computer-use 输入;
+- 测试、fixtures、快照、evals、分析标签、计费表以及文档。
+
+更改默认模型时,请搜索所有处于生效状态的默认界面:运行时配置、环境/配置文件、设置文档、测试、CLI 默认值以及部署示例。务必一并更新这些位置。
+
+对每个使用位置,记录以下信息:
+
+- 源模型及其被使用的原因;
+- 端点以及 SDK/客户端接口;
+- 提示词接口;
+- 实际推理工作量,包括默认值;
+- 延迟、成本、上下文和质量方面的作用;
+- 工具、结构化输出、缓存、状态回放和多模输入;
+- 下游解析器或面向用户的契约;
- 迁移类别和验证计划。
## 按角色选择目标模型
-以此作为起始地图,然后根据仓库的工作负载进行验证:
+以此作为起始映射,然后根据代码仓库的实际工作负载进行验证:
-| 现有角色 | Starting GPT-5.6 目标 | 原因 |
+| Existing role | Starting GPT-5.6 target | Reason |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------- |
-| 无后缀的 GPT-5 旗舰版、GPT-5.5 或 GPT-5.4 旗舰版 | `gpt-5.6-sol` | Sol 是旗舰级等效档位。 |
-| Mini 模型、均衡的低成本路线或中等吞吐量的工作器 | `gpt-5.6-terra` | Terra 是类似 mini 的档位。 |
-| Nano 模型、分类、提取、路由、高吞吐量或严格延迟路线 | `gpt-5.6-luna` | Luna 是类似 nano 的档位。 |
-| GPT-4.1 或 GPT-4o 对延迟敏感的流程 | 首先评估 Luna 和 Terra;仅在质量要求允许的情况下使用 Sol | 更换旗舰模型可能会显著改变延迟和成本。 |
-| 重推理或最难的质量优先流程 | 从使用旧有效工作量的 Sol 开始 | 在调整之前保留推理契约。 |
-| 旧的 Pro 使用 | Sol plus `reasoning.mode: "pro"`,仅当用户需要 Pro 行为时 | GPT-5.6 Pro 是一种模式,不是单独的模型标识。 |
-| 路由器、备用或模型选择器 | 按角色添加模型族 | 请勿将多模型设计合并为单一模型。 |
-| 第三方或特定于提供商的模型 | 除非用户明确要求迁移提供商,否则保持不变 | 模型名称相似并非安全映射。 |
+| Unsuffixed GPT-5 flagship、GPT-5.5 或 GPT-5.4 flagship | `gpt-5.6-sol` | Sol 是旗舰等价层级。 |
+| Mini 模型、均衡低成本路线或中等吞吐 worker | `gpt-5.6-terra` | Terra 是 mini 类层级。 |
+| Nano 模型、分类、抽取、路由、大流量或严格低时延路线 | `gpt-5.6-luna` | Luna 是 nano 类层级。 |
+| GPT-4.1 或 GPT-4o 的低时延敏感流程 | 先评估 Luna 和 Terra;仅在质量要求时使用 Sol | 替换旗舰模型会显著改变时延和成本。 |
+| 重推理或最难的、质量优先的流程 | 以原有效力档位从 Sol 开始 | 在调优前保持推理契约不变。 |
+| Old Pro usage | Sol plus `reasoning.mode: "pro"`, only if the user wants Pro behavior | GPT-5.6 Pro 是一种模式,不是单独的模型 slug。 |
+| 路由器、回退或模型选择器 | 按角色添加模型族 | 不要将多模型设计合并为 Sol。 |
+| 第三方或特定提供商的模型 | 保持不变,除非用户明确请求迁移提供商 | 模型名相似并不能作为安全的映射依据。 |
-需在实时文档中核查的重要限制:
+需在实时文档中核对的重要限制:
-- Sol 和 Terra 大约有 1.05M 上下文和 128K 最大输出。
-- Luna 有较小的 400K 上下文和 128K 最大输出。
-- Sol 和 Terra 超过 272K 输入 token 的长上下文请求可能改变整个请求的定价。
+- Sol 和 Terra 拥有约 1.05M 上下文,最大输出为 128K。
+- Luna 上下文较小,为 400K,最大输出为 128K。
+- Sol 和 Terra 超过 272K 输入 token 的长上下文请求可能会改变整个请求的定价。
-不要自行编造价格、限制或功能标志。在更新注册表或界面之前,请从当前文档中获取这些信息。
+不要杜撰价格、限制或能力标志。在更新注册表或界面之前,请从最新文档中获取。
-对于模型选择器和注册表,默认保留现有模型条目。将 GPT-5.6 Sol、Terra 和 Luna 添加为新选项,除非用户明确要求替换或移除旧模型。除非已从权威文档确认,否则不要编造定价、上下文限制、功能或元数据。
+对于模型选择器和注册表,默认保留现有模型条目。除非用户明确要求替换或移除旧模型,否则将 GPT-5.6 Sol、Terra 和 Luna 添加为新选项。除非已从权威文档确认,否则不要杜撰价格、上下文限制、能力或元数据。
-如果使用 `gpt-5.6` 别名,请在验证期间记录返回的 `response.model` 。不要假设别名和显式 Sol 标识在仪表板、速率限制配置、分析或计费元数据中显示一致。
+如果使用 `gpt-5.6` 别名,请记录返回的 `response.model` 以供验证。不要假设别名和显式 Sol slug 在仪表板、速率限制配置、分析或计费元数据中呈现方式完全相同。
-## 在调优之前保留有效的推理
+## 在调优前保留有效推理
-GPT-5.6 支持 `none`, `low`, `medium`, `high`, `xhigh`,以及 `max`。如果省略,GPT-5.6 默认为 `medium`.
+GPT-5.6 支持 `none`, `low`, `medium`, `high`, `xhigh`,和 `max`。如果省略,GPT-5.6 默认使用 `medium`.
-这是一个行为迁移风险:
+这是一种行为迁移风险:
- GPT-5.5 通常默认为 `medium`.
-- GPT-5.4、mini 和 nano 的用法通常默认为 `none`.
-- 因此,在模型切换后,之前省略的设置可能会变得更慢、更昂贵,并且与 Chat Completions 函数工具不兼容。
+- GPT-5.4、mini 和 nano 的使用通常默认为 `none`.
+- 因此,模型切换后,之前遗漏的设置可能会变慢、更加昂贵,并且与 Chat Completions 函数工具不兼容。
对于每次使用:
-1. 如果明确指定了 effort,则在支持的情况下,为首次 5.6 运行保留该设置。
-2. 如果未指定 effort 且已知旧的有效默认值,则仅当 GPT-5.6 的省略默认值会改变行为时,才显式添加该设置。如果新旧省略默认值相同,则保持省略。
-3. 如果旧的有效值未知,请勿猜测。标记该情况,并在可能的基线上比较旧行为与 5.6 的行为。
-4. 基线通过后,在代表性任务上测试相同设置及低一档的设置。
-5. 使用 `xhigh` 或 `max` 仅用于评估显示有显著收益的高质量优先的困难工作负载。
+1. 如果显式设置了 effort,在受支持的前 5.6 次运行中保留它。
+2. 如果省略了 effort 且已知旧的生效默认值,仅在 GPT-5.6 的省略默认值会改变行为时才显式添加它。如果新旧省略默认值相同,则保持省略。
+3. 如果旧的生效值未知,不要猜测。标记它,并在可能的基线下比较旧行为与 5.6 的行为。
+4. 基线通过后,在代表性任务上测试同一设置以及再低一档的设置。
+5. 使用 `xhigh` 或 `max` 仅用于评估显示有明显收益的高难度质量优先工作负载。
-不要全局推荐 `max`。在提高投入之前,请检查实际失败是否是缺失成功标准、依赖规则、工具路由规则、状态重放错误或验证循环。
+不要全局性地建议 `max`。在加大投入之前,先检查实际的失败是否是缺少成功标准、依赖规则、工具路由规则、状态回放缺陷或验证循环。
-使用属于端点的字段形状。
+使用属于该端点的字段结构。
-Responses:
+Responses:
```json
{
@@ -149,7 +149,7 @@ Responses:
}
```
-Chat Completions:
+Chat Completions:
```json
{
@@ -158,11 +158,11 @@ Chat Completions:
}
```
-## Chat Completions 与函数工具
+## Chat Completions 和函数工具
-这是最重要的端点特定检查。
+这是端点特定检查中最重要的一项。
-对于 GPT-5.6,Chat Completions 中的函数工具仅与有效推理兼容 `none`。带工具进行推理应使用 Responses API。
+对于 GPT-5.6,Chat Completions 中的函数工具仅与有效推理兼容 `none`。带工具的推理应使用 Responses API。
由于 GPT-5.6 默认 `medium`,这种组合是不安全的:
@@ -173,7 +173,7 @@ Chat Completions:
}
```
-对于必须保留函数工具且对延迟敏感的 Chat Completions 流程,请明确保留 `none`:
+对于必须保留函数工具的低延迟 Chat Completions 流程,请显式保留 `none`:
```json
{
@@ -185,54 +185,54 @@ Chat Completions:
如果应用同时需要推理和工具:
-- 当实现变更在范围内时,将该流程迁移至 Responses;
+- 在实现变更属于本次工作范围时,将该流程迁移到 Responses;
- 否则将其报告为兼容性阻塞项;
-- 未经批准,不得通过移除工具、放弃必需推理或更改工作负载行为来隐藏不兼容性。
+- 不得通过移除工具、丢弃必要的推理,或在未获批准的情况下更改工作负载的行为来掩盖这种不兼容。
-如果实时API拒绝了预期的 `none` 路径,请将其视为当前的API兼容性问题,并报告确切的请求和错误,而不是自行编造变通方案。
+如果在线 API 拒绝了预期的 `none` 路径,请将其视为当前的 API 兼容性问题,并报告准确的请求和错误,而不是自行编造变通方案。
-## Responses API 与对话状态
+## Responses API 与会话状态
-对于推理、工具、多轮智能体以及新的5.6功能,优先使用Responses。
+在推理、工具、多轮智能体以及新增的 5.6 能力场景下,优先使用 Responses。
-对于普通的的多轮Responses调用,保留仓库现有的状态策略。不要仅仅因为持续推理存在就添加它。
+对于普通的多轮 Responses 调用,请保留仓库已有的状态策略。不要仅仅因为持久化推理存在就启用它。
-如果特意启用持续推理:
+如果有意启用持久化推理:
- 使用 `reasoning.context: "all_turns"` 仅在目标和假设保持稳定时;
-- 优先 `previous_response_id` 当服务器可以携带状态时;
-- 手动重放时,保留每个先前的用户输入和每个相关的输出项,而不仅仅是助手文本;
-- 使用 `store: false` 或 ZDR,保留并重放返回的推理项,包括 `encrypted_content`;
-- 当旧推理可能过时或具有误导性时,使用当前回合的行为。
+- 优先选择 `previous_response_id` 在服务端能够承载状态时;
+- 在手动回放时,保留所有先前的用户输入和所有相关的输出项,而不仅仅是助手文本;
+- 使用 `store: false` 或 ZDR 时,保留并回放返回的推理项,包括 `encrypted_content`;
+- 在旧推理可能过时或产生误导时,使用当前轮次的行为。
-对于手动重放,请精确保留项目类型、ID、调用 ID、调用方元数据和助手阶段值。不完整的重放可能会静默降低质量或破坏工具延续。
+进行手动回放时,必须精确保留条目类型、ID、调用 ID、调用方元数据以及助手阶段值。不完整的回放可能会在无声中降低质量,或中断工具延续。
-## 提示词缓存
+## Prompt caching
不要假设旧的缓存命中行为在模型切换后仍然有效。
-GPT-5.6 隐式缓存会在最近一条用户或工具消息附近放置一个受管断点,不再依赖 128 token 的舍入。因此,对于以大量稳定前缀开头、后接变动后缀的提示请求,即使稳定前缀本身未发生变化,也可能丢失缓存命中。
+GPT-5.6 的隐式缓存在最近的用户或工具消息附近设置了一个托管断点,不再依赖 128 token 的取整。因此,一个具有较大稳定前缀并随后是变化后缀的提示,即使稳定前缀本身没有变化,也可能丢失缓存命中。
审计:
- 大型可复用的系统/开发者提示词;
-- 动态后缀附加到原本稳定的提示词上;
-- 前缀中的时间戳、请求 ID、用户特定值或工具列表发生变化;
-- 缓存键、保留设置和缓存仪表盘;
-- 仅假设读取而忽略写入的令牌计数。
+- 追加到原本稳定的提示词之后的动态后缀;
+- 在前缀中更改时间戳、请求 ID、用户特定值或工具列表;
+- 缓存键、保留设置和缓存仪表板;
+- 仅假设读取而忽略写入的 token 计费方式。
迁移规则:
-- 保持可复用前缀稳定;
-- 不要不必要地频繁更改大型系统提示;
-- 比较新旧 `cached_tokens`, `cache_write_tokens`、延迟和成本;
-- 仅在测量到的工作负载具有隐式缓存无法捕获的稳定边界时,才使用显式缓存断点;
-- 不要将每个提示都全局转换为显式缓存;
-- 在混合模型系统中,不要将仅限 5.6 的缓存字段发送给旧路由。
+- 保持可复用的前缀稳定;
+- 避免不必要地改动大型系统提示;
+- 比较新旧版本 `cached_tokens`, `cache_write_tokens`,的延迟和成本;
+- 仅当实测的工作负载存在稳定的边界且隐式缓存无法命中时,才使用显式缓存断点;
+- 不要将所有提示全局转换为显式缓存;
+- 在混合模型系统中,不要向旧路由发送仅 5.6 支持的缓存字段。
-当旧路由和 GPT-5.6 路由共享一个请求构建器时,应隔离仅 GPT-5.6 的字段,而不是全局应用它们。
+当旧路由与 GPT-5.6 路由共享同一个请求构建器时,应该隔离仅适用于 GPT-5.6 的字段,而不是将它们全局应用。
-新的顶级请求形状使用 `prompt_cache_options`,例如:
+新的顶层请求结构使用 `prompt_cache_options`,例如:
```json
{
@@ -243,46 +243,46 @@ GPT-5.6 隐式缓存会在最近一条用户或工具消息附近放置一个受
}
```
-使用实际稳定的渲染边界放置显式断点 `prompt_cache_breakpoint`。保留 `prompt_cache_key` 当应用程序已使用它时。将较旧的 `prompt_cache_retention` 形状视为已弃用,并在重写前验证实时文档。
+使用以下方式在实际的稳定渲染边界处放置显式断点 `prompt_cache_breakpoint`。当应用已经在使用时,请保留 `prompt_cache_key` 。将旧的 `prompt_cache_retention` 结构视为已废弃,并在重写前查阅最新的实时文档进行确认。
-缓存写入的成本高于普通未缓存输入,因此较低的命中率可能既更慢又更昂贵。
+缓存写入的成本高于普通的未缓存输入,因此较低的命中率可能既更慢又更贵。
## 图像、PDF、文件和长上下文
GPT-5.6 可以在不更改任何提示的情况下改变 token 和延迟行为:
-- 对于图像输入,省略或 `auto` 图像细节可以保留原始尺寸;
-- 对于 Responses 中的 PDF/文件输入,省略或 `input_file.detail: "auto"` 可以使用高页面图像细节;
-- Chat Completions 文件输入不提供相同的细节控制;
-- 长上下文的 Sol 和 Terra 请求可能跨越定价阈值;
-- Luna 较小的上下文可能破坏适用于 Sol 或 Terra 的工作负载。
+- 对于图像输入,省略或 `auto` image detail 可以保留原始尺寸;
+- 对于 Responses 中的 PDF/文件输入,省略或 `input_file.detail: "auto"` 可以使用高页面图像 detail;
+- Chat Completions 的文件输入不提供相同的 detail 控制;
+- 长上下文的 Sol 和 Terra 请求可能会跨越定价阈值;
+- Luna 较小的上下文可能会影响原本适用于 Sol 或 Terra 的工作负载。
-对于多模态或长上下文的使用场景:
+用于多模态或长上下文场景:
-1. 在前后测量输入令牌和延迟。
-2. 在成本或延迟重要时,明确细节。
-3. 当任务不需要原始空间精度时,调整图像大小或使用较低细节。
-4. 对于密集、坐标敏感、OCR、本地化或视觉检查任务,保留原始/高细节,如果它能显著提高质量。
-5. 测试最坏情况的上下文长度,而不仅仅是典型请求。
+1. 在调整前后测量输入 token 和延迟。
+2. 当成本或延迟很重要时,明确指定 detail 参数。
+3. 当任务不需要原始空间精度时,缩小图像或使用更低的 detail 设置。
+4. 对于密集、依赖坐标、OCR、本地化或视觉检查等任务,保留 original/高 detail 设置,因为它能显著提升质量。
+5. 测试最坏情况下的上下文长度,而不仅仅是典型请求。
-不要仅凭缺少元数据标志就声称某项能力已被移除。请对照当前文档和代表性请求进行验证。
+不要仅凭缺失的元数据标志就声称某个功能被移除了。请对照最新文档和一个有代表性的请求进行核实。
## 结构化输出、解析器与工具契约
-保持输出契约明确:
+明确输出契约:
-- 保留 JSON 模式、必填字段、枚举、拒绝处理和解析器预期;
-- 保留工具名称、参数模式、调用 ID 和重试行为;
-- 当下游消费者需要引用、证据字段或原生产物时,保留它们;
-- 验证最终答案仍然满足契约,而不仅仅是工具调用成功。
+- 保留 JSON 架构、必填字段、枚举、拒绝处理以及解析器预期;
+- 保留工具名称、参数架构、调用 ID 和重试行为;
+- 当下游消费者需要时,保留引用、证据字段或原生产物;
+- 验证最终答案仍满足契约,而不仅仅是工具调用成功。
-不要通过削弱架构、删除必需行为、移除路由、丢弃工具或更改业务逻辑来修复失败的迁移,除非用户明确要求该产品变更。
+除非用户明确要求此类产品变更,否则不得通过削弱 schema、删除必需行为、移除路由、丢弃工具或修改业务逻辑来修复失败的迁移。
## 可选:Pro 模式
-在基线迁移期间,除非旧有使用方式类似 Pro,或用户明确要求,否则不要启用 Pro 模式。
+在基线迁移期间不要启用 Pro 模式,除非旧的使用方式本身类似 Pro,或用户明确要求启用。
-GPT-5.6 Pro 使用带有推理模式的基础模型:
+GPT-5.6 Pro 使用基础模型配合推理模式:
```json
{
@@ -296,34 +296,34 @@ GPT-5.6 Pro 使用带有推理模式的基础模型:
规则:
-- 使用 Responses,而非 Chat Completions;
-- 不要搜索或发明单独的 `gpt-5.6-pro` slug;
-- 受支持的 Pro 方案从 `medium`;
-- 模式和力度是独立的决策;
-- 将任务质量、总延迟和实际计费的令牌使用量与标准模式进行比较。
+- 使用 Responses,而不是 Chat Completions;
+- 不要去查找或自行构造一个额外的 `gpt-5.6-pro` slug;
+- 支持的 Pro 工作从 `medium`;
+- mode 与 effort 是彼此独立的决策;
+- 需在 standard mode 下,对比任务质量、整体延迟以及实际计费的 token 用量。
-如果迁移旧版 Pro 套餐,请明确进行模式变更,并将其与普通的 Sol 迁移分开评估。
+如果迁移遗留的 Pro slug,请将模式变更显式化,并将其与普通的 Sol 迁移分开评估。
## 可选:编程式工具调用
-程序化工具调用并非迁移至 GPT-5.6 的必需部分。仅在代码能在大型结构化中间结果返回至模型上下文之前缩减其体积时,才添加此功能。
+程序化工具调用不是迁移到 GPT-5.6 的必需部分。只有当代码能够在大量结构化的中间结果返回到模型上下文之前对其进行缩减时,才加入它。
-合适的候选示例:
+合适的候选场景:
-- 有界的只读过滤、联接、排序、排名、去重和聚合;
-- 批量处理许多相似记录;
-- 重复的确定性验证;
-- 采用紧凑结果模式的类 MapReduce 检索。
+- 有界只读的过滤、连接、排序、排名、去重和聚合;
+- 批量处理多条相似记录;
+- 重复的确定性校验;
+- 采用精简结果模式的 map-reduce 风格检索。
-较差的候选项:
+较差的候选:
- 一次直接的工具调用;
- 每个结果都会改变下一步决策的自适应工作流;
-- 写入、审批或带副作用的流程;
-- 以引用为主或原生制品的流程;
+- 写入、审批或产生副作用的流程;
+- 需要大量引用或原生工件(artifact)的流程;
- 应保持对模型可见的语义判断。
-请求形状要求:
+请求结构要求:
```json
{
@@ -338,49 +338,49 @@ GPT-5.6 Pro 使用带有推理模式的基础模型:
}
```
-不要将 `programmatic_tool_calling` 嵌套在另一个 `tools` 属性之下。启用时,宿主必须处理 `program`、程序签发的 `function_call`, `function_call_output`,以及 `program_output` 项。保留原始 `call_id` 和 `caller` 在返回函数结果时。
+请勿嵌套在 `programmatic_tool_calling` 其他属性下 `tools` 。启用后,宿主必须处理由程序发出 `program`,的项目。返回函数结果时保留原始的 `function_call`, `function_call_output`,和 `program_output` 项目和 `call_id` 以及 `caller` ,用于在返回函数结果时使用。
-限制阶段、符合条件的只读工具、输出模式、重试次数以及交接回直判。验证最终用户可见的答案;正确的程序结果仍可能变成错误的最终答案。
+约束该阶段、合格的只读工具、输出结构、重试上限,以及交接回退到直接判定。校验最终面向用户的答案;即使程序结果正确,最终答案仍可能不正确。
-## 可选:多智能体测试版
+## 可选:多智能体 beta
-在基线迁移期间,除非应用程序已有清晰的并行化工作流且用户明确要求,否则不要启用多智能体行为。
+除非应用已经具备清晰的并行化工作流并且用户主动提出要求,否则在基线迁移期间不要启用多智能体行为。
-启用它需要:
+启用它需要满足以下条件:
-- 该 `OpenAI-Beta: responses_multi_agent=v1` 标题;
+- 该 `OpenAI-Beta: responses_multi_agent=v1` header;
- `multi_agent: { "enabled": true, "max_concurrent_subagents": 3 }`;
-- 处理 `multi_agent_call`, `multi_agent_call_output`,以及 `agent_message` 项;
-- 从任何智能体执行普通的开发者定义的函数调用,并返回所有必需输出;
-- 保留新项以供重放和追踪;
-- 检查当前文档中与压缩、推理摘要和工具调用限制的不兼容性。
+- handling `multi_agent_call`, `multi_agent_call_output`, and `agent_message` items;
+- executing ordinary developer-defined function calls from any 智能体 and returning all required outputs;
+- preserving new items for replay and 追踪;
+- checking incompatibilities with compaction, reasoning summaries, and tool-call limits in current docs.
-限制并发。不要让迁移任务创建无限制的子智能体、重复工作,或在没有最终综合的情况下结束。
+限制并发。不得让迁移任务创建数量不受限制的子智能体、重复执行工作,或在未进行最终综合的情况下完成。
-## 提示词迁移判断
+## Prompt 迁移判断
-在模型和 API 基线正常工作后,在编辑提示之前运行代表性追踪。仅针对实测失败更改提示。
+在模型和 API 基线正常工作后,在编辑提示之前先运行具有代表性的追踪。仅针对已测量到的失败进行提示修改。
-对于 GPT-5.6,优先选择:
+对于 GPT-5.6,建议采用:
-- 更简短、以结果为导向的提示语;
+- 更简短、以结果为导向的提示;
- 明确的成功标准、依赖关系、停止条件和完成边界;
-- 保留用户提供的值;
-- 针对隐式选择的决策标准,而非通用默认值或关键词映射;
-- 明确的自主权和权限边界;
-- 明确的工具路由、资源链接、面包屑导航和预期的工具选择;
-- 分阶段计划、当前层级感知,以及长任务的简洁交接;
-- 在宣布完成之前进行真实验证。
+- 保留用户提供的内容;
+- 为隐式选择提供决策标准,而不是使用通用的默认值或关键字映射;
+- 明确的自主性和权限边界;
+- 明确的工具路由、资源链接、面包屑导航以及预期的工具选择;
+- 分阶段计划、当前层级感知,以及面向长任务的简洁交接;
+- 在声明完成前进行真实验证。
避免:
-- 通用 `be brief`, `be thorough`,或 `think step by step` 指令;
+- generic `be brief`, `be thorough`,或 `think step by step` instructions;
- 可能导致意外语言切换的笼统语言指令;
-- 重复 `ask first` 直到安全的本地工作受阻;
-- 导致回归源头无法识别的巨型提示词重写;
-- 当正确性、证据或所需验证需要更多工作时,告诉模型最小化工具循环。
+- repeating `ask first` 直到安全本地工作被阻塞;
+- 对 prompt 进行大幅重写,导致无法定位回归来源;
+- 在正确性、证据或必要的校验仍需更多工作时,却要求模型尽量减少工具循环。
-对于编码或智能体迁移,添加具体的保留和验证规则:
+对于编码或智能体相关的迁移,请添加具体的保留与验证规则:
```
Preserve existing functionality, routes, outputs, and user-visible behavior.
@@ -389,64 +389,64 @@ Before finishing, run the relevant build, tests, type checks, render or smoke
checks, and report the evidence.
```
-对于长期运行的工作,明确当前层级:研究、设计、实现、审查或外部协调。不要让模型静默切换到其他层级。
+对于长时间运行的工作,需明确当前所处阶段:调研、设计、实现、评审或外部协调。不要让模型悄然切换到其他阶段。
-## 升级工作流
+## 升级 工作流
-1. 获取当前的 5.6 文档以及提示最佳实践部分。
-2. 盘点每个使用位置及其相邻的提示、配置、注册表、解析器和测试面。
-3. 根据角色和迁移类别对每个使用进行分类。
+1. 获取当前实时 5.6 文档以及 Prompting Best Practices 部分。
+2. 清点每个使用点及其相邻的提示、配置、注册表、解析器和测试面。
+3. 按角色和迁移类别对每个使用点进行分类。
4. 根据现有工作负载的角色选择 Sol、Terra 或 Luna。
-5. 明确保留旧的有效推理努力。
+5. 显式保留旧的等效推理强度。
6. 运行兼容性检查:
- 端点和 SDK 支持;
- - Chat Completions 加上函数工具;
- - 缓存拓扑和缓存字段;
- - 上下文长度和长上下文成本;
- - 图像、PDF 和文件详情;
- - 结构化输出和解析器;
- - Responses 状态重放和工具 延续;
- - 混合模型路由和不支持的字段。
-7. 应用最小安全模型、配置、注册表和提示更改。
-8. 除非必要且可衡量,否则不要添加可选的 Pro、持久化推理、PTC、显式缓存或多智能体行为。
-9. 运行现有测试和代表性评估。
-10. 分别报告已更改、未更改、被阻止和需要确认的位置。
+ - Chat Completions 与函数工具;
+ - 缓存拓扑与缓存字段;
+ - 上下文长度与长上下文成本;
+ - 图像、PDF 与文件 detail;
+ - 结构化输出与解析器;
+ - Responses 状态重放与工具 延续;
+ - 混合模型路由与不支持的新字段。
+7. 应用最小且安全的模型、配置、注册表与提示更改。
+8. 除非必要且可衡量,否则不要添加可选的 Pro、持久推理、PTC、显式缓存或多 智能体 行为。
+9. 运行现有测试和具有代表性的评估。
+10. 分别报告已更改、未更改、被阻止以及需要确认的站点。
## 验证矩阵
-更倾向于进行受控对比:
+首选可控对比:
1. 旧模型 + 旧提示词 + 旧设置;
-2. GPT-5.6 目标 + 相同提示词 + 保留的有效推理;
-3. GPT-5.6 目标 + 相同提示词 + 降低一档努力程度;
-4. GPT-5.6 目标 + 由实测失败所需的最小提示词或 API 修复;
-5. 可选功能处理,与基线隔离。
+2. GPT-5.6 目标 + 相同提示词 + 保留有效推理;
+3. GPT-5.6 目标 + 相同提示词 + 降低一档 effort;
+4. GPT-5.6 目标 + 测得失败所需的最小提示词或 API 修复;
+5. 可选特性处理,与基线隔离。
-衡量对工作流重要的指标:
+衡量对 工作流 真正重要的事项:
-- 任务成功率和用户可见质量;
-- 结构化输出有效性和解析成功率;
+- 任务成功率和用户可见的质量;
+- 结构化输出的有效性与解析器成功率;
- 工具选择、工具参数、重试次数、循环次数和完成率;
- TTFT、端到端延迟、超时率和并发行为;
-- 输入、输出、推理、缓存和缓存写入令牌;
-- 每个成功任务的成本;
+- 输入、输出、推理、缓存命中和缓存写入 token;
+- 单次成功任务成本;
- 长上下文、压缩和重放行为;
-- 图像/PDF 令牌使用和视觉/OCR 准确性;
-- 完整性、保留行为、引用和验证证据。
+- 图像/PDF 的 token 使用量以及视觉/OCR 准确率;
+- 完整性、保留行为、引用以及校验证据。
-对于模型路由器和选择器,请针对每个角色至少测试一个代表性工作负载。验证最便宜或最快的层级不会意外用于质量关键型工作,且 Sol 不会意外用于所有工作负载。
+对于模型路由器和挑选器,为每个角色至少测试一个具有代表性的工作负载。验证最便宜或最快的层级不会被意外用于对质量要求较高的工作,同时验证 Sol 不会被意外用于每一个工作负载。
-## 必需最终报告
+## 必需的最终报告
-返回:
+Return:
-- `Current usage inventory`:每个模型站点、端点、角色、提示面,以及旧的有效推理。
-- `Target mapping`:Sol、Terra、Luna、未更改,或需确认,附原因。
-- `Changes made`:模型字符串、推理设置、提示、注册表、元数据、测试,以及 API 形状变更。
-- `Compatibility checks`:Chat Completions/工具、缓存、状态重放、多模态细节、上下文/成本、模式,以及混合模型路由。
-- `Prompt changes`:每次外科式编辑及其解决的故障模式。
-- `Validation`:命令、评估、追踪、前后测量,以及剩余缺口。
-- `Unchanged sites`:历史、固定、模糊或有意的角色特定用法。
-- `Blockers and open questions`:确切问题、为何猜测不安全,以及最小的下一步。
+- `Current usage inventory`:每个模型站点、端点、角色、提示面,以及原有的有效推理。
+- `Target mapping`:Sol、Terra、Luna、未变更或需确认,并附原因。
+- `Changes made`:模型字符串、推理设置、提示、注册表、元数据、测试,以及 API 形态的变化。
+- `Compatibility checks`:Chat Completions/工具、缓存、状态重放、多模态细节、上下文/成本、模式,以及混合模型路由。
+- `Prompt changes`:每一处精细编辑及其针对的失效模式。
+- `Validation`:命令、评估、追踪、前后测量结果以及剩余差距。
+- `Unchanged sites`:历史性的、已固定的、模糊的或有意按角色区分的用法。
+- `Blockers and open questions`:具体问题、为何不能猜测,以及最小的下一步动作。
-切勿仅因模型字符串已更改就宣称迁移已完成。只有当受影响的行为和契约得到验证,或剩余的差距被明确说明时,迁移才算完成。
\ No newline at end of file
+不要仅仅因为模型字符串发生变化就认为迁移已完成。只有在受影响的行为和契约已验证通过,或剩余差距已明确说明时,迁移才算完成。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/video-generation.md b/docs/zh/api/docs/guides/video-generation.md
index bdf64a4..3a16ea1 100644
--- a/docs/zh/api/docs/guides/video-generation.md
+++ b/docs/zh/api/docs/guides/video-generation.md
@@ -1,58 +1,58 @@
# 使用 Sora 生成视频
-> 完整文档索引请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 完整文档索引请参阅 [llms.txt](/llms.txt)。如需 Markdown 版本的文档页面,可在页面 URL 末尾附加 `.md` 来获取。
## 概述
-Sora 是 OpenAI 在生成式媒体领域的最新前沿——一款最先进的视频模型,能够根据自然语言或图像生成细节丰富、动感十足且带音频的片段。基于多年来对多模态扩散的研究,并在多样化的视觉数据上训练,Sora 将 3D 空间、运动和场景连续性的深刻理解带入文本到视频的生成。
+Sora 是 OpenAI 在生成式媒体领域的最新前沿——一款最先进的视频模型,能够根据自然语言或图像创建细节丰富、富有动态感的音频片段。它基于多年对多模态扩散技术的研究,并使用多样化的视觉数据训练而成,将对 3D 空间、运动和场景连续性的深刻理解带入文本生成视频之中。
-该 [Videos API](https://developers.openai.com/api/reference/resources/videos) 首次向开发者开放这些能力,支持视频的程序化创建、扩展、编辑和管理。
+该 [Videos API](https://developers.openai.com/api/reference/resources/videos) 首次将这些能力开放给开发者,支持以编程方式创建、扩展、编辑和管理视频。
你可以使用它来:
-- 根据提示创建新视频。
-- 使用图像参考引导生成过程。
-- 在多次生成中复用角色素材,以实现更强的视觉一致性。
+- 根据提示词创建新视频。
+- 使用图像参考引导生成。
+- 在多次生成中复用角色资产,以获得更强的视觉一致性。
- 通过视频扩展延续已完成的片段。
-- 对现有视频进行有针对性的修改。
-- 下载完成的视频和支持素材。
-- 通过以下方式提交大型离线渲染队列: [批处理 API](https://developers.openai.com/api/docs/guides/batch).
+- 对已有视频进行有针对性的修改。
+- 下载已完成的视频及相关资源。
+- 通过 [Batch API](https://developers.openai.com/api/docs/guides/batch).
## 模型
-第二代 Sora 模型提供两个版本,各自针对不同的使用场景而设计。
+第二代 Sora 模型提供两种变体,每种都针对不同的使用场景进行了定制。
### Sora 2
-`sora-2` 旨在提供 **速度和灵活性**。它非常适合探索阶段,当你正在尝试语气、结构或视觉风格,并且需要快速反馈而非完美保真时。
+`sora-2` 专为 **速度和灵活性**。而设计。它非常适合探索阶段,当你正在试验语气、结构或视觉风格,并需要快速反馈而非完美的保真度时。
-它能快速生成高质量结果,非常适合快速迭代、概念构思和粗剪。 `sora-2` 对于社交媒体内容、原型以及周转时间比超高保真更重要的场景,它通常绰绰有余。
+它能够快速生成质量不错的效果,非常适合快速迭代、构思和粗剪。 `sora-2` 通常足以应对社交媒体内容、原型设计以及那些更看重交付速度而非超高保真度的场景。
### Sora 2 Pro
-`sora-2-pro` 产生更高质量的结果。当你需要 **生产级输出**.
+`sora-2-pro` 生成更高质量的结果。当你需要 **生产级输出**.
-`sora-2-pro` 渲染时间更长且运行成本更高,但能产生更精致、更稳定的结果。它最适合高分辨率电影片段、营销素材以及任何视觉精度至关重要的场景。
+`sora-2-pro` 渲染时间更长,运行成本也更高,但它能产出更精致、更稳定的结果。它最适合高分辨率电影级画面、营销素材,以及任何对视觉精度有严苛要求的场景。
-使用 `sora-2-pro` 当你需要 1080p 导出时, `1920x1080` 或 `1080x1920`.
+在需要以 `sora-2-pro` 导出 1080p 视频时使用 `1920x1080` 或 `1080x1920`.
-两者都 `sora-2` 和 `sora-2-pro` 支持 `16`- 和 `20`- 秒生成。
+两者 `sora-2` 和 `sora-2-pro` 都支持 `16`-秒和 `20`-秒生成。
-## 生成视频
+## Generate a video
生成视频是一个 **异步** 过程:
-1. 当你调用 `POST /videos` 端点时,API会返回一个包含作业 ID 的作业对象 `id` 以及一个初始 `status`.
+1. 当你调用 `POST /videos` endpoint 时,API 会返回一个包含 job `id` 和初始 `status`.
-2. 你可以轮询 `GET /videos/{video_id}` 端点直到状态转为已完成,或采用更高效的方式——使用 webhooks(参见下方 webhooks 部分)在作业完成时自动收到通知。
+2. 你可以轮询 `GET /videos/{video_id}` endpoint 直到状态变为 completed,或者——为了更高效——使用 webhook(见下方 webhook 部分)在任务完成时自动收到通知。
-3. 一旦作业达到 `completed` 状态,你可以通过以下方式获取最终的 MP4 文件 `GET /videos/{video_id}/content`.
+3. 当任务达到 `completed` 状态后,你可以通过 `GET /videos/{video_id}/content`.
-### 启动渲染作业
+### 启动渲染任务
-首先调用 `POST /videos` 并传入文本提示和所需参数。提示词定义创意观感——主题、镜头、灯光和运动——而诸如 `size` 和 `seconds` 等参数则控制视频的分辨率和长度。
+首先调用 `POST /videos` 并传入文本提示词和必需参数。提示词决定了视频的创意风格与观感——包括主题、镜头、光照和运动——而诸如 `size` 和 `seconds` 等参数则用于控制视频的分辨率和时长。
-创建视频
+Create a video
```javascript
import OpenAI from "openai";
@@ -139,7 +139,7 @@ curl -X POST "https://api.openai.com/v1/videos" \
```
-响应是一个 JSON 对象,包含唯一 id 和初始状态,例如 `queued` 或 `in_progress`。这意味着渲染任务已开始。
+响应是一个 JSON 对象,包含唯一的 id 和初始状态,例如 `queued` 或 `in_progress`.这意味着渲染任务已启动。
```shell
{
@@ -154,48 +154,48 @@ curl -X POST "https://api.openai.com/v1/videos" \
}
```
-### 选择大小和时长
+### 选择尺寸与时长
-选择满足你生产需求的最小格式:
+选择能满足你生产需求的最小格式:
-- 在迭代提示词、运镜或构图时,请使用较短的片段。
-- 生成最长 `20` 秒的视频,以呈现更长的节拍、更完整的场景或更完整的片段。
-- 在 `sora-2-pro` 中使用更高分辨率的导出格式, `1920x1080` 或 `1080x1920`.
+- 在调试提示词、运动或构图时使用较短的片段。
+- 需要更长的节拍、更饱满的场景或更完整的片段时,生成最长达 `20` 秒的视频。
+- 使用 `sora-2-pro` 以导出更高分辨率的 `1920x1080` 或 `1080x1920`.
-较长的时长和 1080p 任务可能比短暂的 720p 或 480p 渲染花费明显更长的时间,因此在面向用户的流程中请规划更高的延迟。
+较长的时长和 1080p 任务完成所需的时间可能明显长于较短的 720p 或 480p 渲染,因此在为面向用户的工作流做规划时应预留更高的延迟。
### 护栏与限制
-该API强制执行多项内容限制:
+API 强制实施若干内容限制:
-- 仅限适合 18 岁以下受众的内容(未来将提供绕过此限制的设置)。
-- 受版权保护的角色和受版权保护的音乐将被拒绝。
-- 无法生成真实人物(包括公众人物)。
-- 默认情况下,描绘人类相似度的角色上传会被阻止。
-- 目前拒绝包含人脸的输入图像。
+- 仅面向 18 岁以下受众的内容(未来将提供绕过此限制的设置)。
+- 受版权保护的角色形象和受版权保护的音乐将被拒绝。
+- 不能生成真人形象,包括公众人物。
+- 描绘人类形象的素材上传默认会被拦截。
+- 当前会拒绝包含人脸的输入图像。
-确保提示词、参考图像和转录内容遵循这些规则,以避免生成失败。
+确保提示词、参考图像和转录文本遵循这些规则,以避免生成失败。
### 有效提示
-为获得最佳效果,请描述 **镜头类型、主体、动作、场景和灯光**。例如:
+为了获得最佳效果,请描述 **镜头类型、主体、动作、场景和光照**。例如:
-- _“孩子在草地上放红色风筝的广角镜头,金色黄昏阳光,镜头缓慢向上摇摄。”_
-- _“木桌上热气腾腾咖啡杯的特写,晨光透过百叶窗,浅景深。”_
+- _“黄金时刻的阳光下,一个孩子在绿草如茵的公园里放飞红色风筝的远景镜头,摄像机缓慢向上摇摄。”_
+- _“木质桌上一个冒着热气的咖啡杯特写,清晨光线透过百叶窗洒入,景深柔和。”_
-这种程度的明确性有助于模型生成一致的结果,而不会编造不必要的细节。如需更高级的提示技巧,请参阅我们专门的 Sora 2 [提示指南](https://developers.openai.com/cookbook/examples/sora/sora2_prompting_guide).
+这种具体的细节有助于模型产出稳定的结果,避免编造不必要的内容。如需了解更高级的提示技巧,请参阅我们的 Sora 2 [提示指南](https://developers.openai.com/cookbook/examples/sora/sora2_prompting_guide).
### 监控进度
-视频生成需要时间。具体取决于模型、API负载及分辨率, **单次渲染可能需要几分钟**.
+视频生成需要一定时间。具体耗时取决于模型、API 负载和分辨率, **单次渲染可能需要数分钟**.
-为高效管理这一过程,你可以轮询API以请求状态更新,或通过 webhook 接收通知。
+为了高效管理,你可以轮询 API 以请求状态更新,也可以通过 webhook 接收通知。
#### 轮询状态端点
-调用 `GET /videos/{video_id}` 时使用创建调用返回的 id。响应显示作业的当前状态、进度百分比(如果有)以及任何错误。
+Call `GET /videos/{video_id}` 并使用创建调用返回的 id。响应会显示任务的当前状态、进度百分比(若可用)以及任何错误。
-典型状态为 `queued`, `in_progress`, `completed`,以及 `failed`。以合理的间隔进行轮询(例如,每 10–20 秒),如有必要,使用指数退避,并向用户提供作业仍在进行中的反馈。
+常见状态包括 `queued`, `in_progress`, `completed`,以及 `failed`。以合理的间隔进行轮询(例如每 10–20 秒一次),必要时使用指数退避,并向用户反馈任务仍在进行中。
轮询状态端点
@@ -336,13 +336,13 @@ puts("Video successfully completed: #{video.id}")
}
```
-#### 使用 Webhook 接收通知
+#### 使用 Webhook 进行通知
-与其反复轮询作业状态, `GET`,不如注册一个 [webhook](https://developers.openai.com/api/docs/guides/webhooks) ,以便在视频生成完成或失败时自动收到通知。
+无需反复轮询任务状态, `GET`,而是注册一个 [webhook](https://developers.openai.com/api/docs/guides/webhooks) 以便在视频生成完成或失败时自动接收通知。
-你可以在 [webhook 设置页面](https://platform.openai.com/settings/project/webhooks)。中配置 Webhooks。当作业完成时,API 会发出两种事件类型之一: `video.completed` 和 `video.failed`. 每个事件都包含触发它的作业 ID。
+可在你的 [webhook 设置页面](https://platform.openai.com/settings/project/webhooks)。中配置 Webhook。任务结束时,API 会发出以下两种事件类型之一: `video.completed` 和 `video.failed`。每个事件都包含触发该事件的任务 ID。
-示例 webhook 负载:
+示例 webhook 载荷:
```
{
@@ -360,7 +360,7 @@ puts("Video successfully completed: #{video.id}")
#### 下载 MP4
-一旦任务达到状态 `completed`,即可使用以下接口获取 MP4 `GET /videos/{video_id}/content`。该端点会流式传输二进制视频数据并返回标准内容标头,因此你可以直接将文件保存到磁盘,或将其传输到云存储。
+任务进入状态 `completed`,后,使用以下方式获取 MP4: `GET /videos/{video_id}/content`。该端点以流式方式传输二进制视频数据并返回标准的 content 响应头,因此你可以直接将文件保存到磁盘,也可以将其管道传输到云存储。
下载 MP4
@@ -571,11 +571,11 @@ curl -L "https://api.openai.com/v1/videos/video_abc123/content" \
```
-现在你已获得可用于播放、编辑或分发的最终视频文件。下载链接在生成后的最长 1 小时内有效。如需长期存储,请及时将文件复制到你自己的存储系统中。
+现在你已获得可用于播放、剪辑或分发的最终视频文件。下载链接在生成后最长 1 小时内有效。如需长期存储,请及时将文件复制到你自己的存储系统中。
-#### 下载支持资产
+#### 下载支持资源
-对于每个已完成视频,你还可以下载 **缩略图** 和 **精灵表**。这些是轻量级资源,适用于预览、进度条或目录展示。使用 `variant` 查询参数指定要下载的内容。默认值为 `variant=video` 用于 MP4。
+对于每个已完成的视频,你还可以下载 **缩略图** 和 **雪碧图**。这些是轻量级资源,可用于预览、拖动条或目录展示。使用 `variant` 查询参数来指定你要下载的内容。默认值为 `variant=video` ,对应 MP4。
```bash
# Download a thumbnail
@@ -590,18 +590,18 @@ curl -L "https://api.openai.com/v1/videos/video_abc123/content?variant=spriteshe
```
-## 使用图像引用
+## 使用图片引用
-你可以使用输入图像引导生成,该图像作为 **视频的第一帧**。如果输出视频需要保留品牌资产、角色或特定环境的外观,这将非常有用。
+你可以使用一张输入图像来引导生成,该图像将作为 **视频的首帧**。当你需要生成的视频保留品牌素材、角色或特定环境的风格时,这非常有用。
根据请求类型选择 `input_reference` 格式:
-- 使用 `input_reference` 并附带上传的图片,用于 `multipart/form-data` 请求。
-- 使用 `input_reference` 并附带 JSON 对象,用于 `application/json` 请求,包括 Batch。JSON 形式接受 `file_id` 或 `image_url`.
+- 使用 `input_reference` 与上传的图片一起在 `multipart/form-data` 请求中使用。
+- 使用 `input_reference` 与一个 JSON 对象一起在 `application/json` 请求中使用,包括 Batch。JSON 形式接受任一 `file_id` 或 `image_url`.
图像必须与目标视频的分辨率匹配(`size`).
-支持的文件格式为 `image/jpeg`, `image/png`,以及 `image/webp`.
+支持的文件格式包括 `image/jpeg`, `image/png`,以及 `image/webp`.
```bash
curl -X POST "https://api.openai.com/v1/videos" \
@@ -615,31 +615,31 @@ curl -X POST "https://api.openai.com/v1/videos" \
```
-| 输入图像使用 [OpenAI GPT Image 生成](https://developers.openai.com/api/docs/guides/image-generation) | 使用 Sora 2 生成的视频(已转换为 GIF) |
+| 使用以下工具生成的输入图像 [OpenAI GPT Image](https://developers.openai.com/api/docs/guides/image-generation) | 使用 Sora 2 生成的视频(已转换为 GIF) |
| :---------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------: |
-| ![][sora_woman_skyline_original][下载此图像](https://cdn.openai.com/API/docs/images/sora/woman_skyline_original_720p.jpeg) | ![][sora_woman_skyline_video] 提示词: _“她转过身微笑,然后慢慢走出画面。”_ |
-| ![][sora_monster_original_jpeg][下载此图像](https://cdn.openai.com/API/docs/images/sora/monster_original_720p.jpeg) | ![][sora_monster_original_gif] 提示词: _“冰箱门打开了。一个可爱、胖乎乎的紫色怪物从里面出来了。”_ |
+| ![][sora_woman_skyline_original][下载此图像](https://cdn.openai.com/API/docs/images/sora/woman_skyline_original_720p.jpeg) | ![][sora_woman_skyline_video] 提示词: _“她转过身笑了笑,然后慢慢走出画面。”_ |
+| ![][sora_monster_original_jpeg][下载此图像](https://cdn.openai.com/API/docs/images/sora/monster_original_720p.jpeg) | ![][sora_monster_original_gif] 提示词: _“冰箱门打开了。一只可爱、胖乎乎的紫色怪物从里面走了出来。”_ |
## 使用字符以保持一致性
-角色(Character)允许你上传一个可复用的非人类主体,并在多次生成中引用它。当你希望动物、吉祥物或物体在多张画面中保持相同的核心外观、风格和屏幕表现时,这非常有用。
+角色让你可以上传一个可重复使用的非人类主体,并在多次生成中引用它。当你希望某个动物、吉祥物或物体在多个镜头中保持相同的核心外观、风格和画面存在感时,这非常有用。
-角色上传目前最适合短 `2`-到 `4`-秒的片段,
- `16:9` 或 `9:16`,在 `720p` 到 `1080p`。角色源视频在
- 与请求输出的宽高比匹配时效果最佳。如果宽高比
+角色上传目前在较短的 `2`- 到 `4`-秒片段中效果最佳,在
+ `16:9` 或 `9:16`,在 `720p` 到 `1080p`。角色源视频在以下情况下效果最佳:
+ 它们的宽高比与所请求输出的宽高比一致。如果宽高比
不同,角色可能会出现拉伸或变形。单个视频可以
包含最多两个角色。
-角色与 `input_reference`。不同。图像参考只影响
-单次生成的起始帧,而角色素材可以在未来的视频请求中重复使用
-。
+角色与以下内容不同: `input_reference`。图像参考会对单次生成的
+起始帧进行条件约束,而角色资产可以在未来的
+视频请求中重复使用。
-通过上传一个简短的 MP4 片段到 `POST /v1/videos/characters`,来创建角色,然后在创建视频时在 `characters` 数组中包含返回的角色 ID。
+通过上传一段简短的 MP4 片段到 `POST /v1/videos/characters`,来创建角色,然后将返回的角色 ID 包含在创建 `characters` 视频时的数组中。
-默认情况下,描绘人类相似度的角色上传会被阻止。请联系
- 你的客户经理或 [联系我们的销售
- 团队](https://openai.com/contact-sales/) 了解更多关于资格
- 拟真访问权限的信息。
+默认情况下,涉及人类肖像的角色上传会被拦截。请联系
+ 你的账户经理或 [联系我们的销售
+ 团队](https://openai.com/contact-sales/) 了解有关以下资格要求的更多信息:
+ 类人访问。
```bash
curl -X POST "https://api.openai.com/v1/videos/characters" \
@@ -650,10 +650,10 @@ curl -X POST "https://api.openai.com/v1/videos/characters" \
```
-在提示词中逐字提及角色名称。仅传递角色 ID
-不足以在画面中可靠地保留角色。
+在提示中逐字提及角色名称。仅传递角色 ID
+不足以可靠地在镜头中保留该角色。
-角色可与 `input_reference`. 扩展不支持
+角色可以与 `input_reference`。组合使用。扩展不支持
角色。
```bash
@@ -672,16 +672,16 @@ curl -X POST "https://api.openai.com/v1/videos" \
```
-## 扩展已完成的视频
+## Extend completed videos
-视频扩展功能可让你延续已有的完整视频并创建新的拼接结果。在 `video` 字段中提供源视频, `POST /v1/videos/extensions`,添加描述场景应如何延续的提示,然后 API 会以完整源片段为上下文生成下一段。
+视频扩展可以让你延续一段已完成的视频,并生成一个新的拼接结果。在 `video` 字段中提供源视频 `POST /v1/videos/extensions`,添加一段描述场景应如何延续的提示词,API 会以完整的源片段作为上下文来生成下一段。
-当你希望保留运动、镜头方向和场景连续性时,请使用扩展功能。如果只需控制新生成的起始帧,请使用 `input_reference` 代替。
+当你希望保留动作、镜头方向和场景连续性时,可以使用扩展。如果你只需要控制新生成内容的起始帧,请使用 `input_reference` 。
每次扩展最多可增加 `20` 秒。单个视频最多可扩展
- 六次,总长度上限为 `120` 秒。扩展功能
- 目前仅接受源视频和提示,不支持角色
- 或图像引用。
+ 至六次,总长度上限为 `120` 秒。扩展功能
+ 目前仅接受源视频和提示词,不支持角色
+ 或图像参考。
```bash
curl -X POST "https://api.openai.com/v1/videos/extensions" \
@@ -699,17 +699,17 @@ curl -X POST "https://api.openai.com/v1/videos/extensions" \
## 编辑现有视频
-通过编辑,你可以对现有视频进行有针对性的调整,而无需从头重新生成。发送 `POST /v1/videos/edits` 并附上提示词和 `video` 参考,系统会复用原始结构、连续性和构图,同时应用修改。当你进行单一且明确的更改时效果最佳,因为更小、更聚焦的编辑能保留更多原始保真度,并降低引入伪影的风险。
+Editing 允许你对已有的视频进行定向调整,无需从头重新生成。发送 `POST /v1/videos/edits` 一个提示词和一个 `video` 参考,系统会复用原有的结构、连续性和构图,再应用修改。当你只做一个明确的小改动时效果最佳,因为更小、更聚焦的编辑能保留更多原始保真度,并降低引入伪影的风险。
-此前,视频生成可通过 remix 端点进行编辑,该端点
- 即将弃用。新的集成请使用 edits 端点。
+此前可以通过 remix 端点编辑视频生成结果,该端点
+ 已被弃用。新集成请使用 edits 端点。
-该 `video` 字段接受视频 ID 或上传的视频。如果传入
+该 `video` 字段接受视频 ID 或上传的视频。如果你传入一个
视频 ID,API 会根据源视频推断模型。
-仅限符合条件的客户编辑上传的视频。请联系你的
- 客户经理或 [联系我们的销售
- 团队](https://openai.com/contact-sales/) 如果你需要此工作流。
+编辑已上传的视频仅向符合条件的客户提供。请联系你的
+ 账户经理,或 [联系我们的销售
+ 团队](https://openai.com/contact-sales/) 如果你需要此 工作流。
```bash
curl -X POST "https://api.openai.com/v1/videos/edits" \
@@ -724,8 +724,8 @@ curl -X POST "https://api.openai.com/v1/videos/edits" \
```
-如果你上传新视频而非编辑现有生成,请在请求中明确设置
-`model` 。
+如果你上传新视频而不是编辑已有生成结果,请在请求中
+`model` 显式设置。
```bash
curl -X POST "https://api.openai.com/v1/videos/edits" \
@@ -737,36 +737,36 @@ curl -X POST "https://api.openai.com/v1/videos/edits" \
```
-编辑对迭代尤其有价值,因为它让你无需丢弃已有成效的部分即可进行精炼。通过将每次编辑限制为一项明确的调整,你可以保持视觉风格、主体一致性和镜头构图稳定,同时仍能探索情绪、调色或场面调度上的变化。这使得通过小而可靠的步骤构建精致序列变得容易得多。
+Editing 对于迭代尤其有价值,因为它让你在不丢弃已有可用成果的情况下逐步打磨。将每次编辑约束为一项清晰的调整,你可以保持视觉风格、主体一致性和镜头构图稳定,同时仍然探索情绪、配色或布景的变化。这让通过小巧、可靠的步骤来构建精致的序列变得容易得多。
| 原始视频 | 编辑后的生成视频 |
| :----------------------------: | :-----------------------------------------------------------------------------: |
-| ![][sora_monster_original_gif] | ![][sora_monster_orange] 提示词: _“把怪物的颜色改成橙色。”_ |
-| ![][sora_monster_original_gif] | ![][sora_monster_2monsters] 提示词: _“紧接着出现第二只怪物。”_ |
+| ![][sora_monster_original_gif] | ![][sora_monster_orange] 提示词: _“将怪物的颜色改为橙色。”_ |
+| ![][sora_monster_original_gif] | ![][sora_monster_2monsters] 提示词: _“紧接着第二个怪物出现。”_ |
-## 通过批量 API 运行视频任务
+## 通过 Batch API 运行视频任务
-当你需要排队处理大量视频渲染以进行离线处理、审阅管线或工作室工作流时,请使用 [Batch API](https://developers.openai.com/api/docs/guides/batch) 。批处理输入文件中的每一行使用与发送至 `POST /v1/videos`,相同的 JSON 请求体,这使其非常适合镜头列表和计划渲染队列。
+使用 [Batch API](https://developers.openai.com/api/docs/guides/batch) 在需要将大量视频渲染加入离线处理、审片流水线或工作室工作流的队列时使用。批处理输入文件中的每一行使用的 JSON 请求体,与你发送给发送的 接口 的请求体相同,这使得它非常适合镜头清单和定时渲染队列。 `POST /v1/videos`,这使得它非常适合镜头清单和定时渲染队列。
-对于 Batch 中的视频生成:
+批量视频生成:
-- 批处理目前支持 `POST /v1/videos` 。
-- 批处理请求必须使用 JSON,不能使用 multipart。
-- 提前上传资源,并从 JSON 请求体中引用它们。
-- 在批处理中,使用 `input_reference` 进行图像引导生成。在 JSON 请求中,传递 `input_reference` 作为对象,包含 `file_id` 或 `image_url`.
-- Multipart `input_reference` 上传(包括视频参考输入)在批处理中不受支持。
-- 批处理生成的视频可在批处理完成后下载,最长 `24` 小时。
+- Batch 当前支持 `POST /v1/videos` only。
+- Batch 请求必须使用 JSON,不能使用 multipart。
+- 提前上传素材,并在 JSON 请求体中引用它们。
+- 使用 `input_reference` 用于 Batch 中的图像引导生成。在 JSON 请求中,传入 `input_reference` 作为一个对象,配合 `file_id` 或 `image_url`.
+- Multipart `input_reference` 上传,包括视频参考输入,在 Batch 中不受支持。
+- Batch 生成的视频在批次完成后可下载,时长最多为 `24` 小时。
```jsonl
{"custom_id":"shot-001","method":"POST","url":"/v1/videos","body":{"model":"sora-2-pro","prompt":"Slow dolly shot through a miniature paper city at blue hour, soft fog, practical window lights flickering on.","size":"1920x1080","seconds":"20"}}
{"custom_id":"shot-002","method":"POST","url":"/v1/videos","body":{"model":"sora-2-pro","prompt":"Portrait close-up of a red panda chef plating noodles in a stainless-steel kitchen, shallow depth of field.","size":"1080x1920","seconds":"16"}}
```
-当批次达到 `completed`,时,其输出中的视频任务已处于最终状态,例如 `completed`, `failed`,或 `expired`。使用稳定的 `custom_id` 值,以便将批次结果映射回内部镜头 ID、编辑队列或资产管线,然后使用返回的视频 ID 下载最终资产。
+当一个批次达到 `completed`,时,其输出中的视频任务已经进入终态,例如 `completed`, `failed`,或 `expired`。使用稳定的 `custom_id` 值,以便将批次结果映射回你内部的镜头 ID、剪辑队列或资产流水线,然后使用返回的视频 ID 下载最终资产。
## 维护你的库
-使用 `GET /videos` 来枚举你的视频。该端点支持用于分页和排序的可选查询参数。
+在需要以 `GET /videos` 以列举你的视频。该端点支持可选的查询参数,用于分页和排序。
```bash
curl "https://api.openai.com/v1/videos?limit=20&after=video_123&order=asc" \
@@ -774,7 +774,7 @@ curl "https://api.openai.com/v1/videos?limit=20&after=video_123&order=asc" \
```
-使用 `DELETE /videos/{video_id}` 从 OpenAI 的存储中移除你不再需要的视频。
+在需要以 `DELETE /videos/{video_id}` 以移除你不再需要的视频,将其从OpenAI的存储中删除。
```bash
curl -X DELETE "https://api.openai.com/v1/videos/REPLACE_WITH_YOUR_VIDEO_ID" \
diff --git a/docs/zh/api/docs/guides/workload-identity-federation/aws.md b/docs/zh/api/docs/guides/workload-identity-federation/aws.md
index 1bb9aaa..e2554da 100644
--- a/docs/zh/api/docs/guides/workload-identity-federation/aws.md
+++ b/docs/zh/api/docs/guides/workload-identity-federation/aws.md
@@ -1,39 +1,39 @@
# 为 AWS 配置工作负载身份联合
-> 完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获得。
+> 完整文档索引请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
-在以下任一场景中,将 AWS 用作工作负载身份提供方:
+在以下任意场景中,将 AWS 用作工作负载身份提供方:
-- **AWS 出站身份联合:** 从 AWS STS 签发的 OIDC JWT 交换 `GetWebIdentityToken` 为短期 OpenAI 访问令牌。
-- **Amazon EKS:** 将投影的 Amazon EKS 服务账户令牌交换为短期 OpenAI 访问令牌。
+- **AWS 出站身份联合:** 将 AWS STS 颁发的 OIDC JWT 兑换为 `GetWebIdentityToken` 短期有效的 OpenAI 访问令牌。
+- **Amazon EKS:** 将投影的 Amazon EKS 服务账户令牌兑换为短期有效的 OpenAI 访问令牌。
-对于 Codex,请使用此页面获取并检查 AWS 令牌。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) ,将该令牌写入文件并让 Codex 指向该文件。本页中的服务账户映射和 SDK 示例适用于 OpenAI API。
+对于 Codex,使用本页获取并检查 AWS 令牌。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 将该令牌写入文件并指向 Codex。本页中的服务账号映射和 SDK 示例适用于 OpenAI API。
-OpenAI 支持来自出站身份联邦的 AWS 签发的 OIDC JWT,以及
- 由 Amazon EKS 签发的 Kubernetes 投影服务账户令牌。OpenAI 不
+OpenAI 支持来自出站身份联合的、由 AWS 颁发的 OIDC JWT,以及
+ 由 Amazon EKS 颁发的 Kubernetes 投射服务账号令牌。OpenAI 不
支持 SigV4 签名的请求或 AWS STS 临时访问密钥凭据
- 作为工作负载身份联邦的主题令牌。
+ 用作工作负载身份联合的主体令牌。
## AWS 出站身份联合
-AWS 出站身份联合允许 AWS 主体从 AWS STS 请求签名的 OIDC JWT,并将该令牌提供给外部服务。在 OpenAI 工作负载身份联合中,AWS 签发的 JWT 是主题令牌,OpenAI 在签发 OpenAI 访问令牌之前会对其进行验证。
+AWS 出站身份联合允许 AWS 主体从 AWS STS 请求已签名的 OIDC JWT,并将该令牌出示给外部服务。在 OpenAI 工作负载身份联合中,AWS 颁发的 JWT 是 OpenAI 在签发 OpenAI 访问令牌之前进行验证的主体令牌。
### 设置 AWS 出站身份联合
-为将要签发令牌的 AWS 账户启用出站身份联合。有关设置详情,请参阅 AWS 指南: [出站身份联合入门](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_outbound_getting_started.html).
+为将颁发令牌的 AWS 账户启用出站身份联合。设置详情请参阅 AWS 指南, [出站身份联合入门](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_outbound_getting_started.html).
```bash
aws iam enable-outbound-web-identity-federation
```
-记录 AWS 返回的账户专属签发方 URL。你将把此值配置为 OpenAI Workload Identity Provider 的签发方,并且它必须与 AWS 签发令牌中的 `iss` 声明匹配。
+记录由 AWS 返回的账户特定颁发者 URL。你需要将该值配置为 OpenAI 工作负载身份提供程序的颁发者,并且它必须与 `iss` AWS 颁发的令牌中的声明匹配。
AWS STS `GetWebIdentityToken` API 在 STS 全局
- 端点上不可用。请将 AWS CLI 或 SDK 配置为使用区域 STS 端点。
+ 终端节点上不可用。请将 AWS CLI 或 SDK 配置为使用区域性的 STS 终端节点。
-授予工作负载调用 `sts:GetWebIdentityToken`。的权限。在 IAM 中限制受众和最大令牌生存时间,以便 AWS 主体只能为 OpenAI 铸造令牌。此示例允许为受众 `https://api.openai.com/v1` 签发令牌,最大生存时间为 300 秒:
+授予该工作负载调用 `sts:GetWebIdentityToken`。的权限。在 IAM 中限制受众和最长令牌生命周期,以便 AWS 主体只能为 OpenAI 颁发令牌。以下示例允许针对受众 `https://api.openai.com/v1` 颁发最长生命周期为 300 秒的令牌:
```json
{
@@ -56,7 +56,7 @@ AWS STS `GetWebIdentityToken` API 在 STS 全局
}
```
-请求一个 AWS 签发的 OIDC 令牌,受众与你将在 OpenAI Workload Identity Provider 上配置的受众相同。使用 `ES384` 除非你的环境需要 `RS256` 兼容性。
+使用你将在 OpenAI 工作负载身份提供程序上配置的相同受众,向 AWS 申请一个 OIDC 令牌。请使用 `ES384` ,除非你的环境需要 `RS256` 兼容性。
```bash
TOKEN=$(aws sts get-web-identity-token \
@@ -72,7 +72,7 @@ export TOKEN
### 验证 AWS 颁发的令牌
-在配置工作负载身份联合之前,请将 AWS 颁发的令牌导出为 `TOKEN`,然后在本地运行此脚本以检查其声明:
+在配置工作负载身份联合之前,将 AWS 颁发的令牌导出为 `TOKEN`,然后在本地运行此脚本以检查其声明:
```python
import base64
@@ -85,9 +85,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 负载,但不验证令牌签名。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
+此命令在验证令牌签名之前解码 JWT 载荷。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
-解码后的 AWS 颁发的 OIDC 令牌将类似如下:
+解码后的 AWS 颁发的 OIDC 令牌将类似于:
```json
{
@@ -112,52 +112,52 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-并非每个 AWS 颁发的令牌都包含每个 AWS 特定的声明。以下是 `https://sts.amazonaws.com/` 下的声明取决于调用主体、会话上下文和请求标签。
+并非每个 AWS 颁发的令牌都包含所有 AWS 特有的声明。以下项下的声明 `https://sts.amazonaws.com/` 取决于调用主体、会话上下文和请求标签。
验证你计划在 OpenAI 中配置的声明:
-- `iss`:必须与在 OpenAI Workload Identity Provider 中配置的 AWS 账户特定签发者 URL 匹配。
-- `aud`:必须与 `GetWebIdentityToken` 受众以及 OpenAI Workload Identity Provider 受众匹配。
-- `sub`:标识请求令牌的 IAM 主体 ARN。建议匹配精确的角色 ARN。
-- AWS 特定声明:在匹配账户、组织、主体标签或请求标签值之前,将解码后的令牌作为事实来源。
+- `iss`:必须与 OpenAI Workload Identity Provider 中配置的 AWS 账户特定的 issuer URL 相匹配。
+- `aud`:必须与 `GetWebIdentityToken` audience 以及 OpenAI Workload Identity Provider 的 audience 相匹配。
+- `sub`:标识请求该令牌的 IAM principal ARN。优先匹配完全匹配的角色 ARN。
+- AWS 特有的 claims:在匹配账户、组织、principal tag 或 request tag 的值之前,请使用解码后的令牌作为事实来源。
-使用解码后的载荷,将收到的令牌与 OpenAI 中配置的签发者、受众和映射值进行比较。大多数配置问题都可见于 `iss`, `aud`、以及 `sub` 在交换令牌之前的声明中。
+使用解码后的负载,将你收到的令牌与 OpenAI 中配置的 issuer、audience 和 mapping 值进行比较。大多数配置问题都可以在 `iss`, `aud`,以及 `sub` 声明中看到,请在交换令牌前进行检查。
### 设置工作负载身份联合
-在 OpenAI 中为 AWS 账户颁发者创建工作负载身份提供者,然后添加服务账户映射,以匹配来自 AWS 颁发令牌的稳定声明。
+在 OpenAI 中为 AWS 账户签发方创建一个 Workload Identity Provider,然后添加一个匹配 AWS 颁发令牌中稳定声明(stable claims)的服务账号映射。
-首先配置工作负载身份提供者,然后创建服务账户映射。
+请先配置 Workload Identity Provider,然后再创建服务账号映射。
-#### 设置工作负载身份提供程序
+#### 设置 Workload Identity Provider
-1. **创建工作负载身份提供方(Workload Identity Provider)。** 将 **名称** 设置为唯一值,例如 `aws-outbound-prod`。使用 **描述**,例如 `Production AWS outbound identity federation workloads`,以帮助管理员识别该提供方。
+1. **创建 Workload Identity Provider。** 将 **Name** 设置为唯一值,例如 `aws-outbound-prod`。使用 **Description**(例如 `Production AWS outbound identity federation workloads`)帮助管理员识别该 provider。
-2. **设置签发方(issuer)和受众(audience)。** 将 **OIDC 签发方 URL** 设置为启用出站身份联合时返回的 AWS 账户专用签发方 URL。该值必须与令牌的 `iss` 声明匹配。将 **受众** 设置为传递给 `GetWebIdentityToken`。的相同受众。在本示例中,该值为 `https://api.openai.com/v1`.
+2. **设置 issuer 和 audience。** 将 **将 OIDC Issuer URL** 设置为启用出站身份联合时返回的 AWS 账户特定 issuer URL。该值必须与令牌中的 `iss` 声明匹配。将 **Audience** 设置为传递给 `GetWebIdentityToken`。的同一个 audience。在本例中,该值为 `https://api.openai.com/v1`.
-3. **使用 AWS OIDC 发现。** 保持 **使用上传的 JWKS 进行令牌验证** 为禁用状态。 OpenAI 使用 AWS 签发方的 OIDC 发现元数据和 JWKS 来验证 AWS 签发的令牌。
+3. **使用 AWS OIDC 发现。** 将 **Use uploaded JWKS for token verification** 保持禁用。OpenAI 使用 AWS issuer 的 OIDC 发现元数据和 JWKS 来验证 AWS 颁发的令牌。
-4. **仅当需要派生映射属性时,才添加属性转换。** 原始令牌匹配支持顶层标量声明,例如 `sub`, `aud`,以及 `iss`。AWS 特定的命名空间声明嵌套在 `https://sts.amazonaws.com/`,下,因此在使用它们进行映射之前,请使用 CEL 方括号表示法创建派生属性。例如,输入 `aws_environment` 并使用表达式 `assertion["https://sts.amazonaws.com/"]["principal_tags"]["environment"]` 来创建 `openai.aws_environment` ,基于上述解码令牌示例。使用前,请在示例令牌中验证嵌套声明路径;如果转换无法评估,映射解析将失败。已以 `openai.` 开头的原始令牌声明,除非配置了匹配的转换,否则将被忽略 `openai.` 用于映射键。
+4. **仅在需要派生映射属性时才添加属性转换。** 原始令牌匹配支持顶级标量声明,例如 `sub`, `aud`,以及 `iss`。AWS 特定的命名空间声明嵌套在 `https://sts.amazonaws.com/`,之下,因此请使用 CEL 方括号表示法创建派生属性后再在映射中引用。例如,输入 `aws_environment` ,表达式为 `assertion["https://sts.amazonaws.com/"]["principal_tags"]["environment"]` ,即可创建 `openai.aws_environment` ,源自上述解码后的令牌示例。请在样本令牌中验证嵌套声明路径后再使用;如果某个变换无法求值,映射解析将失败。已以 `openai.` 开头的原始令牌声明在 `openai.` 映射键中将被忽略,除非配置了匹配的变换。
#### 设置服务账号映射
-1. **创建服务账户映射。** 将 **Name** 设置为在 Workload Identity Provider 内唯一的值,例如 `aws-role-openai-wif`。使用 **Description**,例如 `Production AWS role for OpenAI API workload`,来解释哪些工作负载可以使用此映射。
+1. **创建一个服务账号映射。** 将 **Name** 为一个在 Workload Identity Provider 内唯一的值,例如 `aws-role-openai-wif`。使用 **Description**(例如 `Production AWS role for OpenAI API workload`,以说明哪些工作负载可以使用该映射。
-2. **匹配 AWS 主体。** 将 **Key** 设置为 `sub` 和 **Value** 设置为解码令牌中的 IAM 主体 ARN,例如 `arn:aws:iam::123456789012:role/OpenAIWifRole`。匹配精确的 `sub` 声明可为 AWS 出站身份联合提供最强的隔离。
+2. **匹配 AWS 主体。** 将 **Key** 为 `sub` , **Value** 为解码后令牌中的 IAM 主体 ARN,例如 `arn:aws:iam::123456789012:role/OpenAIWifRole`。对精确的 `sub` 声明进行匹配可以为 AWS 出站身份联合提供最强的隔离。
-3. **如有需要,添加额外的声明匹配。** 你可以匹配任何可用的标量声明或转换后的属性。例如,如果你需要额外的信任边界,可以使用源自 AWS 账户、组织、主体标签或请求标签声明的转换属性。
+3. **根据需要添加额外的声明匹配。** 你可以匹配任何可用的标量声明或转换后的属性。例如,如果需要额外的信任边界,可以使用从 AWS 账户、组织、主体标签或请求标签声明派生的转换后属性。
-4. **选择 OpenAI 目标。** 将 **Project** 设置为拥有目标服务账户的 OpenAI 项目。将 **Service account** 设置为 AWS 工作负载可使用的 OpenAI 服务账户,例如 `aws-outbound-prod-openai-wif`.
+4. **选择 OpenAI 目标。** 将 **Project** 为拥有目标服务账号的 OpenAI 项目。将 **Service account** 设置为 AWS 工作负载可以使用的 OpenAI 服务账号,例如 `aws-outbound-prod-openai-wif`.
-5. **如需要,缩小 API 权限范围。** 选择适当的 **Permissions** ,例如 `api.model.request` 和 `api.vector_store.read` ,以进一步限制从此映射铸造的访问令牌。将权限留空以避免添加 WIF 特定的范围限制;令牌仍可授权为映射的服务账户。
+5. **根据需要收窄 API 权限。** 选择合适的 **Permissions** such as `api.model.request` , `api.vector_store.read` to further narrow access tokens minted from this mapping. Leave permissions blank to avoid adding a WIF-specific scope restriction; the token still authorizes as the mapped service account.
-### 在代码中使用令牌
+### 在代码中使用 token
-配置你的 OpenAI SDK 客户端,以从 AWS STS 请求 AWS 颁发的 OIDC 令牌,并将其交换为 OpenAI 颁发的访问令牌。
+配置你的 OpenAI SDK 客户端,向 AWS STS 请求 AWS 颁发的 OIDC 令牌,并将其兑换为 OpenAI 颁发的访问令牌。
-设置 `OPENAI_WIF_AUDIENCE` 为与在 OpenAI Workload Identity Provider 上配置的受众相同。主题令牌提供程序使用该受众调用 AWS STS `GetWebIdentityToken` ,返回 AWS 颁发的 JWT 作为主题令牌,并且 OpenAI SDK 将其交换为 OpenAI 颁发的访问令牌。
+将 `OPENAI_WIF_AUDIENCE` 设置为在 OpenAI Workload Identity Provider 上配置的相同受众。subject token provider 使用该受众调用 AWS STS, `GetWebIdentityToken` 返回 AWS 颁发的 JWT 作为 subject token,并由 OpenAI SDK 将其兑换为 OpenAI 颁发的访问令牌。
-从 AWS 颁发的 OIDC 令牌进行身份验证
+使用 AWS 颁发的 OIDC 令牌进行身份验证
```javascript
import { GetWebIdentityTokenCommand, STSClient } from "@aws-sdk/client-sts";
@@ -508,21 +508,21 @@ puts(response.output_text)
-## Amazon EKS 投射服务账户令牌
+## Amazon EKS projected service account tokens
-通过将 EKS 签发的投影服务账户令牌交换为短期 OpenAI 访问令牌,将 Amazon EKS 用作工作负载身份提供者。
+使用 Amazon EKS 作为工作负载身份提供者,通过将 EKS 颁发的投影服务账户令牌交换为短期 OpenAI 访问令牌。
### 设置 EKS
-使用一个 Kubernetes `ServiceAccount` 来处理需要调用 OpenAI API 的 EKS 工作负载。如果你还没有,请创建一个:
+使用 Kubernetes `ServiceAccount` 为需要调用 OpenAI API 的 EKS 工作负载创建(如果你还没有):
```bash
kubectl create serviceaccount openai-wif --namespace default
```
-EKS 投射的服务账户令牌使用 `sub` 声明,其格式为 `system:serviceaccount::`。对于上述服务账户, `sub` 声明为 `system:serviceaccount:default:openai-wif`.
+EKS 投影的服务账户令牌使用 `sub` 声明,格式为 `system:serviceaccount::`。对于上述服务账户, `sub` 声明为 `system:serviceaccount:default:openai-wif`.
-检索与 EKS 集群关联的 OIDC 签发者 URL:
+检索与 EKS 集群关联的 OIDC 颁发者 URL:
```bash
aws eks describe-cluster \
@@ -538,9 +538,9 @@ aws eks describe-cluster \
https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3
```
-你在 OpenAI 工作负载身份提供程序中配置的签发者必须与此签发者 URL 匹配,并且 `iss` 声明必须与投射的 EKS 服务账户令牌中的声明匹配。
+你在 OpenAI Workload Identity Provider 中配置的颁发者必须与此颁发者 URL 以及 `iss` EKS 投影的服务账户令牌中的声明匹配。
-配置投射的服务账户令牌,使用 OpenAI 期望的受众,并设置适合你工作负载的过期时间。OpenAI 会验证令牌的签发者、签名、受众和过期时间。在此示例中,令牌文件挂载在 `/var/run/secrets/tokens/token`,使用受众 `https://api.openai.com/v1`,并在 3600 秒后过期。如果投射令牌受众与 OpenAI 工作负载身份提供程序的受众匹配,你也可以使用不同的受众:
+使用 OpenAI 期望的受众(audience)以及适合你工作负载的过期时间来配置投影的服务账户令牌。OpenAI 会校验令牌的颁发者、签名、受众和过期时间。在本例中,令牌文件挂载到 `/var/run/secrets/tokens/token`,使用的受众为 `https://api.openai.com/v1`,并在 3600 秒后过期。如果投影令牌的受众与 OpenAI Workload Identity Provider 的受众一致,你也可以使用其他受众:
```yaml
apiVersion: v1
@@ -567,16 +567,16 @@ spec:
expirationSeconds: 3600
```
-### 验证 EKS 令牌
+### 验证 EKS token
-在配置工作负载身份联合之前,先在本地解码一个示例投射服务账户令牌并检查其声明。从挂载有投射令牌的运行中的 Pod 中检索该令牌并将其导出为 `TOKEN`:
+在配置工作负载身份联合之前,请在本地解码一个示例的投影服务账户令牌并检查其声明。在已挂载投影令牌的运行中 Pod 中,获取该令牌并将其导出为 `TOKEN`:
```bash
TOKEN=$(kubectl exec -n default openai-wif-app -- cat /var/run/secrets/tokens/token)
export TOKEN
```
-然后运行此脚本:
+然后运行以下脚本:
```python
import base64
@@ -589,9 +589,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 负载而不验证令牌签名。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
+此命令在验证令牌签名之前解码 JWT 载荷。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
-解码后的 EKS 投射服务账户令牌将类似于:
+解码后的 EKS 投影服务账户令牌类似如下:
```json
{
@@ -610,45 +610,45 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-使用解码后的负载,将你收到的令牌与在 OpenAI 中配置的颁发者、受众和映射值进行比较。大多数配置问题在 `iss`, `aud`,和 `sub` 声明中即可发现,无需先交换令牌。
+使用解码后的负载,将你收到的令牌与 OpenAI 中配置的 issuer、audience 和 mapping 值进行比较。大多数配置问题都可以在 `iss`, `aud`,以及 `sub` 声明中看到,请在交换令牌前进行检查。
### 设置工作负载身份联合
-在 OpenAI 中为 EKS 签发者创建工作负载身份提供者,然后添加一个服务账户映射,以匹配来自投影令牌的属性。
+在 OpenAI 中为 EKS 签发方创建一个 Workload Identity Provider,然后添加一个与投影令牌中属性相匹配的服务账户映射。
-先配置工作负载身份提供者,再创建服务账户映射。
+请先配置 Workload Identity Provider,然后再创建服务账号映射。
-#### 设置工作负载身份提供商
+#### 设置 Workload Identity Provider
-1. **创建工作负载身份提供者。** 将 **名称** 设置为唯一值,例如 `aws-eks-prod`。使用 **描述**,例如 `Production EKS cluster`,以帮助管理员识别集群。
+1. **创建 Workload Identity Provider。** 将 **Name** 设置为唯一值,例如 `aws-eks-prod`。使用 **Description**(例如 `Production EKS cluster`,以帮助管理员识别该集群。
-2. **设置颁发者和受众。** 将 **OIDC 颁发者 URL** 设置为 `aws eks describe-cluster --query "cluster.identity.oidc.issuer"`。返回的颁发者。此值必须与投影的 EKS 服务账户令牌中的 `iss` 声明匹配。将 **受众** 设置为与投影的服务账户令牌卷上配置的受众相同。在此示例中,该值为 `https://api.openai.com/v1`.
+2. **设置 issuer 和 audience。** 将 **将 OIDC Issuer URL** 设置为由以下内容返回的签发者 `aws eks describe-cluster --query "cluster.identity.oidc.issuer"`。此值必须与 `iss` 投影的 EKS 服务账户令牌中的声明匹配。设置 **Audience** 为投影的服务账户令牌卷上配置的相同受众。在本例中,该值为 `https://api.openai.com/v1`.
-3. **使用 EKS OIDC 发现。** 保持 **使用上传的 JWKS 进行令牌验证** 为禁用状态。OpenAI 使用 EKS 颁发者的 OIDC 发现元数据和 JWKS 来验证投影的服务账户令牌。
+3. **使用 EKS OIDC 发现。** 将 **Use uploaded JWKS for token verification** 已禁用。OpenAI 使用 EKS 签发者的 OIDC 发现元数据和 JWKS 来验证投影的服务账户令牌。
-4. **仅在需要派生映射属性时才添加属性转换。** 诸如原始令牌声明 `sub`, `aud`,以及 `iss` 可直接用于映射断言。例如,创建名为 `subject` 的转换属性,其表达式为 `assertion.sub`。在仪表板中,输入 `subject` 作为属性名称;OpenAI将其存储为 `openai.subject`,可在映射中引用。
+4. **仅在需要派生映射属性时才添加属性转换。** 原始令牌声明,例如 `sub`, `aud`,以及 `iss` 可直接用于映射断言。例如,创建名为 `subject` ,表达式为 `assertion.sub`。的转换属性。在控制台中,输入 `subject` 作为属性名;OpenAI 将其存储为 `openai.subject`,你可以在映射中引用该值。
- > **注意:** 已以 `openai.` 开头的原始令牌声明在用于 `openai.` 映射键时会被忽略,除非配置了匹配的转换。
+ > **注意:** 已以以下内容开头的原始令牌声明 `openai.` 开头的原始令牌声明在 `openai.` 映射键中将被忽略,除非配置了匹配的变换。
#### 设置服务账号映射
-1. **创建服务账号映射。** 设置 **名称** 为工作负载身份提供者中的唯一值,例如 `openai-mapping-eks`。使用 **描述**,例如 `Workload Identity Provider Mapping for EKS Workloads`,以说明哪些工作负载可以使用该映射。
+1. **创建一个服务账号映射。** 将 **Name** 设置为 Workload Identity Provider 内的唯一值,例如 `openai-mapping-eks`。使用 **Description**(例如 `Workload Identity Provider Mapping for EKS Workloads`,以说明哪些工作负载可以使用该映射。
-2. **匹配 EKS 服务账号主体。** 设置 **键** 为 `sub` 和 **值** 为 `system:serviceaccount:default:openai-wif`。你可以匹配任何可用的声明或转换后的属性。匹配 `sub` 是最严格的选项,因为它能唯一标识 Kubernetes 服务账号。
+2. **匹配 EKS 服务账户主体。** 将 **Key** 为 `sub` , **Value** 为 `system:serviceaccount:default:openai-wif`。你可以匹配任意可用的声明或转换属性。匹配 `sub` 是限制最严格的选项,因为它能唯一标识一个 Kubernetes 服务账户。
-3. **选择 OpenAI 目标。** 设置 **项目** 到拥有目标服务账户的 OpenAI 项目。设置 **Service account** 为 EKS 工作负载可以使用的 OpenAI 服务账户,例如 `aws-eks-prod-openai-wif`。检查 `Create a new service account in this project` 如果你想为此映射创建一个新的服务账户,而不是复用现有账户。
+3. **选择 OpenAI 目标。** 将 **Project** 为拥有目标服务账号的 OpenAI 项目。将 **Service account** 设置为 EKS 工作负载可使用的 OpenAI 服务账户,例如 `aws-eks-prod-openai-wif`。检查 `Create a new service account in this project` 如果你希望为此映射新建一个服务账号而不是复用现有的服务账号。
-4. **如有需要,缩小 API 权限。** 选择适当的 **Permissions** ,例如 `api.model.request` 和 `api.vector_store.read` 以进一步缩小从此映射铸造的访问令牌范围。将权限留空可避免添加特定于 WIF 的范围限制;令牌仍以映射的服务账户身份进行授权。
+4. **根据需要收窄 API 权限。** 选择合适的 **Permissions** such as `api.model.request` , `api.vector_store.read` to further narrow access tokens minted from this mapping. Leave permissions blank to avoid adding a WIF-specific scope restriction; the token still authorizes as the mapped service account.
-### 在代码中使用令牌
+### 在代码中使用 token
-配置你的 OpenAI SDK 客户端,以读取投影的 EKS 服务账户令牌,并将其兑换为 OpenAI 颁发的访问令牌。
+配置你的 OpenAI SDK 客户端,以读取已投射的 EKS 服务账户令牌,并将其交换为 OpenAI 颁发的访问令牌。
-使用挂载的令牌路径,例如 `/var/run/secrets/tokens/token`,作为 SDK 工作负载身份联合提供者的主题令牌来源。SDK 将该 EKS 令牌兑换为 OpenAI 颁发的访问令牌,并使用该 OpenAI 令牌对 API 请求进行身份验证。
+使用挂载的令牌路径,例如 `/var/run/secrets/tokens/token`,作为 SDK 工作负载身份联合提供方的主题令牌来源。SDK 将该 EKS 令牌交换为 OpenAI 颁发的访问令牌,并使用该 OpenAI 令牌对 API 请求进行身份验证。
-以下示例使用自定义主题令牌提供者初始化 OpenAI 客户端。该提供者从挂载的文件路径读取投影的 EKS 服务账户令牌,并将其用作工作负载身份联合的主题令牌。
+以下示例使用自定义主题令牌提供方初始化 OpenAI 客户端。该提供方从挂载的文件路径读取已投射的 EKS 服务账户令牌,并将其用作工作负载身份联合的主题令牌。
-使用 EKS 投影服务账户令牌进行身份验证
+使用 EKS 投射的服务账户令牌进行身份验证
```javascript
import { readFile } from "node:fs/promises";
@@ -936,12 +936,12 @@ puts(response.output_text)
-## AWS 最佳实践
+## AWS best practices
-- 为每个工作负载使用专用的 AWS 身份。为 AWS 出站身份联合使用独立的 IAM 角色,为 EKS 工作负载使用独立的 Kubernetes 服务账户。
-- 为 OpenAI 访问配置专用受众。在 AWS 签发或 EKS 投射的令牌中,以及在 OpenAI Workload Identity Provider 配置中,使用相同的受众值。
-- 保持令牌生命周期在合理的较短期限。对于 AWS 出站身份联合,使用 IAM 条件,例如 `sts:DurationSeconds`;对于 EKS,设置适当的投射令牌过期时间。
-- 优先使用精确主题匹配。对于 AWS 出站令牌,匹配完整的 IAM 主体 ARN;对于 EKS 令牌,匹配完整的 Kubernetes 服务账户主题。
-- 将映射范围限定到稳定边界。当账户、组织、命名空间或转换属性能够减少访问范围且不创建宽泛信任规则时,使用它们。
-- 在交换令牌时重新加载令牌。在需要时请求 AWS 出站令牌,并从挂载的文件路径读取 EKS 投射令牌,以便自动获取轮换后的令牌。
-- 仅授予工作负载所需的权限。使用映射级权限进一步收窄目标 OpenAI 服务账户所授予的访问权限。
\ No newline at end of file
+- 为每个工作负载使用专用的 AWS 身份。为 AWS 出站身份联合使用独立的 IAM 角色,并为 EKS 工作负载使用独立的 Kubernetes 服务账户。
+- 为 OpenAI 访问配置专用的 audience。在 AWS 签发或 EKS 投影的令牌以及 OpenAI Workload Identity Provider 配置中使用相同的 audience 值。
+- 将令牌生命周期保持得合理较短。对于 AWS 出站身份联合,使用 IAM 条件,例如 `sts:DurationSeconds`;对于 EKS,设置合适的投影令牌过期时间。
+- 优先使用精确的主体匹配。对 AWS 出站令牌匹配完整的 IAM 主体 ARN,或对 EKS 令牌匹配完整的 Kubernetes 服务账户主体。
+- 将映射范围限定在稳定的边界。使用账户、组织、命名空间或转换后的属性,前提是它们能在不创建广泛信任规则的前提下缩小访问范围。
+- 在交换令牌时重新加载令牌。按需请求 AWS 出站令牌,并从挂载的文件路径读取 EKS 投影令牌,以便自动获取轮换后的令牌。
+- 仅授予工作负载所需的权限。使用映射级别的权限进一步收窄目标 OpenAI 服务账户所授予的访问权限。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/workload-identity-federation/github-actions.md b/docs/zh/api/docs/guides/workload-identity-federation/github-actions.md
index 08cf2bb..e34bb10 100644
--- a/docs/zh/api/docs/guides/workload-identity-federation/github-actions.md
+++ b/docs/zh/api/docs/guides/workload-identity-federation/github-actions.md
@@ -1,16 +1,16 @@
# 为 GitHub Actions 配置工作负载身份联合
-> 有关完整的文档索引,请参阅 [llms.txt](/llms.txt)。通过在页面 URL 末尾追加 `.md` 可获得文档页面的 Markdown 版本。
+> 如需查看完整的文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取文档页面的 Markdown 版本。
-通过将 GitHub 签发的 OIDC 令牌交换为短期 OpenAI 访问令牌,将 GitHub Actions 用作工作负载身份提供程序。这样工作流即可向 OpenAI API 进行身份验证,而无需在 GitHub 机密中存储长期 API 密钥。
+将 GitHub Actions 用作 Workload Identity Provider,通过交换 GitHub 签发的 OIDC 令牌来获取一个短期有效的 OpenAI 访问令牌。这使得工作流能够在 GitHub secrets 中不存储长期有效的 OpenAI 密钥的情况下,向 API API 进行身份验证。
-对于 Codex,请使用此页面获取并检查 GitHub 令牌。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 将该令牌写入文件并让 Codex 指向该文件。此页面上的服务账户映射和 SDK 示例适用于 OpenAI API。
+对于 Codex,使用此页面获取并检查 GitHub 令牌,然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 将该令牌写入文件并指向 Codex。本页面中的服务账号映射与 SDK 示例同样适用于 OpenAI API。
-GitHub 可以为具有 `id-token: write` 权限并请求身份令牌的 工作流 作业签发签名的 OIDC JWT。OpenAI 在签发 OpenAI 访问令牌之前会验证令牌的颁发者、受众、签名和映射属性。
+GitHub 可以为一个已配置相应 `id-token: write` 权限并请求身份令牌的 工作流 任务签发一个已签名的 OIDC JWT。OpenAI 会在签发 OpenAI 访问令牌之前,校验令牌的颁发者、受众、签名以及映射属性。
## 设置 GitHub Actions
-授予工作流或作业请求 GitHub OIDC token 的权限:
+授予 工作流 或作业请求 GitHub OIDC 令牌的权限:
```yaml
permissions:
@@ -18,9 +18,9 @@ permissions:
contents: read
```
-该 `id-token: write` 权限允许作业请求 OIDC JWT。它不授予对仓库内容的写访问权限。 `contents: read` 权限为 `actions/checkout`.
+该 `id-token: write` 权限允许该作业请求 OIDC JWT,但不会授予仓库内容的写权限。 `contents: read` 权限是 `actions/checkout`.
-使用在您的 OpenAI 工作负载身份提供程序中配置的确切 audience 请求 token。自定义 JavaScript 操作可以调用 `core.getIDToken("your-wif-audience")`;shell 步骤可以直接调用 GitHub 的 OIDC 请求 URL。包含保留 URL 字符的 audience 值,例如 `https://api.openai.com/v1`,在追加到请求 URL 之前应进行 URL 编码:
+使用你在 OpenAI Workload Identity Provider 中配置的精确 audience 来请求令牌。自定义 JavaScript 操作可以调用 `core.getIDToken("your-wif-audience")`;shell 步骤可以直接调用 GitHub 的 OIDC 请求 URL。包含保留 URL 字符的 audience 值,例如 `https://api.openai.com/v1`,应在附加到请求 URL 之前进行 URL 编码:
```bash
AUDIENCE="https://api.openai.com/v1"
@@ -33,22 +33,22 @@ export TOKEN
重要的 GitHub OIDC 声明包括:
-- `iss`:令牌签发者。对于 GitHub Actions,这是 `https://token.actions.githubusercontent.com`.
-- `aud`:工作流请求的受众值。配置 OpenAI 以要求您请求的确切值,例如 `your-wif-audience` 或 `https://api.openai.com/v1`.
-- `sub`:主要主题字符串。GitHub 根据仓库、分支、标签、拉取请求或环境等 工作流元数据构建它。
-- `repository`:运行 工作流的仓库,例如 `my-org/my-repo`.
+- `iss`:令牌颁发者。对于 GitHub Actions 来说,该值为 `https://token.actions.githubusercontent.com`.
+- `aud`:工作流请求的 audience 值。请将 OpenAI 配置为要求完全匹配你所请求的值,例如 `your-wif-audience` 或 `https://api.openai.com/v1`.
+- `sub`:主体 subject 字符串。GitHub 会根据工作流的元数据(例如仓库、分支、标签、拉取请求或环境)来构造它。
+- `repository`:运行该工作流的仓库,例如 `my-org/my-repo`.
- `repository_owner`:拥有该仓库的组织或用户,例如 `my-org`.
-- `ref`:触发 工作流的 Git 引用,例如 `refs/heads/main` 或 `refs/tags/v1.0.0`.
-- `workflow`:工作流声明。使用 GitHub 发出的实际声明值,例如 `deploy` 如果这是您作业中的 工作流声明。
-- `workflow_ref`:工作流文件路径和引用,例如 `my-org/my-repo/.github/workflows/deploy.yml@refs/heads/main`.
-- `environment`:GitHub 环境名称,例如 `production`,当作业使用环境时。
-- `run_id`, `run_number`, `run_attempt`,以及 `job_workflow_ref`:运行和作业标识符,有助于审计或更高级的信任规则。
+- `ref`:触发该工作流的 Git 引用,例如 `refs/heads/main` 或 `refs/tags/v1.0.0`.
+- `workflow`:工作流声明。请使用 GitHub 实际发出的声明值,例如 `deploy` ,如果这就是你作业中的工作流声明。
+- `workflow_ref`:工作流文件路径及引用,例如 `my-org/my-repo/.github/workflows/deploy.yml@refs/heads/main`.
+- `environment`:GitHub 环境名称,例如 `production`,当作业使用了某个环境时。
+- `run_id`, `run_number`, `run_attempt`,以及 `job_workflow_ref`:可用于审计或更高级信任规则的运行和作业标识符。
-如需完整的声明列表和主题格式,请参阅 GitHub 的 [OpenID Connect 参考](https://docs.github.com/en/actions/reference/security/oidc).
+有关完整的声明列表和主题格式,请参阅 GitHub 的 [OpenID Connect 参考](https://docs.github.com/en/actions/reference/security/oidc).
## 验证令牌
-在配置工作负载身份联合之前,将 GitHub OIDC 令牌导出为 `TOKEN`,然后在 工作流 运行器中运行此脚本以检查其声明:
+在配置工作负载身份联合之前,请将 GitHub OIDC 令牌导出为 `TOKEN`,然后在该工作流 运行器中运行以下脚本来检查其声明:
```python
import base64
@@ -61,9 +61,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 负载而不验证令牌签名。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。切勿记录原始 GitHub OIDC 令牌或交换后的 OpenAI 访问令牌。
+此命令会解码 JWT 负载,但不验证令牌签名。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。切勿记录原始的 GitHub OIDC 令牌或交换后得到的 OpenAI 访问令牌。
-解码后的 GitHub Actions OIDC 令牌看起来类似于:
+一个解码后的 GitHub Actions OIDC 令牌看起来类似于:
```json
{
@@ -81,29 +81,29 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-使用解码后的负载,将收到的令牌与在 OpenAI 中配置的颁发者、受众和映射值进行比较。大多数配置问题在处理令牌之前即可在 `iss`, `aud`, `repository`, `ref`,和 `workflow_ref` 声明中可见。
+使用解码后的负载,比较你收到的令牌与在 OpenAI 中配置的 issuer、audience 和映射值。大多数配置问题都可在交换令牌之前的 `iss`, `aud`, `repository`, `ref`,和 `workflow_ref` 声明中看到。
## 设置工作负载身份联合
-在 OpenAI 中为 GitHub Actions 创建一个工作负载身份提供者,然后添加一个服务账户映射,匹配你信任的 GitHub 工作流 声明。
+在 OpenAI 中为 GitHub Actions 创建工作负载身份提供方,然后添加与你要信任的 GitHub 工作流 声明相匹配的服务账号映射。
-首先配置工作负载身份提供者,然后创建服务账户映射。
+先配置工作负载身份提供方,再创建服务账号映射。
-### 设置工作负载身份提供程序
+### 设置 Workload Identity Provider
-1. **创建工作负载身份提供程序。** 将 **名称** 设置为唯一值,例如 `github-actions-prod`。使用 **描述**,例如 `Production GitHub Actions workflows`,以帮助管理员识别提供程序。
+1. **创建 Workload Identity Provider。** 将 **Name** 设置为唯一值,例如 `github-actions-prod`。使用 **Description**,例如 `Production GitHub Actions workflows`,以帮助管理员识别该提供方。
-2. **设置颁发者和受众。** 将 **OIDC 颁发者 URL** 设置为 `https://token.actions.githubusercontent.com`。将 **受众** 设置为你的 工作流 请求的准确受众,例如 `your-wif-audience` 或 `https://api.openai.com/v1`.
+2. **设置 issuer 和 audience。** 将 **OIDC Issuer URL** 设置为 `https://token.actions.githubusercontent.com`。将 **Audience** 设置为你的 工作流 请求所指定的具体 audience,例如 `your-wif-audience` 或 `https://api.openai.com/v1`.
-3. **使用 GitHub OIDC 发现。** 保持 **使用上传的 JWKS 进行令牌验证** 禁用。OpenAI 使用 GitHub 的 OIDC 发现元数据和 JWKS 来验证 GitHub 签名的令牌。
+3. **使用 GitHub OIDC 发现。** 保持 **Use uploaded JWKS for token verification** 为关闭状态。OpenAI 会使用 GitHub 的 OIDC 发现元数据和 JWKS 来验证 GitHub 签名的令牌。
-4. **仅当你需要派生映射属性时,才添加属性转换。** 如 raw GitHub 声明 `repository`, `ref`, 以及 `workflow` 可直接用于映射断言。如果你创建派生属性,仪表盘会自动应用 `openai.` 前缀;例如,输入 `github_repository` 并带有表达式 `assertion.repository` 以创建 `openai.github_repository`. 已经以 `openai.` 开头的 raw token 声明会被忽略,用于 `openai.` 映射键,除非配置了匹配的转换。
+4. **仅当你需要派生映射属性时,才添加属性转换。** 原始的 GitHub 声明,例如 `repository`, `ref`,以及 `workflow` 可在映射断言中直接使用。如果创建派生属性,仪表板会自动添加 `openai.` 前缀;例如,输入 `github_repository` 配合表达式 `assertion.repository` 可创建 `openai.github_repository`。已以 `openai.` 开头的原始 token 声明在 `openai.` 映射键时被忽略,除非配置了匹配转换。
### 设置服务账号映射
-1. **创建服务账号映射。** 将 **Name** 设为 Workload Identity Provider 中的唯一值,例如 `github-actions-main-deploy`。使用 **Description**(例如 `Production deploy workflow on main`)说明哪个 工作流 可以使用该映射。
+1. **创建一个服务账号映射。** 将 **Name** 为 Workload Identity Provider 中的唯一值,例如 `github-actions-main-deploy`。使用 **Description**,例如 `Production deploy workflow on main`,以说明哪个工作流可以使用该映射。
-2. **添加精确的声明断言。** 为每个必须匹配的 GitHub 声明添加一个 **Key** 和 **Value** 行。OpenAI 要求所有配置的行都匹配后才会颁发访问令牌。对于生产部署 工作流,请使用如下断言:
+2. **添加精确的声明断言。** 添加一个 **键** 和 **值** 行,每个必须匹配的 GitHub 声明各占一行。OpenAI 要求所有已配置的行都匹配后才会签发访问令牌。对于生产部署的工作流,请使用如下断言:
```text
iss == "https://token.actions.githubusercontent.com"
@@ -113,23 +113,23 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
workflow_ref == "my-org/my-repo/.github/workflows/deploy.yml@refs/heads/main"
```
- 优先选择 `workflow_ref` 而非 `workflow` 用于特权映射,因为管理员通常意图信任特定的 工作流 文件路径和 ref。工作流名称可以被重命名,且多个 工作流 文件可以共享相同名称。
+ 建议优先 `workflow_ref` 使用 `workflow` 进行特权映射,因为管理员通常希望信任特定的工作流文件路径和 ref。工作流名称可以被重命名,并且多个工作流文件可以共享相同的名称。
- 在映射界面中,将这些作为键/值行输入,例如 **键** `repository` 与 **值** `my-org/my-repo`, **键** `ref` 与 **值** `refs/heads/main`,以及 **键** `workflow_ref` 与 **值** `my-org/my-repo/.github/workflows/deploy.yml@refs/heads/main`. 如果作业使用 GitHub 环境,还需添加 **键** `environment` 与 **值** `production`.
+ 在映射界面中,将这些作为键/值行输入,例如 **键** `repository` 与 **值** `my-org/my-repo`, **键** `ref` 与 **值** `refs/heads/main`,和 **键** `workflow_ref` 与 **值** `my-org/my-repo/.github/workflows/deploy.yml@refs/heads/main`。如果任务使用了 GitHub 环境,还需要添加 **键** `environment` 与 **值** `production`.
- > **注意:** 避免过于宽泛的映射,例如仅信任 `repository_owner == "my-org"`,除非该组织命名空间中的每个仓库都应能够铸造 OpenAI 访问令牌。
+ > **注意:** 避免过于宽泛的映射,例如仅信任 `repository_owner == "my-org"`,除非该所有者命名空间下的每个代码仓库都应该能够生成 OpenAI 访问令牌。
-3. **选择 OpenAI 目标。** 将 **项目** 设置为拥有目标服务账户的 OpenAI 项目。将 **服务账户** 设置为 GitHub 工作流 可以使用的 OpenAI 服务账户,例如 `github-actions-prod-deploy`.
+3. **选择 OpenAI 目标。** 将 **Project** 设置为拥有该目标服务账号的 OpenAI 项目。 **Service account** 设置为 GitHub 工作流 可以使用的 OpenAI 服务账号,例如 `github-actions-prod-deploy`.
-4. **如有需要,缩小 API 权限范围。** 选择合适的 **权限** ,例如 `api.model.request` 和 `api.vector_store.read` ,以进一步缩小此映射所生成的访问令牌的范围。将权限留空可避免添加特定于 WIF 的范围限制;令牌仍以映射的服务账户身份进行授权。
+4. **如需要,收窄 API 权限。** 选择合适的 **Permissions** 例如 `api.model.request` 和 `api.vector_store.read` 以进一步收窄从此映射生成的访问令牌的范围。将权限留空可避免添加 WIF 特定的 scope 限制;该令牌仍然以映射的服务账号身份授权。
-## 在工作流中使用令牌
+## 在工作流中使用该令牌
-配置你的 OpenAI SDK 客户端,以请求 GitHub OIDC 令牌并将其交换为 OpenAI 颁发的访问令牌。
+配置你的OpenAI SDK 客户端以请求 GitHub OIDC 令牌,并将其兑换为 OpenAI 颁发的访问令牌。
-工作流 必须授予 `id-token: write` 权限,并将工作负载身份联合设置传递给 SDK 代码。SDK 从 `ACTIONS_ID_TOKEN_REQUEST_URL` 和 `ACTIONS_ID_TOKEN_REQUEST_TOKEN` GitHub 向作业公开的环境变量请求 GitHub OIDC 令牌,然后使用交换后的 OpenAI 访问令牌对 API 请求进行身份验证。
+工作流 必须授予 `id-token: write` 相应权限,并将工作负载身份联合配置传递给 SDK 代码。SDK 从 GitHub 向任务暴露的 `ACTIONS_ID_TOKEN_REQUEST_URL` 和 `ACTIONS_ID_TOKEN_REQUEST_TOKEN` 环境变量中请求 GitHub OIDC 令牌,然后使用兑换得到的 OpenAI 访问令牌对 API 请求进行身份验证。
-例如,像这样从一个 工作流 运行你的应用程序代码:
+例如,像这样从工作流运行你的应用代码:
```yaml
name: deploy
@@ -159,11 +159,11 @@ jobs:
run: node ./scripts/call-openai.js
```
-将 `OPENAI_WIF_AUDIENCE`, `OPENAI_IDENTITY_PROVIDER_ID`,以及 `OPENAI_SERVICE_ACCOUNT_ID` 存储为 GitHub Actions 变量。它们标识提供商和服务账户,但不是持有者凭据。
+将它们存储 `OPENAI_WIF_AUDIENCE`, `OPENAI_IDENTITY_PROVIDER_ID`,和 `OPENAI_SERVICE_ACCOUNT_ID` 为 GitHub Actions 变量。它们标识提供方和服务账户,但不是持有者凭据。
-以下示例使用自定义主题令牌提供程序初始化 OpenAI 客户端。该提供程序为配置的受众请求 GitHub OIDC 令牌,并将其用作工作负载身份联合的主题令牌。
+以下示例使用自定义 subject token provider 初始化一个 OpenAI 客户端。该 provider 会为配置的 audience 请求 GitHub OIDC token,并将其用作 workload identity federation 的 subject token。
-通过 GitHub Actions OIDC 令牌进行身份验证
+使用 GitHub Actions OIDC token 进行身份验证
```javascript
import OpenAI from "openai";
@@ -607,11 +607,11 @@ puts(response.output_text)
## GitHub Actions 最佳实践
-- 在生产部署中使用环境保护。在 OpenAI 资源可被工作流访问之前,要求审批或分支限制。
-- 按仓库限制映射。尽可能匹配特定于仓库的声明,而不是允许访问组织内的所有仓库。
-- 按分支或 工作流 限制映射。考虑匹配声明,如 `repository`, `ref`, `environment`,或 `workflow_ref` 以限制令牌发放。
-- 为 CI/CD 和生产工作负载使用单独的 OpenAI 服务账户。构建流水线通常需要与已部署应用不同的权限。
-- 避免授予对不可信分叉拉取请求的访问权限。分叉的拉取请求可能执行攻击者控制的代码,不应获得生产凭据。
-- 使用短时交换。GitHub OIDC 令牌旨在用于临时身份验证,应仅在需要时进行交换。
-- 审计仓库所有权变更。仓库转移、重命名和权限变更可能影响现有映射背后的安全假设。
-- 优先采用精确声明匹配。匹配声明,如 `repository`, `ref`,以及 `environment` 而不是依赖组织范围内的信任关系。
\ No newline at end of file
+- 对生产部署使用环境保护。要求在工作流访问生产 OpenAI 资源前进行审批或施加分支限制。
+- 按仓库限制映射。尽可能基于仓库特定的声明进行匹配,避免允许组织内所有仓库访问。
+- 按分支或 工作流 限制映射。考虑匹配诸如 `repository`, `ref`, `environment`,或 `workflow_ref` 等声明,以限制令牌签发。
+- 为 CI/CD 和生产工作负载使用单独的 OpenAI 服务账号。构建流水线通常需要与已部署应用不同的权限。
+- 避免向来自不受信任 fork 的拉取请求授予访问权限。Fork 拉取请求可能执行攻击者控制的代码,不应获取生产凭据。
+- 使用短期交换。GitHub OIDC 令牌用于临时身份验证,只在需要时进行交换。
+- 审计仓库所有权变更。仓库转让、重命名和权限变更可能影响现有映射背后的安全假设。
+- 优先进行精确声明匹配。基于诸如 `repository`, `ref`,以及 `environment` 等声明进行匹配,而不是依赖组织范围内的信任关系。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/workload-identity-federation/google-cloud.md b/docs/zh/api/docs/guides/workload-identity-federation/google-cloud.md
index 849d567..b27b830 100644
--- a/docs/zh/api/docs/guides/workload-identity-federation/google-cloud.md
+++ b/docs/zh/api/docs/guides/workload-identity-federation/google-cloud.md
@@ -1,25 +1,25 @@
# 为 Google Cloud 配置工作负载身份联合
-> 关于完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
在以下任一场景中,将 Google Cloud 用作工作负载身份提供方:
-- **Google 工作负载身份:** 将颁发给已附加的 Google 服务账户的 Google 签名 OIDC 令牌交换为短期 OpenAI 访问令牌。
-- **Google Kubernetes Engine:** 将投射的 GKE 服务账户令牌交换为短期 OpenAI 访问令牌。
+- **Google 工作负载身份:** 将 Google 服务账号签发的、由 Google 签名的 OIDC 令牌交换为短时 OpenAI 访问令牌。
+- **Google Kubernetes Engine:** 将投射的 GKE 服务账号令牌交换为短时 OpenAI 访问令牌。
-对于 Codex,请使用此页面获取并检查 Google token。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 将 token 写入文件,并让 Codex 指向该文件。本页中的服务账号映射和 SDK 示例适用于 OpenAI API。
+对于 Codex,使用此页面获取并检查 Google token。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 将该 token 写入文件并指向 Codex。本页面中的服务账户映射和 SDK 示例适用于 OpenAI API。
-## Google 工作负载身份
+## Google workload identity
-Google Cloud 工作负载可以从 Google 元数据服务器请求签名的 OIDC 身份令牌,而无需存储长期有效的服务账号密钥。在 OpenAI 工作负载身份联合中,Google 身份令牌是 OpenAI 在签发 OpenAI 访问令牌之前验证的主体令牌。此流程适用于使用附加 Google 服务账号的 Compute Engine、Cloud Run、GKE 工作负载,以及其他公开元数据服务器身份端点的 Google 托管运行时。
+Google Cloud 工作负载可以直接从 Google 元数据服务器请求已签名的 OIDC 身份令牌,而无需存储长期的服务账号密钥。在 OpenAI 工作负载身份联合中,Google 身份令牌是 OpenAI 在签发 OpenAI 访问令牌之前进行验证的 subject token。此流程适用于 Compute Engine、Cloud Run、使用挂载的 Google 服务账号的 GKE 工作负载,以及其他暴露元数据服务器身份端点的 Google 托管运行时。
-### 设置 Google 工作负载身份
+### 设置 Google workload identity
-为需要调用 OpenAI API 的工作负载创建一个 Google 服务账号。完整的设置流程,请参阅 Google 指南: [创建服务账号](https://docs.cloud.google.com/iam/docs/service-accounts-create).
+为需要调用 OpenAI API 的工作负载创建一个 Google 服务账号。完整的设置流程,请参阅 Google 的指南: [create service accounts](https://docs.cloud.google.com/iam/docs/service-accounts-create).
-例如,使用 Google Cloud CLI 创建服务账号:
+例如,使用 Google Cloud CLI 创建一个服务账号:
```bash
gcloud iam service-accounts create openai-wif \
@@ -27,13 +27,13 @@ gcloud iam service-accounts create openai-wif \
--display-name="OpenAI workload identity federation"
```
-创建挂载了该服务账号的 Compute Engine VM,或将服务账号挂载到运行你的应用的 Google Cloud 资源上。该资源必须在运行时能够访问 Google 元数据服务器。有关 VM 设置的详细信息,请参阅 Google 指南: [创建使用用户管理服务账号的 VM](https://docs.cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances).
+创建带有该服务账号的 Compute Engine VM,或将该服务账号附加到运行你应用程序的 Google Cloud 资源上。该资源必须能够在运行时调用 Google 元数据服务器。有关 VM 设置的详细信息,请参阅 Google 的指南: [create a VM that uses a user-managed service account](https://docs.cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances).
-不要为此流程创建或下载服务账号密钥。工作负载使用挂载的服务账号和元数据服务器来请求短期 OIDC 令牌。
+在此流程中,不要创建或下载服务账号密钥。工作负载使用附加的服务账号和元数据服务器来请求一个短期有效的 OIDC 令牌。
### 获取 Google 身份令牌
-从附加了服务账号的 Google Cloud 资源中,向元数据服务器请求一个带有已配置受众的 OIDC 身份令牌。此令牌是 OpenAI 用来交换 OpenAI 签发的访问令牌的主题令牌。
+从已绑定服务账号的 Google Cloud 资源,向元数据服务器请求带有已配置受众(audience)的 OIDC 身份令牌。该令牌是主体令牌(subject token),由 OpenAI 用于换取 OpenAI 签发的访问令牌。
```bash
AUDIENCE="https://api.openai.com/v1"
@@ -44,11 +44,11 @@ TOKEN=$(curl -sS -G -H "Metadata-Flavor: Google" \
export TOKEN
```
-元数据服务器返回一个 Google 签名的 JWT。有关元数据服务器身份端点的更多信息,请参阅 Google 的指南: [验证虚拟机身份](https://docs.cloud.google.com/compute/docs/instances/verifying-instance-identity).
+元数据服务器会返回一个由 Google 签名的 JWT。有关元数据服务器身份端点的更多信息,请参阅 Google 提供的 [验证虚拟机身份](https://docs.cloud.google.com/compute/docs/instances/verifying-instance-identity).
### 验证令牌
-在配置工作负载身份联合之前,请将 Google 身份令牌导出为 `TOKEN`,然后在本机运行此脚本以检查其声明:
+在配置工作负载身份联合之前,将 Google 身份令牌导出为 `TOKEN`,然后在本地运行以下脚本来检查其声明:
```python
import base64
@@ -61,9 +61,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 负载,而不验证令牌签名。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
+此命令会在不验证令牌签名的情况下解码 JWT 负载。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
-解码后的 Google 元数据服务器身份令牌将类似于:
+解码后的 Google 元数据服务器身份令牌如下所示:
```json
{
@@ -78,41 +78,41 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-使用解码后的负载,将你收到的令牌与 OpenAI 中配置的签发者、受众和映射值进行比较。大多数配置问题在 `iss`, `aud`, `email`,和 `sub` 声明中可见,然后你再交换令牌。
+使用解码后的负载,将收到的令牌与 OpenAI 中配置的 issuer、audience 和映射值进行比较。大多数配置问题都会在交换令牌之前的 `iss`, `aud`, `email`,和 `sub` 声明中体现出来。
### 设置工作负载身份联合
-在 OpenAI 中为 Google 颁发的身份令牌创建工作负载身份提供程序,然后添加一个服务账户映射,该映射匹配令牌中的稳定声明。
+在 OpenAI 中创建一个针对 Google 颁发的身份令牌的工作负载身份提供方,然后添加一个与令牌中稳定声明匹配的服务账号映射。
-先配置工作负载身份提供程序,再创建服务账户映射。
+请先配置工作负载身份提供方,然后再创建服务账号映射。
-#### 设置 Workload Identity Provider
+#### 设置工作负载身份提供程序
-1. **创建工作负载身份提供程序。** 设置 **名称** 为唯一值,例如 `google-workload-identity-prod`。使用 **描述**,例如 `Production Google Cloud workloads`,以帮助管理员识别提供程序。
+1. **创建工作负载身份提供者。** 设置 **Name** 为唯一值,例如 `google-workload-identity-prod`。使用 **Description**,例如 `Production Google Cloud workloads`,以帮助管理员识别该提供者。
-2. **设置签发者和受众。** 将 **OIDC 签发者 URL** 设置为 `https://accounts.google.com`。将 **受众** 设置为你的工作负载从 Google 元数据服务器请求的自定义受众,例如 `https://api.openai.com/v1`。此值必须与令牌的 `aud` 声明匹配。
+2. **设置 issuer 和 audience。** 设置 **OIDC Issuer URL** 为 `https://accounts.google.com`。设置 **Audience** 为你的工作负载从 Google 元数据服务器请求的自定义 audience,例如 `https://api.openai.com/v1`。该值必须与令牌的 `aud` 声明匹配。
-3. **使用 Google OIDC 发现。** 保持 **使用上传的 JWKS 进行令牌验证** 禁用。OpenAI 使用 Google 的 OIDC 发现元数据和 JWKS 来验证 Google 签名的身份令牌。
+3. **使用 Google OIDC 发现。** 将 **Use uploaded JWKS for token verification** 保持禁用。OpenAI 使用 Google 的 OIDC 发现元数据和 JWKS 来验证 Google 签名的身份令牌。
-4. **如果你需要派生映射属性,请添加属性转换。** 例如,输入 `subject` 使用表达式 `assertion.sub` 以从 subject 声明中创建 `openai.subject` 。仪表板会自动应用 `openai.` 前缀。原始令牌声明如果已以 `openai.` 开头,则会被忽略,用于 `openai.` 映射键,除非配置了匹配的转换。
+4. **如果需要派生映射属性,请添加属性转换。** 例如,输入 `subject` 与表达式 `assertion.sub` 来创建 `openai.subject` 来自 subject claim。仪表板会自动添加 `openai.` 前缀。原始 token claim 如果已经以 `openai.` 开头,将被忽略用于 `openai.` 映射键,除非配置了匹配的转换。
#### 设置服务账号映射
-1. **创建服务账号映射。** 将 **名称** 设置为工作负载身份提供方内的唯一值,例如 `compute-openai-wif`。使用 **描述**,例如 `Production Compute Engine OpenAI API workload`,以说明哪些工作负载可以使用该映射。
+1. **创建服务账号映射。** 设置 **Name** 映射到 Workload Identity Provider 中唯一的值,例如 `compute-openai-wif`。使用 **Description**,例如 `Production Compute Engine OpenAI API workload`,以说明哪些工作负载可以使用该映射。
-2. **匹配稳定的 Google 服务账号声明。** 为每个必须匹配的声明添加 **键** 和 **值** 行。使用 `sub` 作为主要身份绑定,因为它稳定且唯一。你还可以匹配 `email` 以提高可读性。
+2. **匹配稳定的 Google 服务账号声明。** 添加一个 **键** 和 **值** 行,列出所有必须匹配的声明。使用 `sub` 作为主要身份绑定,因为它稳定且唯一。你还可以匹配 `email` 以提高可读性。
-3. **选择 OpenAI 目标。** 将 **项目** 设置为拥有目标服务账号的 OpenAI 项目。将 **服务账号** 授予 Google Cloud 工作负载可使用的 OpenAI 服务账号,例如 `google-workload-identity-prod-openai-wif`.
+3. **选择 OpenAI 目标。** 设置 **项目** 设置为拥有目标服务账号的 OpenAI 项目。设置 **服务账号** 设置为 Google Cloud 工作负载可以使用的 OpenAI 服务账号,例如 `google-workload-identity-prod-openai-wif`.
-4. **如有必要,缩小 API 权限范围。** 选择合适的 **权限** 例如 `api.model.request` 和 `api.vector_store.read` 以进一步缩小从该映射生成的访问令牌范围。将权限留空可避免添加特定于 WIF 的作用域限制;令牌仍会以映射的服务账号身份进行授权。
+4. **必要时收窄 API 权限。** 选择适当的 **权限** ,例如 `api.model.request` 和 `api.vector_store.read` 以进一步收窄从此映射签发的访问令牌。保持权限为留空可避免添加 WIF 专属的作用域限制;该令牌仍会以映射到的服务账户身份进行授权。
-### 在代码中使用令牌
+### 在代码中使用 token
-配置你的 OpenAI SDK 客户端,从元数据服务器请求 Google 身份令牌,并将其交换为 OpenAI 签发的访问令牌。
+配置你的 OpenAI SDK 客户端,从元数据服务器请求 Google 身份令牌并将其交换为 OpenAI 颁发的访问令牌。
-将 `OPENAI_WIF_AUDIENCE` 设置为 Workload Identity Provider 受众所配置的自定义受众。SDK 会为该受众请求 Google 身份令牌,将其交换为 OpenAI 签发的访问令牌,并使用 OpenAI 令牌来验证 API 请求。
+将 `OPENAI_WIF_AUDIENCE` 设置为配置为 Workload Identity Provider 受众的自定义受众。SDK 会为该受众请求 Google 身份令牌,并将其交换为 OpenAI 颁发的访问令牌,然后使用 OpenAI 令牌对 API 请求进行身份验证。
-使用 Google 元数据服务器身份令牌进行身份验证
+从 Google 元数据服务器身份令牌进行身份验证
```javascript
import OpenAI from "openai";
@@ -529,31 +529,31 @@ puts(response.output_text)
## Google Kubernetes Engine
-使用 Google Kubernetes Engine 作为工作负载身份提供方,通过将 GKE 签发的投射服务账户令牌兑换为短期 OpenAI 访问令牌。
+使用 Google Kubernetes Engine 作为工作负载身份提供方,通过交换 GKE 颁发的投射服务账号令牌来获取短期 OpenAI 访问令牌。
GKE 工作负载可以使用以下任一方式进行身份验证:
-- 由集群 OIDC 签发方颁发的 Kubernetes 服务账户令牌。
+- 由集群 OIDC 签发方颁发的 Kubernetes 服务账户令牌投影。
- 通过 GKE Workload Identity 获取的 Google 服务账户身份令牌,其中 Kubernetes 服务账户绑定到 Google 服务账户。
-当你希望 OpenAI 直接信任集群的 OIDC 签发者时,可使用投射的 Kubernetes 服务账户令牌。当你的工作负载已依赖 Google 服务账户身份,且你希望 OpenAI 转而信任 Google 签发的身份令牌时,请使用 GKE Workload Identity。
+当希望 OpenAI 直接信任集群的 OIDC 签发方时,请使用投射式 Kubernetes 服务账户令牌。当你的工作负载已依赖 Google 服务账户身份,并希望 OpenAI 改为信任 Google 签发的身份令牌时,请使用 GKE Workload Identity。
-如果你的 GKE 工作负载已配置 GKE Workload Identity,并且能够从元数据服务器请求
- Google 身份令牌,请遵循 [Google 工作负载
- 身份](#google-workload-identity) 上述说明,而非 GKE
- 投射令牌流程。
+如果你的 GKE 工作负载已配置 GKE Workload Identity,并能通过元数据服务器请求
+ Google 身份令牌,请按照下面的 [Google workload
+ identity](#google-workload-identity) 说明进行操作,而不是使用 GKE 投射式令牌
+ 流程。
-### 设置 GKE
+### Setting up GKE
-这些说明假定使用的是托管 GKE 集群。对于自管理 Kubernetes 集群,请使用 [Kubernetes 指南](https://developers.openai.com/api/docs/guides/workload-identity-federation/kubernetes).
+这些说明假设你使用的是托管 GKE 集群。对于自管 Kubernetes 集群,请使用 [Kubernetes 指南](https://developers.openai.com/api/docs/guides/workload-identity-federation/kubernetes).
-为需要调用 OpenAI API 的 GKE 工作负载使用一个 Kubernetes `ServiceAccount` 。如果你还没有,请创建一个:
+为需要调用 OpenAI API 的 GKE 工作负载使用一个 Kubernetes `ServiceAccount` 。如果还没有,请创建一个:
```bash
kubectl create serviceaccount openai-wif --namespace default
```
-检索与 GKE 集群关联的签发者 URL:
+获取与 GKE 集群关联的 issuer URL:
```bash
kubectl get --raw /.well-known/openid-configuration | jq -r .issuer
@@ -565,9 +565,9 @@ kubectl get --raw /.well-known/openid-configuration | jq -r .issuer
https://container.googleapis.com/v1/projects/my-project/locations/us-central1/clusters/openai-wif
```
-你在 OpenAI Workload Identity Provider 中配置的签发者必须与此签发者 URL 以及投影的 GKE 服务账户令牌中的 `iss` 声明匹配。
+你在 OpenAI Workload Identity Provider 中配置的 issuer 必须与此 issuer URL 以及 `iss` 投影的 GKE 服务账号令牌中的 claim 相匹配。
-配置投影的服务账户令牌,使用 OpenAI 期望的受众和适合你工作负载的过期时间。OpenAI 会验证令牌的签发者、签名、受众和过期时间。在此示例中,令牌文件挂载在 `/var/run/secrets/tokens/token`,使用受众 `https://api.openai.com/v1`,并在 3600 秒后过期。如果投影令牌受众和 OpenAI Workload Identity Provider 受众匹配,则可以使用不同的受众:
+使用 OpenAI 期望的 audience 以及适合你工作负载的过期时间来配置投影的服务账号令牌。OpenAI 会校验令牌的 issuer、签名、audience 和过期时间。在本示例中,令牌文件挂载在 `/var/run/secrets/tokens/token`,使用的 audience 为 `https://api.openai.com/v1`,并在 3600 秒后过期。如果投影令牌的 audience 与 OpenAI Workload Identity Provider 的 audience 一致,你也可以使用其他 audience:
```yaml
apiVersion: v1
@@ -596,7 +596,7 @@ spec:
### 验证令牌
-在配置工作负载身份联合之前,先在本地解码一个示例投射服务账号令牌并检查其声明。从挂载了投射令牌的运行中的 Pod 中检索令牌并将其导出为 `TOKEN`:
+在配置 workload identity federation 之前,请在本地解码一份投影的服务账号令牌样本并检查其声明。在已挂载投影令牌的运行中的 Pod 里,获取该令牌并将其导出为 `TOKEN`:
```bash
TOKEN=$(kubectl exec -n default openai-wif-app -- cat /var/run/secrets/tokens/token)
@@ -616,9 +616,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 载荷时不验证令牌签名。对生产令牌请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
+此命令会在不验证令牌签名的情况下解码 JWT 负载。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
-解码后的 GKE 投射服务账号令牌类似于:
+解码后的 GKE 投影服务账号令牌类似于:
```json
{
@@ -637,43 +637,43 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-使用解码后的载荷将你收到的令牌与 OpenAI 中配置的签发者、受众和映射值进行比较。大多数配置问题在 `iss`, `aud`,以及 `sub` 声明中即可见,之后你才交换令牌。
+使用解码后的负载,将收到的令牌与 OpenAI 中配置的 issuer、audience 和映射值进行比较。大多数配置问题都会在交换令牌之前的 `iss`, `aud`,和 `sub` 声明中体现出来。
### 设置工作负载身份联合
-在 OpenAI 中为 GKE 颁发者创建工作负载身份提供方,然后添加一个服务账号映射,以匹配投影令牌中的属性。
+在 OpenAI 中为 GKE issuer 创建一个 Workload Identity Provider,然后添加一个与投影令牌属性匹配的服务账号映射。
-先配置工作负载身份提供方,然后创建服务账号映射。
+请先配置工作负载身份提供方,然后再创建服务账号映射。
-#### 设置工作负载身份提供商
+#### 设置工作负载身份提供程序
-1. **创建工作负载身份提供程序。** 将 **名称** 设置为唯一值,例如 `google-gke-prod`。使用 **描述**,例如 `Production GKE cluster`,以帮助管理员识别集群。
+1. **创建工作负载身份提供者。** 设置 **Name** 为唯一值,例如 `google-gke-prod`。使用 **Description**,例如 `Production GKE cluster`,以便管理员识别集群。
-2. **设置签发者和受众。** 将 **OIDC 签发者 URL** 设置为由 `kubectl get --raw /.well-known/openid-configuration | jq -r .issuer`。返回的签发者。此值必须与 `iss` 中投射的 GKE 服务账号令牌中的声明匹配。将 **受众** 设置为在投射的服务账号令牌卷上配置的相同受众。在此示例中,该值为 `https://api.openai.com/v1`.
+2. **设置 issuer 和 audience。** 设置 **OIDC Issuer URL** 设置为由 `kubectl get --raw /.well-known/openid-configuration | jq -r .issuer`。此值必须与 `iss` 声明中的值匹配,该声明位于投影的 GKE 服务账号令牌中。设置 **Audience** 为投影服务账号令牌卷上配置的同一受众。在本示例中,该值为 `https://api.openai.com/v1`.
-3. **使用 GKE OIDC 发现。** 将 **使用上传的 JWKS 进行令牌验证** 保持禁用。OpenAI 使用 GKE 签发者的 OIDC 发现元数据和 JWKS 来验证投射的服务账号令牌。
+3. **使用 GKE OIDC 发现。** 将 **Use uploaded JWKS for token verification** 禁用。OpenAI 使用 GKE 颁发者的 OIDC 发现元数据和 JWKS 来验证投影的服务账号令牌。
-4. **如果你需要派生映射属性,请添加属性转换。** 例如,输入 `gke_subject` 并带有表达式 `assertion.sub` 以创建 `openai.gke_subject`。仪表盘会自动应用 `openai.` 前缀。已经以 `openai.` 开头的原始令牌声明在 `openai.` 映射键中会被忽略,除非配置了匹配的转换。
+4. **如果需要派生映射属性,请添加属性转换。** 例如,输入 `gke_subject` 与表达式 `assertion.sub` 来创建 `openai.gke_subject`。仪表板会应用 `openai.` 前缀。原始 token claim 如果已经以 `openai.` 开头,将被忽略用于 `openai.` 映射键,除非配置了匹配的转换。
#### 设置服务账号映射
-1. **创建服务账号映射。** 将 **名称** 设置为工作负载身份提供程序中的唯一值,例如 `default-openai-wif`。使用 **描述**,例如 `Default namespace GKE OpenAI API workload`,来说明哪些工作负载可以使用该映射。
+1. **创建服务账号映射。** 设置 **Name** 映射到 Workload Identity Provider 中唯一的值,例如 `default-openai-wif`。使用 **Description**,例如 `Default namespace GKE OpenAI API workload`,以说明哪些工作负载可以使用该映射。
-2. **匹配 GKE 服务账号主体。** 将 **键** 设置为 `sub` ,并将 **值** 设置为 `system:serviceaccount:default:openai-wif`。对于 GKE 服务账号,主体格式为 `system:serviceaccount::`.
+2. **与 GKE 服务账号 subject 匹配。** 设置 **键** 为 `sub` 和 **值** 为 `system:serviceaccount:default:openai-wif`。对于 GKE 服务账号,subject 格式为 `system:serviceaccount::`.
-3. **选择 OpenAI 目标。** 将 **项目** 设置为拥有目标服务账号的 OpenAI 项目。将 **服务账号** 将 OpenAI 服务账号授予 GKE 工作负载可使用,例如 `google-gke-prod-openai-wif`.
+3. **选择 OpenAI 目标。** 设置 **项目** 设置为拥有目标服务账号的 OpenAI 项目。设置 **服务账号** 设置为 GKE 工作负载可以使用的 OpenAI 服务账号,例如 `google-gke-prod-openai-wif`.
-4. **如有需要,收窄 API 权限。** 选择适当的 **权限** ,例如 `api.model.request` 和 `api.vector_store.read` ,以进一步收窄从此映射生成的访问令牌。将权限留空以避免添加特定于 WIF 的范围限制;令牌仍会授权为映射的服务账号。
+4. **必要时收窄 API 权限。** 选择适当的 **权限** ,例如 `api.model.request` 和 `api.vector_store.read` 以进一步收窄从此映射签发的访问令牌。保持权限为留空可避免添加 WIF 专属的作用域限制;该令牌仍会以映射到的服务账户身份进行授权。
-### 在代码中使用令牌
+### 在代码中使用 token
-配置你的 OpenAI SDK 客户端,以读取投影的 GKE 服务账号令牌,并将其兑换为 OpenAI 签发的访问令牌。
+配置你的 OpenAI SDK 客户端,使其读取已投射的 GKE 服务账号令牌,并将其交换为 OpenAI 颁发的访问令牌。
-使用挂载的令牌路径,例如 `/var/run/secrets/tokens/token`,作为 SDK 工作负载身份联合提供程序的主题令牌来源。SDK 将该 GKE 令牌兑换为 OpenAI 签发的访问令牌,并使用该 OpenAI 令牌对 API 请求进行身份验证。
+请使用已挂载的令牌路径,例如 `/var/run/secrets/tokens/token`,作为 SDK 工作负载身份联合提供方的主题令牌来源。SDK 会将该 GKE 令牌交换为 OpenAI 颁发的访问令牌,并使用该 OpenAI 令牌对 API 请求进行身份验证。
-以下示例使用自定义主题令牌提供程序初始化 OpenAI 客户端。该提供程序从挂载的文件路径读取投影的 GKE 服务账号令牌,并将其用作工作负载身份联合的主题令牌。
+下面的示例演示如何使用自定义主题令牌提供方初始化 OpenAI 客户端。该提供方会从已挂载的文件路径读取已投射的 GKE 服务账号令牌,并将其用作工作负载身份联合的主题令牌。
-从 GKE 投影服务账号令牌进行身份验证
+使用 GKE 投射的服务账号令牌进行身份验证
```javascript
import { readFile } from "node:fs/promises";
@@ -963,10 +963,10 @@ puts(response.output_text)
## Google Cloud 最佳实践
-- 为每个工作负载使用专用的 Google 服务账号。避免在不同服务或环境之间共享服务账号。
-- 使用工作负载身份流程,而不是长期有效的服务账号密钥。对于可以使用元数据服务器身份令牌或 GKE Workload Identity 的工作负载,避免分发和轮换 JSON 密钥文件。
-- 将身份范围限制在最小的实际工作负载边界内。为单个应用分离服务账号可提供更清晰的审计和最小权限访问。
-- 谨慎使用基于属性的映射。尽可能优先使用服务账号主题声明等稳定标识符,而不是可变的元数据。
-- 将生产项目和非生产项目分离。不同的项目降低了意外权限共享的风险,并简化了审计。
-- 仅授予所需的 IAM 权限。将 Google 身份限制为仅授予工作负载所需的权限。
-- 监控服务账号使用情况。意外的令牌交换可能表明配置漂移或工作负载受损。
\ No newline at end of file
+- 为每个工作负载使用专用的 Google 服务账号。避免在彼此无关的服务或环境之间共用同一个服务账号。
+- 使用工作负载身份流程,避免使用长期的服务账号密钥。对于可以使用元数据服务器身份令牌或 GKE Workload Identity 的工作负载,不要分发和轮换 JSON 密钥文件。
+- 将身份范围限定为实际可行的最小工作负载边界。为各个应用使用单独的服务账号,可让审计更清晰并实现最小权限访问。
+- 谨慎使用基于属性的映射。尽可能优先选择稳定的标识符(例如服务账号的 subject 声明),而不是易变的元数据。
+- 将生产项目和非生产项目分离开来。使用不同的项目可以降低权限被意外共享的风险,并简化审计工作。
+- 仅授予必需的 IAM 权限。Google 身份仅限访问该工作负载所需的权限。
+- 监控服务账号的使用情况。出现意外的令牌交换可能表明配置发生漂移或工作负载已被攻陷。
\ No newline at end of file
diff --git a/docs/zh/api/docs/guides/workload-identity-federation/microsoft-azure.md b/docs/zh/api/docs/guides/workload-identity-federation/microsoft-azure.md
index 2c20764..13427c2 100644
--- a/docs/zh/api/docs/guides/workload-identity-federation/microsoft-azure.md
+++ b/docs/zh/api/docs/guides/workload-identity-federation/microsoft-azure.md
@@ -1,33 +1,33 @@
# 为 Microsoft Azure 配置工作负载身份联合
-> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 末尾追加 `.md` 来获取。
-在以下任一场景中,使用 Microsoft Azure 作为工作负载身份提供者:
+在以下任一场景中,将 Microsoft Azure 用作 Workload Identity 身份提供方:
-- **Azure 托管标识:** 将为托管标识签发的 Microsoft Entra ID 访问令牌兑换为短期OpenAI访问令牌。
-- **AKS:** 将投射的 Azure Kubernetes Service(AKS)服务账户令牌兑换为短期OpenAI访问令牌。
+- **Azure 托管标识:** 将为托管标识颁发的 Microsoft Entra ID 访问令牌交换为短时 OpenAI 访问令牌。
+- **AKS:** 将投射的 Azure Kubernetes Service (AKS) 服务账户令牌交换为短时 OpenAI 访问令牌。
-对于 Codex,请使用此页面获取并检查 Microsoft Entra 令牌。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 以将该令牌写入文件并让 Codex 指向它。此页面上的服务账户映射和 SDK 示例适用于 OpenAI API。
+对于 Codex,使用此页面获取并检查 Microsoft Entra 令牌。然后 [配置 Codex 工作负载身份](https://developers.openai.com/codex/enterprise/workload-identity) 将该令牌写入文件并指向 Codex。本页面上的服务帐户映射和 SDK 示例适用于 OpenAI API。
-## Azure 托管身份
+## Azure 托管标识
-Azure 托管标识让 Azure 托管的工作负载请求 Microsoft Entra 令牌,而无需存储长期机密。在 OpenAI 工作负载身份联合中,托管标识令牌是 OpenAI 在颁发 OpenAI 访问令牌之前验证的主体令牌。
+Azure 托管标识使 Azure 上托管的工作负载无需存储长期密钥即可请求 Microsoft Entra 令牌。在 OpenAI 工作负载标识联合中,托管标识令牌是 OpenAI 在签发 OpenAI 访问令牌之前验证的主体令牌。
-### 设置 Azure 托管身份
+### 设置 Azure 托管标识
-创建一个 Microsoft Entra 应用程序注册,它代表令牌受众 OpenAI 应信任的。配置其 **应用程序 ID URI**;此 URI 是 `resource` 你的工作负载从 Azure 实例元数据服务 (IMDS) 请求的值,并作为 `aud` 声明出现在颁发的令牌中。有关 Microsoft 设置步骤,请参阅 Microsoft Entra 指南以 [创建新的 Entra ID 应用程序和服务主体](https://learn.microsoft.com/en-au/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal).
+创建或使用一个 Microsoft Entra 应用程序注册,用于表示 OpenAI 应信任的令牌受众,并配置其 **Application ID URI**;此 URI 是你的工作负载从 Azure 实例元数据服务 (IMDS) 请求的 `resource` 值,并作为所颁发令牌中的 `aud` 声明出现。有关 Microsoft 配置步骤,请参阅 Microsoft Entra 关于 [创建新的 Entra ID 应用程序和服务主体](https://learn.microsoft.com/en-au/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal).
-在 Microsoft Entra ID 中配置的应用程序 ID URI、IMDS `resource`
- 参数、生成的令牌的 `aud` 声明,以及 OpenAI Workload Identity
- 提供商受众必须全部匹配。
+在 Microsoft Entra ID 中配置的 Application ID URI、IMDS `resource`
+ 参数、生成的令牌的 `aud` 声明,以及 OpenAI 工作负载身份
+ 提供程序受众必须全部匹配。
-[创建](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/manage-user-assigned-managed-identities-azure-portal?pivots=identity-mi-methods-azp) 一个托管标识,然后 [分配](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm#user-assigned-managed-identity) 该托管标识给运行你的应用程序的 Azure 资源,例如虚拟机。该资源必须在运行时能够调用 IMDS。有关 Azure 设置详细信息,请参阅 Microsoft 的 [托管标识概述](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) 以及相关 Azure 资源文档以分配该标识。
+[创建](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/manage-user-assigned-managed-identities-azure-portal?pivots=identity-mi-methods-azp) 一个托管标识,然后 [将该](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm#user-assigned-managed-identity) 托管标识分配给运行你的应用程序的 Azure 资源,例如虚拟机。该资源必须能够在运行时调用 IMDS。有关 Azure 配置详细信息,请参阅 Microsoft 的 [托管标识概述](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) 以及有关分配标识的相关 Azure 资源文档。
### 获取 Azure 托管标识令牌
-从分配了托管身份的 Azure 资源中,以应用程序 ID URI 作为 `resource` 参数向 IMDS 请求令牌。此令牌是 OpenAI 用来交换 OpenAI 签发的访问令牌的主体令牌。
+从已分配托管标识的 Azure 资源,使用 Application ID URI 作为参数向 IMDS 请求令牌。 `resource` 该令牌是 OpenAI 用来换取 OpenAI 颁发的访问令牌的 subject token。
```bash
APPLICATION_ID_URI="api://"
@@ -40,11 +40,11 @@ TOKEN=$(curl -sS -G -H "Metadata: true" \
export TOKEN
```
-如果资源具有多个用户分配的托管身份,请添加 `client_id`, `object_id`,或 `msi_res_id` 用于指定要使用的托管身份的查询参数。Microsoft 在以下文档中说明了 IMDS 令牌请求参数: [使用虚拟机上的托管身份获取访问令牌](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/how-to-use-vm-token).
+如果资源有多个用户分配的托管标识,请添加 `client_id`, `object_id`,或 `msi_res_id` 查询参数来指定要使用的托管标识。Microsoft 在以下文档中说明了 IMDS 令牌请求参数: [使用虚拟机上的托管标识获取访问令牌](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/how-to-use-vm-token).
### 验证令牌
-在配置工作负载身份联合之前,请导出 Microsoft Entra 令牌为 `TOKEN`,然后在本地运行此脚本以检查其声明:
+在配置工作负载身份联合之前,将 Microsoft Entra 令牌导出为 `TOKEN`,然后在本地运行以下脚本以检查其声明:
```python
import base64
@@ -57,9 +57,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 负载而不验证令牌签名。对于生产令牌,请使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
+该命令会解码 JWT 负载,但不验证令牌签名。对于生产令牌,请使用本地解码器,避免将生产令牌粘贴到第三方工具中。
-解码后的 Microsoft Entra ID 托管身份令牌将类似于:
+解码后的 Microsoft Entra ID 托管标识令牌的格式类似如下:
```json
{
@@ -75,61 +75,61 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-验证你计划在 OpenAI 中配置的声明:
-
-- `iss`:使用令牌中准确的颁发者值。颁发者可能为 `https://login.microsoftonline.com//v2.0`,但不要假定该后缀。
-- `aud`:必须与应用程序 ID URI、IMDS `resource` 参数以及 OpenAI 工作负载身份提供方受众匹配。
-- `tid`:Microsoft Entra 租户 ID。
-- `appid`:托管标识的应用/客户端 ID(如果存在)。
-- `iat` 以及 `exp`:检查令牌的完整生命周期, `exp - iat`,以秒为单位。
-
-对于 Codex,请将提供商的 `max_assertion_lifetime_seconds` 设置为一个已获批准的
-限制值,该限制值应覆盖签发方预期的令牌生存时间范围。请勿使用
-令牌的剩余有效期,也不要假设每个 Entra 令牌的持续时间都是一小时。
-Microsoft 记录了 [可变量的访问令牌
-生存时间](https://learn.microsoft.com/en-us/entra/identity-platform/access-tokens#token-lifetime)
-并且不支持 [配置托管身份令牌
-生存时间](https://learn.microsoft.com/en-us/entra/identity-platform/configurable-token-lifetimes).
-请参阅 [管理员 API 提供商
+请在 OpenAI 中核实你计划配置的声明:
+
+- `iss`: 使用令牌中的精确 issuer 值。该 issuer 可能为 `https://login.microsoftonline.com//v2.0`,但不要假定该后缀。
+- `aud`: 必须与 Application ID URI、IMDS `resource` 参数以及 OpenAI Workload Identity Provider 受众(audience)匹配。
+- `tid`: Microsoft Entra 租户 ID。
+- `appid`: 托管标识的应用程序/客户端 ID(如果存在)。
+- `iat` 和 `exp`: 检查令牌的完整生命周期, `exp - iat`(以秒为单位)。
+
+对于 Codex,将提供方的 `max_assertion_lifetime_seconds` 设置为已批准的
+限制,使其覆盖颁发方预期的令牌生命周期范围。不要使用
+令牌的剩余有效期,也不要假设每个 Entra 令牌都持续一小时。
+Microsoft 文档 [可变访问令牌
+生存期](https://learn.microsoft.com/en-us/entra/identity-platform/access-tokens#token-lifetime)
+并且不支持 [配置托管标识令牌
+生存期](https://learn.microsoft.com/en-us/entra/identity-platform/configurable-token-lifetimes).
+请参阅 [Admin API 提供商
示例](https://developers.openai.com/api/docs/guides/workload-identity-federation/admin-api#create-an-oidc-provider).
-托管身份令牌还可能包含以下声明: `azp`, `oid`, `sub`,或 `xms_mirid`。请将解码后的令牌视为事实来源,并选择能够准确标识你信任的托管身份和资源边界的声明。
+托管标识令牌还可能包含诸如 `azp`, `oid`, `sub`,或 `xms_mirid`。之类的声明。请将解码后的令牌作为真实来源,并选择那些能够精确标识你信任的托管标识和资源边界的声明。
-使用解码后的负载,将你收到的令牌与 OpenAI 中配置的签发方、受众和映射值进行比较。大多数配置问题都可在 `iss`, `aud`, `tid`,以及交换令牌之前的托管身份声明中看到。
+请使用解码后的载荷,将你收到的令牌与 OpenAI 中配置的颁发者、受众和映射值进行比较。大多数配置问题都会在交换令牌前的 `iss`, `aud`, `tid`,以及托管标识声明中显现出来。
### 设置工作负载身份联合
-为 Microsoft Entra ID 颁发者在 OpenAI 中创建工作负载身份提供程序,然后添加与托管身份令牌中的稳定声明匹配的服务账户映射。
+在 OpenAI 中为 Microsoft Entra ID 颁发者创建一个工作负载身份提供方,然后添加一个服务账户映射,使其匹配托管身份令牌中的稳定声明。
-先配置工作负载身份提供程序,再创建服务账户映射。
+请先配置工作负载身份提供方,再创建服务账户映射。
#### 设置 Workload Identity Provider
-1. **创建工作负载身份提供程序。** 将 **名称** 设置为唯一值,例如 `azure-managed-identity-prod`。使用 **描述**,例如 `Production Azure managed identity workloads`,以帮助管理员识别提供程序。
+1. **创建工作负载身份提供程序。** 设置 **名称** 为唯一值,例如 `azure-managed-identity-prod`。使用 **描述**,例如 `Production Azure managed identity workloads`,以帮助管理员识别该提供程序。
-2. **设置颁发者和受众。** 将 **OIDC 颁发者 URL** 设置为令牌的精确值 `iss` 声明。首先获取一个示例托管身份令牌并检查其声明。例如,颁发者可能是 `https://login.microsoftonline.com//v2.0`。将 **受众** 设置为你配置的 Microsoft Entra 应用程序 ID URI,例如 `api://`。此值必须与令牌的 `aud` 声明匹配。
+2. **设置颁发者和受众。** 设置 **OIDC 颁发者 URL** 为令牌中 `iss` 声明的精确值。首先获取一个托管身份令牌样本并检查其声明。例如,颁发者可能是 `https://login.microsoftonline.com//v2.0`。设置 **受众** 为你配置的 Microsoft Entra 应用程序 ID URI,例如 `api://`。该值必须与令牌的 `aud` 声明匹配。
-3. **使用 Microsoft Entra 令牌验证。** 保留 **使用上传的 JWKS 进行令牌验证** 禁用时。OpenAI 使用 Microsoft Entra 颁发者元数据和 JWKS 来验证托管身份令牌。
+3. **使用 Microsoft Entra 令牌验证。** 将 **使用上传的 JWKS 进行令牌验证** 已禁用。OpenAI 使用 Microsoft Entra 发行者元数据和 JWKS 验证托管标识令牌。
-4. **如果需要派生的映射属性,请添加属性转换。** 例如,输入 `managed_identity_client_id` 并使用表达式 `assertion.appid` 以从托管身份应用程序/客户端 ID 声明创建 `openai.managed_identity_client_id` 。仪表板会自动应用 `openai.` 前缀。已经以 `openai.` 开头的原始令牌声明将被忽略,不用于 `openai.` 映射键,除非配置了匹配的转换。
+4. **如果需要派生映射属性,请添加属性转换。** 例如,输入 `managed_identity_client_id` 以及表达式 `assertion.appid` 以创建 `openai.managed_identity_client_id` ,取值自托管标识应用程序/客户端 ID 声明。控制面板会自动应用 `openai.` 此前缀。已以 `openai.` 开头的原始令牌声明不会用于 `openai.` 映射键,除非配置了匹配的转换。
-#### 设置服务账户映射
+#### 设置服务账号映射
-1. **创建服务账号映射。** 将 **Name** 设置为在该 Workload Identity Provider 内唯一的值,例如 `vm-openai-wif`。使用 **Description**(例如 `Production VM Azure managed identity workload`)来说明哪些工作负载可以使用该映射。
+1. **创建服务帐户映射。** 设置 **名称** 设置为一个在该 Workload Identity Provider 中唯一的值,例如 `vm-openai-wif`。使用 **描述**,例如 `Production VM Azure managed identity workload`,以说明哪个工作负载可以使用该映射。
-2. **匹配稳定的托管身份声明。** 为每个必须匹配的声明添加一行 **Key** 和 **Value** 。如果令牌包含 `appid`,则将 **Key** 设为 `appid` ,并将 **Value** 设为托管身份客户端 ID。该 `appid` claim 识别托管标识的应用/客户端 ID,通常是将映射绑定到特定托管标识时最稳定的 claim。如果你的令牌不包含 `appid`,请使用解码令牌中的另一个稳定 claim,例如 `azp`, `oid`, `sub`,或 `xms_mirid`。要将映射绑定到单个租户,还需将 **Key** 设置为 `tid` 并将 **Value** 设置为 Microsoft Entra 租户 ID。从 IMDS 解码示例令牌,并使用对你信任的托管标识和资源稳定的 claim。
+2. **匹配稳定的托管标识声明。** 为每个必须匹配的声明添加一个 **键** 和 **值** 行。如果令牌包含 `appid`,则设置 **键** 为 `appid` 和 **值** 为托管标识客户端 ID。该 `appid` 声明用于标识托管标识的应用程序/客户端 ID,通常是将映射绑定到特定托管标识时最稳定的声明。如果你的令牌不包含 `appid`,则使用解码令牌中的其他稳定声明,例如 `azp`, `oid`, `sub`,或 `xms_mirid`。要将映射绑定到一个租户,还需设置 **键** 为 `tid` 和 **值** 为 Microsoft Entra 租户 ID。对来自 IMDS 的示例令牌进行解码,并使用对于你所信任的托管标识和资源而言稳定的声明。
-3. **选择 OpenAI 目标。** 将 **Project** 设置为拥有目标服务账户的 OpenAI 项目。将 **Service account** 设置为 Azure 工作负载可使用的 OpenAI 服务账户,例如 `azure-managed-identity-prod-openai-wif`.
+3. **选择 OpenAI 目标。** 设置 **项目** 为拥有目标服务帐户的 OpenAI 项目。设置 **服务帐户** 授予 Azure 工作负载可以使用的 OpenAI 服务帐户的相应权限,例如 `azure-managed-identity-prod-openai-wif`.
-4. **根据需要缩小 API 权限范围。** 选择适当的 **Permissions** ,例如 `api.model.request` 和 `api.vector_store.read` 以进一步收窄从此映射铸造的访问令牌。将权限留空可避免添加 WIF 特定的作用域限制;该令牌仍将以映射的服务账号身份进行授权。
+4. **根据需要收窄 API 权限。** 选择适当的 **权限** ,例如 `api.model.request` 和 `api.vector_store.read` 以进一步收窄从此映射生成的访问令牌的权限范围。如果将权限留空,则不会添加特定于 WIF 的范围限制;该令牌仍会以映射的服务帐户身份进行授权。
### 在代码中使用令牌
-配置你的 OpenAI SDK 客户端,从 IMDS 请求 Azure 托管身份令牌,并将其交换为 OpenAI 颁发的访问令牌。
+配置你的 OpenAI SDK 客户端,以从 IMDS 请求 Azure 托管身份令牌,并将该令牌交换为由 OpenAI 签发的访问令牌。
-将 `OPENAI_WIF_AUDIENCE` 设置为配置为工作负载身份提供方受众的 Microsoft Entra 应用程序 ID URI。SDK 为该受众请求托管身份令牌,将其交换为 OpenAI 颁发的访问令牌,并使用 OpenAI 令牌对 API 请求进行身份验证。
+将 `OPENAI_WIF_AUDIENCE` 设置为配置为工作负载身份提供程序受众的 Microsoft Entra 应用程序 ID URI。SDK 会为该受众请求托管身份令牌,将其交换为由 OpenAI 签发的访问令牌,并使用 OpenAI 令牌对 API 请求进行身份验证。
-从 Azure 托管身份令牌进行身份验证
+使用 Azure 托管身份令牌进行身份验证
```javascript
import OpenAI from "openai";
@@ -565,19 +565,19 @@ puts(response.output_text)
## Azure Kubernetes Service (AKS)
-通过将 OpenAI 访问令牌换出 AKS 签发的投射服务账户令牌,将 AKS 用作工作负载身份提供程序。
+使用 AKS 作为工作负载身份提供方,通过将 AKS 颁发的投影服务账户令牌交换为短时效的 OpenAI 访问令牌。
-AKS 工作负载还可以使用 Azure 工作负载身份来获取附加到工作负载的托管身份的 Microsoft Entra
- ID 访问令牌。在该
- 配置中,OpenAI 验证的是 Microsoft Entra 令牌,而非
- 投射的 Kubernetes 服务账户令牌。按照以下步骤配置 OpenAI 工作负载身份
- 联合,然后根据 [Azure 托管
- 身份](#azure-managed-identity),文档中的步骤配置 Azure 工作负载身份,
- 并遵循 Microsoft 的文档。
+AKS 工作负载也可以使用 Azure 工作负载身份来获取附加到该工作负载的托管身份的 Microsoft Entra
+ ID 访问令牌。在这种
+ 配置下,OpenAI 会校验 Microsoft Entra 令牌,而不是
+ 投影的 Kubernetes 服务账户令牌。按照以下步骤配置 OpenAI 工作负载身份
+ 联合: [Azure 托管
+ 身份](#azure-managed-identity),并根据 Microsoft 的文档配置 Azure 工作负载身份。
+ according to Microsoft's documentation.
### 设置 AKS
-检索与 AKS 集群关联的 OIDC issuer URL:
+检索与 AKS 集群关联的 OIDC 颁发者 URL:
```bash
az aks show \
@@ -587,7 +587,7 @@ az aks show \
--output tsv
```
-如果 issuer URL 为空,请为集群启用 AKS OIDC issuer。使用以下命令:
+如果颁发者 URL 为空,请为该集群启用 AKS OIDC 颁发者。使用以下命令:
```bash
az aks update \
@@ -596,15 +596,15 @@ az aks update \
--enable-oidc-issuer
```
-你在 OpenAI 工作负载身份提供程序中配置的 issuer 必须与此 issuer URL 以及 `iss` 投影的 AKS 服务账户令牌中的 claim 匹配。
+你在 OpenAI Workload Identity Provider 中配置的颁发者必须与此颁发者 URL 和 `iss` 投射的 AKS 服务账号令牌中的 claim 相匹配。
-使用 Kubernetes `ServiceAccount` 来处理需要调用 OpenAI API 的 AKS 工作负载。如果你还没有,请创建一个:
+使用 Kubernetes `ServiceAccount` 为需要调用 OpenAI API 的 AKS 工作负载创建相应的资源。如果你还没有,请创建一个:
```bash
kubectl create serviceaccount openai-wif --namespace default
```
-使用 OpenAI 期望的 audience 和适合你的工作负载的过期时间配置投影的服务账户令牌。OpenAI 会验证令牌的 issuer、签名、audience 和过期时间。在此示例中,令牌文件挂载在 `/var/run/secrets/tokens/token`,使用 audience `https://api.openai.com/v1`,并在 3600 秒后过期。如果投影令牌 audience 与 OpenAI 工作负载身份提供程序的 audience 匹配,你可以使用不同的 audience。
+将投射的服务账号令牌配置为使用 OpenAI 所需的 audience 以及适合你工作负载的过期时间。OpenAI 会校验令牌的颁发者、签名、audience 和过期时间。在本示例中,令牌文件挂载于 `/var/run/secrets/tokens/token`,使用的 audience 为 `https://api.openai.com/v1`,并在 3600 秒后过期。如果投射令牌的 audience 与 OpenAI Workload Identity Provider 的 audience 匹配,你也可以使用其他 audience。
```yaml
apiVersion: v1
@@ -633,7 +633,7 @@ spec:
### 验证令牌
-在配置工作负载身份联合之前,先在本地解码一个示例投影服务账户令牌并检查其声明。从挂载了投影令牌的运行中 Pod 中检索该令牌,并将其导出为 `TOKEN`:
+在配置工作负载身份联邦之前,请在本地解码一个示例投射服务账号令牌并检查其 claim。在运行中的 Pod 中(已挂载投射令牌),获取该令牌并将其导出为 `TOKEN`:
```bash
TOKEN=$(kubectl exec -n default openai-wif-app -- cat /var/run/secrets/tokens/token)
@@ -653,9 +653,9 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
```
-此命令解码 JWT 负载,但不验证令牌签名。对生产令牌使用本地解码器,并避免将生产令牌粘贴到第三方工具中。
+该命令会解码 JWT 负载,但不验证令牌签名。对于生产令牌,请使用本地解码器,避免将生产令牌粘贴到第三方工具中。
-解码后的 AKS 投影服务账户令牌将类似于:
+一个解码后的 AKS 投射服务账号令牌将类似于:
```json
{
@@ -674,51 +674,51 @@ print(json.dumps(json.loads(base64.urlsafe_b64decode(payload)), indent=2))
}
```
-验证你计划在 OpenAI 中配置的声明:
+请在 OpenAI 中核实你计划配置的声明:
-- `iss`:必须匹配在 OpenAI 工作负载身份提供程序中配置的 AKS 签发者 URL。
-- `aud`:必须匹配投影的服务账户令牌受众以及 OpenAI 工作负载身份提供程序的受众。
-- `sub`:必须匹配你在服务账户映射中配置的 Kubernetes 服务账户主体。
+- `iss`: 必须与 OpenAI Workload Identity Provider 中配置的 AKS 颁发者 URL 匹配。
+- `aud`: 必须与投射的服务账户令牌受众以及 OpenAI Workload Identity Provider 的受众匹配。
+- `sub`: 必须与你在服务账户映射中配置的 Kubernetes 服务账户主体匹配。
-使用解码后的载荷,将你收到的令牌与 OpenAI 中配置的签发者、受众和映射值进行比较。大多数配置问题都可以在 `iss`, `aud`,以及 `sub` 声明中看到,然后你再交换令牌。
+请使用解码后的载荷,将你收到的令牌与 OpenAI 中配置的颁发者、受众和映射值进行比较。大多数配置问题都会在交换令牌前的 `iss`, `aud`,并且 `sub` 在交换令牌之前先检查这些声明。
### 设置工作负载身份联合
-为 AKS 签发者在 OpenAI 中创建工作负载身份提供程序,然后添加一个服务账户映射,以匹配投影令牌中的属性。
+在 OpenAI 中为 AKS 颁发者创建一个 Workload Identity Provider,然后添加一个服务账号映射,使其与投影令牌中的属性相匹配。
-先配置工作负载身份提供程序,然后创建服务账户映射。
+请先配置工作负载身份提供方,再创建服务账户映射。
-#### 设置工作负载身份提供方
+#### 设置 Workload Identity Provider
-1. **创建工作负载身份提供程序。** 将 **名称** 设置为唯一值,例如 `azure-aks-prod`。使用 **描述**,例如 `Production AKS cluster`,以帮助管理员识别集群。
+1. **创建工作负载身份提供程序。** 设置 **名称** 为唯一值,例如 `azure-aks-prod`。使用 **描述**,例如 `Production AKS cluster`,以帮助管理员识别集群。
-2. **设置颁发者和受众。** 将 **OIDC 颁发者 URL** 设置为 `az aks show --query "oidcIssuerProfile.issuerUrl"`。返回的颁发者。此值必须与 `iss` 中的 **受众** 设置为与投影的服务账户令牌卷上配置的相同受众。在此示例中,该值为 `https://api.openai.com/v1`.
+2. **设置颁发者和受众。** 设置 **OIDC 颁发者 URL** 设置为由 `az aks show --query "oidcIssuerProfile.issuerUrl"`。返回的 issuer。该值必须与 `iss` claim 在投射的 AKS 服务账号令牌中匹配。将 **受众** 设置为与投射的服务账号令牌卷上配置的 audience 相同。在本示例中,该值为 `https://api.openai.com/v1`.
-3. **使用 AKS OIDC 发现。** 保持 **使用上传的 JWKS 进行令牌验证** OpenAI 使用 AKS 颁发者的 OIDC 发现元数据和 JWKS 来验证投影的服务账户令牌。
+3. **使用 AKS OIDC 发现。** 将 **使用上传的 JWKS 进行令牌验证** 已禁用。OpenAI 使用 AKS issuer 的 OIDC 发现元数据和 JWKS 来验证投射的服务账号令牌。
-4. **如果需要派生的映射属性,请添加属性变换。** 例如,输入 `aks_subject` 并使用表达式 `assertion.sub` 来创建 `openai.aks_subject`。仪表板会自动应用 `openai.` 前缀。已经以 `openai.` 开头的原始令牌声明在 `openai.` 映射键时将被忽略,除非配置了匹配的变换。
+4. **如果需要派生映射属性,请添加属性转换。** 例如,输入 `aks_subject` 以及表达式 `assertion.sub` 以创建 `openai.aks_subject`。该仪表板会应用 `openai.` 此前缀。已以 `openai.` 开头的原始令牌声明不会用于 `openai.` 映射键,除非配置了匹配的转换。
#### 设置服务账号映射
-1. **创建服务账号映射。** 将 **Name** 设置为该 Workload Identity Provider 内唯一的值,例如 `default-openai-wif`。使用 **Description**,例如 `Default namespace AKS OpenAI API workload`,来说明哪些工作负载可以使用该映射。
+1. **创建服务帐户映射。** 设置 **名称** 设置为一个在该 Workload Identity Provider 中唯一的值,例如 `default-openai-wif`。使用 **描述**,例如 `Default namespace AKS OpenAI API workload`,以说明哪个工作负载可以使用该映射。
-2. **匹配 AKS 服务账号主题。** 将 **Key** 设置为 `sub` ,并将 **Value** 设置为 `system:serviceaccount:default:openai-wif`。对于 AKS 服务账号,主题格式为 `system:serviceaccount::`.
+2. **匹配 AKS 服务账号主体。** 设置 **键** 为 `sub` 和 **值** 为 `system:serviceaccount:default:openai-wif`。对于 AKS 服务账号,subject 格式为 `system:serviceaccount::`.
- Workload Identity Provider 将令牌限制为配置的 AKS 签发者。服务账号映射进一步将访问限制为指定的 Kubernetes 服务账号主题。
+ Workload Identity Provider 将令牌限制在配置的 AKS issuer 上。服务账号映射进一步将访问限制到指定的 Kubernetes 服务账号主体。
-3. **选择 OpenAI 目标。** 将 **Project** 到拥有目标服务账户的 OpenAI 项目。设置 **Service account** 为 AKS 工作负载可使用的 OpenAI 服务账户,例如 `azure-aks-prod-openai-wif`.
+3. **选择 OpenAI 目标。** 设置 **项目** 为拥有目标服务帐户的 OpenAI 项目。设置 **服务帐户** 设置为 OpenAI 服务账号,AKS 工作负载可以使用该服务账号,例如 `azure-aks-prod-openai-wif`.
-4. **如有需要,缩小 API 权限范围。** 选择合适的 **Permissions** ,例如 `api.model.request` 和 `api.vector_store.read` ,以进一步缩小从此映射生成的访问令牌。将权限留空可避免添加 WIF 特定的范围限制;令牌仍会以映射的服务账户身份授权。
+4. **根据需要收窄 API 权限。** 选择适当的 **权限** ,例如 `api.model.request` 和 `api.vector_store.read` 以进一步收窄从此映射生成的访问令牌的权限范围。如果将权限留空,则不会添加特定于 WIF 的范围限制;该令牌仍会以映射的服务帐户身份进行授权。
### 在代码中使用令牌
-配置你的 OpenAI SDK 客户端,以读取投影的 AKS 服务账户令牌,并将其交换为 OpenAI 签发的访问令牌。
+配置你的 OpenAI SDK 客户端,以读取投影的 AKS 服务账户令牌,并将其交换为由 OpenAI 签发的访问令牌。
-使用挂载的令牌路径,例如 `/var/run/secrets/tokens/token`,作为 SDK 工作负载身份联合提供程序的主题令牌源。SDK 将该 AKS 令牌交换为 OpenAI 签发的访问令牌,并使用 OpenAI 令牌来认证 API 请求。
+使用挂载的令牌路径,例如 `/var/run/secrets/tokens/token`,作为 SDK 工作负载身份联合提供程序的主体令牌来源。SDK 会将该 AKS 令牌交换为由 OpenAI 签发的访问令牌,并使用该 OpenAI 令牌对 API 请求进行身份验证。
-以下示例使用自定义主题令牌提供程序初始化 OpenAI 客户端。该提供程序从挂载的文件路径读取投影的 AKS 服务账户令牌,并将其用作工作负载身份联合的主题令牌。
+以下示例使用自定义主体令牌提供程序初始化 OpenAI 客户端。提供程序会从挂载的文件路径读取投影的 AKS 服务账户令牌,并将其用作工作负载身份联合的主体令牌。
-从 AKS 投影的服务账户令牌进行认证
+使用 AKS 投影的服务账户令牌进行身份验证
```javascript
import { readFile } from "node:fs/promises";
@@ -1008,10 +1008,10 @@ puts(response.output_text)
## Microsoft Azure 最佳实践
-- 尽可能使用托管身份。托管身份比手动分发凭据提供更简单、更安全的身份验证模型。
-- 为不同的应用程序和环境使用单独的托管身份、Microsoft Entra 应用程序和OpenAI映射。避免在开发、预发布和生产工作负载之间共享一个身份。
-- 限制接受的受众。仅配置OpenAI工作负载身份联合所需的受众。
-- 使用专用的 Microsoft Entra ID 应用程序来界定安全边界。独立的应用程序提供更清晰的归属、审计和访问管理。
-- 优先使用特定于工作负载的映射。匹配工作负载特定的声明,而不是广泛的租户级属性。
-- 定期审查联合凭据配置。过时的联合凭据可能在工作负载停用后继续无意中授予访问权限。
-- 分离生产和非生产身份。生产工作负载应通过不同的联合身份和OpenAI服务账户进行身份验证。
\ No newline at end of file
+- 尽可能使用托管标识。托管标识提供了一种比手动分发凭据更简单、更安全的身份验证模型。
+- 为不同的应用和环境使用单独的托管标识、Microsoft Entra 应用以及 OpenAI 映射。避免在开发、预发布和生产工作负载之间共享同一个标识。
+- 限制接受的受众。仅配置 OpenAI 工作负载标识联合身份验证所需的受众。
+- 使用专用的 Microsoft Entra ID 应用来划分安全边界。独立的应用能够提供更清晰的所有权、审计和访问管理。
+- 优先采用针对工作负载的映射。基于工作负载特定的声明进行匹配,而不是使用宽泛的全租户属性。
+- 定期审查联合凭据配置。过期的联合凭据可能在工作负载下线后很长时间内仍无意中继续授予访问权限。
+- 将生产环境与非生产环境的标识分开。生产工作负载应通过不同的联合标识和 OpenAI 服务帐户进行身份验证。
\ No newline at end of file
diff --git a/docs/zh/api/reference/resources/audio.md b/docs/zh/api/reference/resources/audio.md
index e3c6788..f9f351b 100644
--- a/docs/zh/api/reference/resources/audio.md
+++ b/docs/zh/api/reference/resources/audio.md
@@ -1,6 +1,6 @@
-# 音频
+# Audio
-> 有关完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 完整的文档索引请参见 [llms.txt](/llms.txt). 可通过在页面 URL 末尾追加 `.md` 获取文档页面的 Markdown 版本。
## 域类型
@@ -24,7 +24,7 @@
- `AudioResponseFormat = "json" or "text" or "srt" or 3 more`
- 输出的格式,可选以下选项之一: `json`, `text`, `srt`, `verbose_json`, `vtt`,或 `diarized_json`。对于 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe`,唯一支持的格式是 `json`。对于 `gpt-4o-transcribe-diarize`,支持的格式有 `json`, `text`,和 `diarized_json`,其中 `diarized_json` 是接收说话者注解所必需的。
+ 输出格式,可选以下选项之一: `json`, `text`, `srt`, `verbose_json`, `vtt`,或 `diarized_json`。对于 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe`,唯一支持的格式是 `json`。对于 `gpt-4o-transcribe-diarize`,支持的格式有 `json`, `text`,以及 `diarized_json`,使用 `diarized_json` 以便获取说话人标注。
- `"json"`
@@ -38,9 +38,9 @@
- `"diarized_json"`
-# 语音
+# Speech
-## 创建语音
+## Create speech
**post** `/audio/speech`
@@ -56,7 +56,7 @@
- `model: string or SpeechModel`
- 可用的 [TTS 模型](/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`,之一,或 `gpt-4o-mini-tts-2025-12-15`.
+ 可用的 [TTS 模型](/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`,或 `gpt-4o-mini-tts-2025-12-15`.
- `string`
@@ -72,7 +72,7 @@
- `voice: string or "alloy" or "ash" or "ballad" or 7 more or object { id }`
- 生成音频时使用的语音。支持的内置语音有 `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`,以及 `cedar`。你还可以提供一个带有 `id`,的自定义语音对象,例如 `{ "id": "voice_1234" }`。语音预览可在 [文本转语音指南](/docs/guides/text-to-speech#voice-options).
+ 生成音频时使用的语音。支持的内置语音包括 `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`,以及 `cedar`。你也可以提供一个带有 `id`,的自定义语音对象,例如 `{ "id": "voice_1234" }`。这些语音的预览可在 [Text to speech 指南](/docs/guides/text-to-speech#voice-options).
- `string`
@@ -108,11 +108,11 @@
- `instructions: optional string`
- 通过附加指令控制生成音频的声音。不适用于 `tts-1` 或 `tts-1-hd`.
+ 通过附加指令控制生成音频的语音。不适用于 `tts-1` 或 `tts-1-hd`.
- `response_format: optional "mp3" or "opus" or "aac" or 3 more`
- 音频的格式。支持的格式有 `mp3`, `opus`, `aac`, `flac`, `wav`,以及 `pcm`.
+ 音频的格式。支持的格式包括 `mp3`, `opus`, `aac`, `flac`, `wav`,以及 `pcm`.
- `"mp3"`
@@ -128,11 +128,11 @@
- `speed: optional number`
- 生成音频的速度。从 `0.25` 到 `4.0`. `1.0` 中选择一个值,默认值为。
+ 生成音频的速度。选择介于 `0.25` 到 `4.0`. `1.0` 之间的值,默认值为。
- `stream_format: optional "sse" or "audio"`
- 流式传输音频的格式。支持的格式有 `sse` 以及 `audio`. `sse` 不支持 `tts-1` 或 `tts-1-hd`.
+ 流式传输音频的格式。支持的格式包括 `sse` 和 `audio`. `sse` 不支持 `tts-1` 或 `tts-1-hd`.
- `"sse"`
@@ -179,7 +179,7 @@ curl https://api.openai.com/v1/audio/speech \
}'
```
-## 领域类型
+## 域类型
### 语音模型
@@ -199,160 +199,160 @@ curl https://api.openai.com/v1/audio/speech \
**post** `/audio/transcriptions`
-将音频转录为输入语言。
+将音频转写为输入语言。
-返回转录对象,格式为 `json`, `diarized_json`,或 `verbose_json`
-格式,或转录事件流。
+以 `json`, `diarized_json`,格式返回一个转写对象,或 `verbose_json`
+格式返回转写事件流。
-### 返回
+### Returns
- `Transcription object { text, languages, logprobs, usage }`
- 表示模型根据提供的输入返回的转录响应。
+ 表示模型根据所提供的输入返回的转录响应。
- `text: string`
- 转录的文本。
+ 转录后的文本。
- `languages: optional array of TranscriptionLanguage`
- 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示无法可靠检测到任何语言。
+ 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠地检测出任何语言。
- `code: string`
- 音频中检测到的语言的代码。
+ 音频中检测到的语言代码。
- `logprobs: optional array of object { token, bytes, logprob }`
- 转录中标记的对数概率。仅在使用模型 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 时返回,如果 `logprobs` 被添加到 `include` 数组中。
+ 转录中各 token 的对数概率。仅在使用以下模型时返回 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 如果 `logprobs` 已添加到 `include` 数组中。
- `token: optional string`
- 转录中的标记。
+ 转录中的 token。
- `bytes: optional array of number`
- 标记的字节。
+ 该 token 的字节。
- `logprob: optional number`
- 标记的对数概率。
+ 该 token 的对数概率。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的标记使用统计。
+ 本次请求的 token 使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按标记使用计费的模型的用量统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 此请求计费的输入标记数。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出标记数。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的标记总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- 用量对象的类型。对于此变体,始终为 `tokens` 。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 本次请求计费的输入令牌详情。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 本次请求计费的音频令牌数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 本次请求计费的文本令牌数量。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
- 输入音频的时长(秒)。
+ 输入音频的时长(以秒为单位)。
- `type: "duration"`
- 使用情况对象的类型。始终为 `duration` 此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `TranscriptionDiarized object { duration, segments, task, 2 more }`
- 表示模型返回的带说话人分离的转录响应,包括合并的转录文本和说话人分段注释。
+ 表示模型返回的说话人分离转写响应,包含合并后的转写文本和说话人分段标注。
- `duration: number`
- 输入音频的时长(秒)。
+ 输入音频的时长(以秒为单位)。
- `segments: array of TranscriptionDiarizedSegment`
- 带有时间戳和说话人标签的转录文本分段。
+ 带有时间戳和说话人标签的转写分段。
- `id: string`
- 分段的唯一标识符。
+ 该分段唯一标识符。
- `end: number`
- 分段的结束时间戳(秒)。
+ 分段的结束时间戳(以秒为单位)。
- `speaker: string`
- 此分段的说话人标签。当提供了已知说话人时,标签匹配 `known_speaker_names[]`。否则,使用大写字母按顺序标记说话人(`A`, `B`, ...).
+ 该分段的说话人标签。当提供了已知说话人时,标签匹配 `known_speaker_names[]`。否则,说话人将按顺序使用大写字母(`A`, `B`, ...).
- `start: number`
- 分段的开始时间戳(秒)。
+ 分段的起始时间戳(以秒为单位)。
- `text: string`
- 此分段的转录文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
- 分段的类型。始终为 `transcript.text.segment`.
+ 分段的类型,固定为 `transcript.text.segment`.
- `"transcript.text.segment"`
- `task: "transcribe"`
- 运行的任务类型。始终为 `transcribe`.
+ 所运行任务的类型,固定为 `transcribe`.
- `"transcribe"`
- `text: string`
- 整个音频输入的合并转录文本。
+ 整个音频输入的拼接转写文本。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的令牌或时长使用统计。
+ 本次请求的 token 或时长使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按 token 用量计费的模型的使用统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 本次请求计费的输入 token 数量。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出 token 数量。
+ 生成的输出 token 数。
- `total_tokens: number`
@@ -360,13 +360,13 @@ curl https://api.openai.com/v1/audio/speech \
- `type: "tokens"`
- usage 对象的类型。此变体始终为 `tokens` 。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 本次请求计费的输入 token 的详细信息。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
@@ -378,21 +378,21 @@ curl https://api.openai.com/v1/audio/speech \
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
- 输入音频的时长(秒)。
+ 输入音频的时长(以秒为单位)。
- `type: "duration"`
- usage 对象的类型。此变体始终为 `duration` 。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `TranscriptionVerbose object { duration, language, text, 3 more }`
- 表示模型根据提供的输入返回的详细 json 转录响应。
+ 表示模型根据提供的输入返回的详细 JSON 转写响应。
- `duration: number`
@@ -408,77 +408,77 @@ curl https://api.openai.com/v1/audio/speech \
- `segments: optional array of TranscriptionSegment`
- 转录文本的片段及其相应详细信息。
+ 转写文本的分段及其对应的详细信息。
- `id: number`
- 片段的唯一标识符。
+ 该片段的唯一标识符。
- `avg_logprob: number`
- 片段的平均 logprob。如果该值低于 -1,则认为 logprobs 失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 段落的压缩比。如果该值大于 2.4,则认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 段落的结束时间,以秒为单位。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 段落中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,则认为该段落为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 段落的搜索偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 段落的开始时间,以秒为单位。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成该段落的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
- 段落的文本内容。
+ 该片段的文本内容。
- `tokens: array of number`
- 文本内容的 token ID 数组。
+ 文本内容对应的 token ID 数组。
- `usage: optional object { seconds, type }`
- 按音频输入时长计费的模型的使用情况统计。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
- 输入音频的时长,以秒为单位。
+ 输入音频的时长(以秒为单位)。
- `type: "duration"`
- 使用情况对象的类型。对于此变体,始终为 `duration` 。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `words: optional array of TranscriptionWord`
- 提取的单词及其对应的时间戳。
+ 提取出的词语及其对应的时间戳。
- `end: number`
- 单词的结束时间,以秒为单位。
+ 该词语的结束时间(以秒为单位)。
- `start: number`
- 单词的开始时间,以秒为单位。
+ 该词语的开始时间(以秒为单位)。
- `word: string`
- 单词的文本内容。
+ 该词语的文本内容。
### 示例
@@ -490,7 +490,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F model=gpt-4o-transcribe
```
-#### 响应
+#### Response
```json
{
@@ -532,7 +532,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F model="gpt-4o-transcribe"
```
-#### 响应
+#### Response
```json
{
@@ -550,7 +550,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
}
```
-### 说话人分离
+### Diarization
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -564,7 +564,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F 'known_speaker_references[]=data:audio/wav;base64,AAA...'
```
-#### 响应
+#### Response
```json
{
@@ -604,7 +604,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
}
```
-### 对数概率
+### Logprobs
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -616,7 +616,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F response_format="json"
```
-#### 响应
+#### Response
```json
{
@@ -676,7 +676,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
}
```
-### 片段时间戳
+### Segment timestamps
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -688,7 +688,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F response_format="verbose_json"
```
-#### 响应
+#### Response
```json
{
@@ -720,7 +720,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
}
```
-### 流式输出
+### Streaming
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -731,7 +731,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F stream=true
```
-#### 响应
+#### Response
```json
data: {"type":"transcript.text.delta","delta":"I","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]}]}
@@ -799,7 +799,7 @@ data: {"type":"transcript.text.delta","delta":".","logprobs":[{"token":".","logp
data: {"type":"transcript.text.done","text":"I see skies of blue and clouds of white, the bright blessed days, the dark sacred nights, and I think to myself, what a wonderful world.","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]},{"token":" see","logprob":-3.1281633e-7,"bytes":[32,115,101,101]},{"token":" skies","logprob":-2.3392786e-6,"bytes":[32,115,107,105,101,115]},{"token":" of","logprob":-3.1281633e-7,"bytes":[32,111,102]},{"token":" blue","logprob":-1.0280384e-6,"bytes":[32,98,108,117,101]},{"token":" and","logprob":-0.0005108566,"bytes":[32,97,110,100]},{"token":" clouds","logprob":-1.9361265e-7,"bytes":[32,99,108,111,117,100,115]},{"token":" of","logprob":-1.9361265e-7,"bytes":[32,111,102]},{"token":" white","logprob":-7.89631e-7,"bytes":[32,119,104,105,116,101]},{"token":",","logprob":-0.0014890312,"bytes":[44]},{"token":" the","logprob":-0.0110956915,"bytes":[32,116,104,101]},{"token":" bright","logprob":0.0,"bytes":[32,98,114,105,103,104,116]},{"token":" blessed","logprob":-0.000045848617,"bytes":[32,98,108,101,115,115,101,100]},{"token":" days","logprob":-0.000010802739,"bytes":[32,100,97,121,115]},{"token":",","logprob":-0.00001700133,"bytes":[44]},{"token":" the","logprob":-0.0000118755715,"bytes":[32,116,104,101]},{"token":" dark","logprob":-5.5122365e-7,"bytes":[32,100,97,114,107]},{"token":" sacred","logprob":-5.4385737e-6,"bytes":[32,115,97,99,114,101,100]},{"token":" nights","logprob":-4.00813e-6,"bytes":[32,110,105,103,104,116,115]},{"token":",","logprob":-0.0036910512,"bytes":[44]},{"token":" and","logprob":-0.0031903093,"bytes":[32,97,110,100]},{"token":" I","logprob":-1.504853e-6,"bytes":[32,73]},{"token":" think","logprob":-4.3202e-7,"bytes":[32,116,104,105,110,107]},{"token":" to","logprob":-1.9361265e-7,"bytes":[32,116,111]},{"token":" myself","logprob":-1.7432603e-6,"bytes":[32,109,121,115,101,108,102]},{"token":",","logprob":-0.29254505,"bytes":[44]},{"token":" what","logprob":-0.016815351,"bytes":[32,119,104,97,116]},{"token":" a","logprob":-3.1281633e-7,"bytes":[32,97]},{"token":" wonderful","logprob":-2.1008714e-6,"bytes":[32,119,111,110,100,101,114,102,117,108]},{"token":" world","logprob":-8.180258e-6,"bytes":[32,119,111,114,108,100]},{"token":".","logprob":-0.014231676,"bytes":[46]}],"usage":{"input_tokens":14,"input_token_details":{"text_tokens":0,"audio_tokens":14},"output_tokens":45,"total_tokens":59}}
```
-### 词级时间戳
+### Word timestamps
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -811,7 +811,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
-F response_format="verbose_json"
```
-#### 响应
+#### Response
```json
{
@@ -841,81 +841,81 @@ curl https://api.openai.com/v1/audio/transcriptions \
## 域类型
-### 转录
+### Transcription
- `Transcription object { text, languages, logprobs, usage }`
- 表示模型根据提供的输入返回的转录响应。
+ 表示模型根据所提供的输入返回的转录响应。
- `text: string`
- 转录的文本。
+ 转录后的文本。
- `languages: optional array of TranscriptionLanguage`
- 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠检测到任何语言。
+ 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠地检测出任何语言。
- `code: string`
- 音频中检测到的语言的代码。
+ 音频中检测到的语言代码。
- `logprobs: optional array of object { token, bytes, logprob }`
- 转录中标记的对数概率。仅在模型 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 如果 `logprobs` 被添加到 `include` 数组中时返回。
+ 转录中各 token 的对数概率。仅在使用以下模型时返回 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 如果 `logprobs` 已添加到 `include` 数组中。
- `token: optional string`
- 转录中的标记。
+ 转录中的 token。
- `bytes: optional array of number`
- 标记的字节。
+ 该 token 的字节。
- `logprob: optional number`
- 标记的对数概率。
+ 该 token 的对数概率。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的标记使用统计信息。
+ 本次请求的 token 使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按标记使用计费的模型的用量统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 此请求计费的输入标记数。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出标记数。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的标记总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- 用量对象的类型。对于此变体,始终为 `tokens` 。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 有关此请求计费的输入令牌的详细信息。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 此请求计费的音频令牌数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 此请求计费的文本令牌数量。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计信息。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
@@ -923,89 +923,89 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `type: "duration"`
- usage 对象的类型。始终为 `duration` 对于此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
-### 转录创建响应
+### Transcription Create Response
- `TranscriptionCreateResponse = Transcription or TranscriptionDiarized or TranscriptionVerbose`
- 表示模型根据提供的输入返回的转录响应。
+ 表示模型根据所提供的输入返回的转录响应。
- `Transcription object { text, languages, logprobs, usage }`
- 表示模型根据提供的输入返回的转录响应。
+ 表示模型根据所提供的输入返回的转录响应。
- `text: string`
- 转录的文本。
+ 转录后的文本。
- `languages: optional array of TranscriptionLanguage`
- 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠检测到任何语言。
+ 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠地检测出任何语言。
- `code: string`
- 音频中检测到的语言的代码。
+ 音频中检测到的语言代码。
- `logprobs: optional array of object { token, bytes, logprob }`
- 转录中令牌的对数概率。仅随模型 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 当 `logprobs` 被添加到 `include` 数组时返回。
+ 转录中各 token 的对数概率。仅在使用以下模型时返回 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 如果 `logprobs` 已添加到 `include` 数组中。
- `token: optional string`
- 转录中的令牌。
+ 转录中的 token。
- `bytes: optional array of number`
- 令牌的字节。
+ 该 token 的字节。
- `logprob: optional number`
- 令牌的对数概率。
+ 该 token 的对数概率。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的令牌使用统计。
+ 本次请求的 token 使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按令牌使用计费的模型的使用统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 此请求计费的输入令牌数。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出令牌数。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的令牌总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- 使用情况对象的类型。始终为 `tokens` 用于此变体。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 关于本次请求所计费的输入令牌的详细信息。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 本次请求所计费的音频令牌数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 本次请求所计费的文本令牌数量。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计信息。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
@@ -1013,13 +1013,13 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `type: "duration"`
- 使用情况对象的类型。 `duration` 始终为此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `TranscriptionDiarized object { duration, segments, task, 2 more }`
- 表示模型返回的带说话人分离的转录响应,包括合并后的转录文本和说话人片段注释。
+ 表示模型返回的说话人分离转写响应,包含合并后的转写文本和说话人分段标注。
- `duration: number`
@@ -1027,85 +1027,85 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `segments: array of TranscriptionDiarizedSegment`
- 带有时间戳和说话人标签的转录文本片段。
+ 带有时间戳和说话人标签的转写分段。
- `id: string`
- 片段的唯一标识符。
+ 该分段唯一标识符。
- `end: number`
- 片段的结束时间戳(以秒为单位)。
+ 分段的结束时间戳(以秒为单位)。
- `speaker: string`
- 此片段的说话人标签。当提供了已知说话人时,标签与 `known_speaker_names[]`。匹配。否则,说话人按顺序使用大写字母(`A`, `B`, ...).
+ 该分段的说话人标签。当提供了已知说话人时,标签匹配 `known_speaker_names[]`。否则,说话人将按顺序使用大写字母(`A`, `B`, ...).
- `start: number`
- 片段的起始时间戳(以秒为单位)。
+ 分段的起始时间戳(以秒为单位)。
- `text: string`
- 此片段的转录文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
- 片段的类型。 `transcript.text.segment`.
+ 分段的类型,固定为 `transcript.text.segment`.
- `"transcript.text.segment"`
- `task: "transcribe"`
- 所运行任务的类型。 `transcribe`.
+ 所运行任务的类型,固定为 `transcribe`.
- `"transcribe"`
- `text: string`
- 整个音频输入的合并转录文本。
+ 整个音频输入的拼接转写文本。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的令牌数或时长使用统计。
+ 本次请求的 token 或时长使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按令牌使用量计费的模型的使用统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 本次请求计费的输入令牌数。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出令牌数。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的令牌总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- usage 对象的类型。始终为 `tokens` 对于此变体。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 有关本次请求计费的输入令牌的详细信息。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 本次请求计费的音频令牌数。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 本次请求计费的文本令牌数。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
@@ -1113,13 +1113,13 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `type: "duration"`
- usage 对象的类型。始终为 `duration` 对于此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `TranscriptionVerbose object { duration, language, text, 3 more }`
- 表示模型根据提供的输入返回的详细 JSON 转录响应。
+ 表示模型根据提供的输入返回的详细 JSON 转写响应。
- `duration: number`
@@ -1135,83 +1135,83 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `segments: optional array of TranscriptionSegment`
- 转录文本的片段及其对应的详细信息。
+ 转写文本的分段及其对应的详细信息。
- `id: number`
- 片段的唯一标识符。
+ 该片段的唯一标识符。
- `avg_logprob: number`
- 该片段的平均对数概率。如果该值低于 -1,则认为对数概率失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 该片段的压缩比。如果该值大于 2.4,则认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 片段的结束时间(秒)。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 片段中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,则认为该片段为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 片段的偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 片段的开始时间(秒)。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成片段的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
- 片段的文本内容。
+ 该片段的文本内容。
- `tokens: array of number`
- 文本内容的 token ID 数组。
+ 文本内容对应的 token ID 数组。
- `usage: optional object { seconds, type }`
- 按音频输入时长计费的模型的使用统计。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
- 输入音频的时长(秒)。
+ 输入音频的时长(以秒为单位)。
- `type: "duration"`
- usage 对象的类型。始终为 `duration` 对于此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `words: optional array of TranscriptionWord`
- 提取的单词及其对应的时间戳。
+ 提取出的词语及其对应的时间戳。
- `end: number`
- 单词的结束时间(秒)。
+ 该词语的结束时间(以秒为单位)。
- `start: number`
- 单词的开始时间(秒)。
+ 该词语的开始时间(以秒为单位)。
- `word: string`
- 单词的文本内容。
+ 该词语的文本内容。
-### 转录分段
+### Transcription Diarized
- `TranscriptionDiarized object { duration, segments, task, 2 more }`
- 表示模型返回的带说话人标注的转录响应,包括合并后的转录文本和说话人分段注释。
+ 表示模型返回的说话人分离转写响应,包含合并后的转写文本和说话人分段标注。
- `duration: number`
@@ -1219,11 +1219,11 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `segments: array of TranscriptionDiarizedSegment`
- 带有时间戳和说话人标签的转录分段。
+ 带有时间戳和说话人标签的转写分段。
- `id: string`
- 分段的唯一标识符。
+ 该分段唯一标识符。
- `end: number`
@@ -1231,73 +1231,73 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `speaker: string`
- 此分段的说话人标签。当提供已知说话人时,标签会匹配 `known_speaker_names[]`。否则,说话人将按顺序使用大写字母标记(`A`, `B`, ...).
+ 该分段的说话人标签。当提供了已知说话人时,标签匹配 `known_speaker_names[]`。否则,说话人将按顺序使用大写字母(`A`, `B`, ...).
- `start: number`
- 分段的开始时间戳(以秒为单位)。
+ 分段的起始时间戳(以秒为单位)。
- `text: string`
- 此分段的转录文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
- 分段的类型。始终为 `transcript.text.segment`.
+ 分段的类型,固定为 `transcript.text.segment`.
- `"transcript.text.segment"`
- `task: "transcribe"`
- 所运行任务的类型。始终为 `transcribe`.
+ 所运行任务的类型,固定为 `transcribe`.
- `"transcribe"`
- `text: string`
- 整个音频输入的拼接转录文本。
+ 整个音频输入的拼接转写文本。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的令牌或时长使用统计信息。
+ 本次请求的 token 或时长使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按令牌用量计费的模型的使用统计信息。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 此请求计费的输入令牌数量。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出令牌数量。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的令牌总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- 使用对象的类型。始终为 `tokens` 用于此变体。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 关于此请求计费的输入令牌的详细信息。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 此请求计费的音频 token 数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 此请求计费的文本 token 数量。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计信息。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
@@ -1305,39 +1305,39 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `type: "duration"`
- 使用情况对象的类型。始终为 `duration` 对于此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
-### 转录重叠分段
+### Transcription Diarized Segment
- `TranscriptionDiarizedSegment object { id, end, speaker, 3 more }`
- 带有说话人元数据的分离转录文本段。
+ 一段带有说话人元数据的说话人归属转录文本。
- `id: string`
- 该段的唯一标识符。
+ 该分段唯一标识符。
- `end: number`
- 该段的结束时间戳(秒)。
+ 分段的结束时间戳(以秒为单位)。
- `speaker: string`
- 此段的说话人标签。当提供了已知说话人时,标签与之匹配 `known_speaker_names[]`。否则,说话人将使用大写字母按顺序标记(`A`, `B`, ...).
+ 该分段的说话人标签。当提供了已知说话人时,标签匹配 `known_speaker_names[]`。否则,说话人将按顺序使用大写字母(`A`, `B`, ...).
- `start: number`
- 该段的开始时间戳(秒)。
+ 分段的起始时间戳(以秒为单位)。
- `text: string`
- 此段的转录文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
- 段类型。始终为 `transcript.text.segment`.
+ 分段的类型,固定为 `transcript.text.segment`.
- `"transcript.text.segment"`
@@ -1355,7 +1355,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `code: string`
- 在音频中检测到的语言的代码。
+ 音频中检测到的语言代码。
### 转录片段
@@ -1367,31 +1367,31 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `avg_logprob: number`
- 该片段的平均对数概率。如果该值低于 -1,请认为对数概率计算失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 该片段的压缩比。如果该值大于 2.4,请认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 该片段的结束时间(秒)。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 该片段中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,请认为该片段为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 该片段的搜索偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 该片段的开始时间(秒)。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成该片段的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
@@ -1399,37 +1399,37 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `tokens: array of number`
- 文本内容的令牌 ID 数组。
+ 文本内容对应的 token ID 数组。
### 转录流事件
- `TranscriptionStreamEvent = TranscriptionTextSegmentEvent or TranscriptionTextDeltaEvent or TranscriptionTextDoneEvent`
- 当带说话人分离的转写返回包含说话人信息的已完成片段时触发。仅当你在以下情况下触发 [创建转写](/docs/api-reference/audio/create-transcription) 且 `stream` 设置为 `true` 且 `response_format` 设置为 `diarized_json`.
+ 在说话人分离转写返回带有说话人信息的已完成分段时发出。仅当你 [创建转写](/docs/api-reference/audio/create-transcription) 时 `stream` 设置为 `true` 和 `response_format` 设置为 `diarized_json`.
- `TranscriptionTextSegmentEvent object { id, end, speaker, 3 more }`
- 当带说话人分离的转写返回包含说话人信息的已完成片段时触发。仅当你在以下情况下触发 [创建转写](/docs/api-reference/audio/create-transcription) 且 `stream` 设置为 `true` 且 `response_format` 设置为 `diarized_json`.
+ 在说话人分离转写返回带有说话人信息的已完成分段时发出。仅当你 [创建转写](/docs/api-reference/audio/create-transcription) 时 `stream` 设置为 `true` 和 `response_format` 设置为 `diarized_json`.
- `id: string`
- 该片段的唯一标识符。
+ 该分段唯一标识符。
- `end: number`
- 该片段的结束时间戳,以秒为单位。
+ 分段的结束时间戳(以秒为单位)。
- `speaker: string`
- 该片段的说话人标签。
+ 此分段的说话人标签。
- `start: number`
- 该片段的开始时间戳,以秒为单位。
+ 分段的起始时间戳(以秒为单位)。
- `text: string`
- 该片段的转写文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
@@ -1439,119 +1439,119 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `TranscriptionTextDeltaEvent object { delta, type, logprobs, segment_id }`
- 当有额外的文本增量时触发。这也是转写开始时触发的第一个事件。仅当你在以下情况下触发 [创建转写](/docs/api-reference/audio/create-transcription) 在将 `Stream` 参数设置为 `true`.
+ 当存在额外的文本增量时发出。这也是转写开始时发出的第一个事件。仅当你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `Stream` 参数设置为 `true`.
- `delta: string`
- 额外转录的文本差异。
+ 额外转写出的文本增量。
- `type: "transcript.text.delta"`
- 事件类型。始终为 `transcript.text.delta`.
+ 事件的类型。始终为 `transcript.text.delta`.
- `"transcript.text.delta"`
- `logprobs: optional array of object { token, bytes, logprob }`
- 差异的对数概率。仅在你 [创建转录](/docs/api-reference/audio/create-transcription) 且将 `include[]` 参数设置为 `logprobs`.
+ 该增量的对数概率。仅在你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `include[]` 参数设置为 `logprobs`.
- `token: optional string`
- 用于生成对数概率的令牌。
+ 用于生成该对数概率的 token。
- `bytes: optional array of number`
- 用于生成对数概率的字节。
+ 用于生成该对数概率的字节。
- `logprob: optional number`
- 令牌的对数概率。
+ 该 token 的对数概率。
- `segment_id: optional string`
- 此差异所属的说话人分段标识符。仅在使用 `gpt-4o-transcribe-diarize`.
+ 该增量所属说话人分段标识符。仅在使用 `gpt-4o-transcribe-diarize`.
- `TranscriptionTextDoneEvent object { text, type, languages, 2 more }`
- 当转录完成时发出。包含完整的转录文本。仅当你 [创建转录](/docs/api-reference/audio/create-transcription) 且将 `Stream` 参数设置为 `true`.
+ 转写完成时触发。包含完整的转写文本。仅在你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `Stream` 参数设置为 `true`.
- `text: string`
- 转录的文本。
+ 转写出的文本。
- `type: "transcript.text.done"`
- 事件类型。始终为 `transcript.text.done`.
+ 事件的类型。始终为 `transcript.text.done`.
- `"transcript.text.done"`
- `languages: optional array of TranscriptionLanguage`
- 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示无法可靠检测到任何语言。
+ 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠地检测出任何语言。
- `code: string`
- 音频中检测到的语言的代码。
+ 音频中检测到的语言代码。
- `logprobs: optional array of object { token, bytes, logprob }`
- 转录中各个标记的对数概率。仅在你 [创建转录](/docs/api-reference/audio/create-transcription) 时将 `include[]` 参数设置为 `logprobs`.
+ 转写中各个 token 的对数概率。仅在你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `include[]` 参数设置为 `logprobs`.
- `token: optional string`
- 用于生成对数概率的标记。
+ 用于生成该对数概率的 token。
- `bytes: optional array of number`
- 用于生成对数概率的字节。
+ 用于生成该对数概率的字节。
- `logprob: optional number`
- 标记的对数概率。
+ 该 token 的对数概率。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按标记使用量计费的模型的用量统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 此请求计费的输入标记数。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出标记数。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的标记总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- 用量对象的类型。始终为 `tokens` 用于此变体。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 此请求计费的输入标记详情。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 此请求计费的音频标记数。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 此请求计费的文本标记数。
+ 本次请求计费的文本 token 数量。
-### 转录文本增量事件
+### 转写文本增量事件
- `TranscriptionTextDeltaEvent object { delta, type, logprobs, segment_id }`
- 当有额外的文本增量时发出。这也是转录开始时发出的第一个事件。仅当你 [创建转录](/docs/api-reference/audio/create-transcription) 并将 `Stream` 参数设置为 `true`.
+ 当存在额外的文本增量时发出。这也是转写开始时发出的第一个事件。仅当你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `Stream` 参数设置为 `true`.
- `delta: string`
- 额外转录的文本增量。
+ 额外转写出的文本增量。
- `type: "transcript.text.delta"`
@@ -1561,33 +1561,33 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `logprobs: optional array of object { token, bytes, logprob }`
- 增量的对数概率。仅当你 [创建转录](/docs/api-reference/audio/create-transcription) 并将 `include[]` 参数设置为 `logprobs`.
+ 该增量的对数概率。仅在你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `include[]` 参数设置为 `logprobs`.
- `token: optional string`
- 用于生成对数概率的令牌。
+ 用于生成该对数概率的 token。
- `bytes: optional array of number`
- 用于生成对数概率的字节。
+ 用于生成该对数概率的字节。
- `logprob: optional number`
- 令牌的对数概率。
+ 该 token 的对数概率。
- `segment_id: optional string`
- 此增量所属的说话人分离片段的标识符。仅在使用 `gpt-4o-transcribe-diarize`.
+ 该增量所属说话人分段标识符。仅在使用 `gpt-4o-transcribe-diarize`.
-### 转录文本完成事件
+### 转写文本完成事件
- `TranscriptionTextDoneEvent object { text, type, languages, 2 more }`
- 转录完成时触发。包含完整的转录文本。仅当你 [创建转录](/docs/api-reference/audio/create-transcription) 时将 `Stream` 参数设置为 `true`.
+ 转写完成时触发。包含完整的转写文本。仅在你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `Stream` 参数设置为 `true`.
- `text: string`
- 被转录的文本。
+ 转写出的文本。
- `type: "transcript.text.done"`
@@ -1597,75 +1597,75 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `languages: optional array of TranscriptionLanguage`
- 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示无法可靠检测到任何语言。
+ 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示未能可靠地检测出任何语言。
- `code: string`
- 在音频中检测到的语言代码。
+ 音频中检测到的语言代码。
- `logprobs: optional array of object { token, bytes, logprob }`
- 转录中各个词元的对数概率。仅当你 [创建转录](/docs/api-reference/audio/create-transcription) 时将 `include[]` 参数设置为 `logprobs`.
+ 转写中各个 token 的对数概率。仅在你 [创建转写](/docs/api-reference/audio/create-transcription) 时使用 `include[]` 参数设置为 `logprobs`.
- `token: optional string`
- 用于生成对数概率的词元。
+ 用于生成该对数概率的 token。
- `bytes: optional array of number`
- 用于生成对数概率的字节。
+ 用于生成该对数概率的字节。
- `logprob: optional number`
- 该词元的对数概率。
+ 该 token 的对数概率。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按词元用量计费的模型的用量统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 本次请求计费的输入词元数。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出词元数。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的词元总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- usage 对象的类型。始终为 `tokens` 此变体。
+ 使用对象的类型。对于此变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 此请求计费的输入令牌的详细信息。
+ 本次请求计费输入 token 的详细信息。
- `audio_tokens: optional number`
- 此请求计费的音频令牌数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 此请求计费的文本令牌数量。
+ 本次请求计费的文本 token 数量。
-### 转录文本分段事件
+### 转写文本分段事件
- `TranscriptionTextSegmentEvent object { id, end, speaker, 3 more }`
- 当带说话人信息的分离式转写返回一个完整分段时触发。仅在当你 [创建转写](/docs/api-reference/audio/create-transcription) 并 `stream` 设置为 `true` 和 `response_format` 设置为 `diarized_json`.
+ 在说话人分离转写返回带有说话人信息的已完成分段时发出。仅当你 [创建转写](/docs/api-reference/audio/create-transcription) 时 `stream` 设置为 `true` 和 `response_format` 设置为 `diarized_json`.
- `id: string`
- 分段的唯一标识符。
+ 该分段唯一标识符。
- `end: number`
- 分段的结束时间戳(秒)。
+ 分段的结束时间戳(以秒为单位)。
- `speaker: string`
@@ -1673,11 +1673,11 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `start: number`
- 分段的开始时间戳(秒)。
+ 分段的起始时间戳(以秒为单位)。
- `text: string`
- 此分段的转写文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
@@ -1685,11 +1685,11 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `"transcript.text.segment"`
-### 转录详细版
+### 详细转写
- `TranscriptionVerbose object { duration, language, text, 3 more }`
- 表示模型根据提供的输入返回的详细 JSON 转录响应。
+ 表示模型根据提供的输入返回的详细 JSON 转写响应。
- `duration: number`
@@ -1701,97 +1701,97 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `text: string`
- 转录的文本。
+ 转录后的文本。
- `segments: optional array of TranscriptionSegment`
- 转录文本的片段及其对应的详细信息。
+ 转写文本的分段及其对应的详细信息。
- `id: number`
- 片段的唯一标识符。
+ 该片段的唯一标识符。
- `avg_logprob: number`
- 片段的平均对数概率。如果该值低于 -1,则认为对数概率失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 片段的压缩比。如果该值大于 2.4,则认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 片段的结束时间(秒)。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 片段中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,则认为该片段为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 片段的查找偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 片段的开始时间(秒)。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成片段的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
- 片段的文本内容。
+ 该片段的文本内容。
- `tokens: array of number`
- 文本内容的 token ID 数组。
+ 文本内容对应的 token ID 数组。
- `usage: optional object { seconds, type }`
- 按音频输入时长计费的模型的使用统计。
+ 按音频输入时长计费模型的使用统计信息。
- `seconds: number`
- 输入音频的时长(秒)。
+ 输入音频的时长(以秒为单位)。
- `type: "duration"`
- 使用情况对象的类型。始终为 `duration` 此变体。
+ 使用对象的类型。对于此变体始终为 `duration` 。
- `"duration"`
- `words: optional array of TranscriptionWord`
- 提取的单词及其对应的时间戳。
+ 提取出的词语及其对应的时间戳。
- `end: number`
- 单词的结束时间(以秒为单位)。
+ 该词语的结束时间(以秒为单位)。
- `start: number`
- 单词的开始时间(以秒为单位)。
+ 该词语的开始时间(以秒为单位)。
- `word: string`
- 单词的文本内容。
+ 该词语的文本内容。
-### 转录词
+### 转写词
- `TranscriptionWord object { end, start, word }`
- `end: number`
- 该词在音频中的结束时间(秒)。
+ 该词语的结束时间(以秒为单位)。
- `start: number`
- 该词在音频中的开始时间(秒)。
+ 该词语的开始时间(以秒为单位)。
- `word: string`
- 该词的文本内容。
+ 该词语的文本内容。
# 翻译
@@ -1799,9 +1799,9 @@ curl https://api.openai.com/v1/audio/transcriptions \
**post** `/audio/translations`
-将音频翻译成英语。
+将音频翻译为英文。
-### 返回
+### Returns
- `Translation object { text }`
@@ -1819,51 +1819,51 @@ curl https://api.openai.com/v1/audio/transcriptions \
- `text: string`
- 翻译后的文本。
+ 已翻译的文本。
- `segments: optional array of TranscriptionSegment`
- 翻译文本的片段及其相应详细信息。
+ 已翻译文本的各片段及其对应详情。
- `id: number`
- 片段的唯一标识符。
+ 该片段的唯一标识符。
- `avg_logprob: number`
- 片段的平均对数概率。如果该值低于 -1,则认为 logprobs 失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 片段的压缩比。如果该值大于 2.4,则认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 片段的结束时间(以秒为单位)。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 片段中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,则认为该片段为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 片段的查找偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 片段的开始时间(以秒为单位)。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成片段的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
- 片段的文本内容。
+ 该片段的文本内容。
- `tokens: array of number`
- 文本内容的 Token ID 数组。
+ 文本内容对应的 token ID 数组。
### 示例
@@ -1875,7 +1875,7 @@ curl https://api.openai.com/v1/audio/translations \
-F model=whisper-1
```
-#### 响应
+#### Response
```json
{
@@ -1893,7 +1893,7 @@ curl https://api.openai.com/v1/audio/translations \
-F model="whisper-1"
```
-#### 响应
+#### Response
```json
{
@@ -1903,13 +1903,13 @@ curl https://api.openai.com/v1/audio/translations \
## 域类型
-### 翻译
+### Translation
- `Translation object { text }`
- `text: string`
-### 翻译创建响应
+### Translation Create Response
- `TranslationCreateResponse = Translation or TranslationVerbose`
@@ -1925,57 +1925,57 @@ curl https://api.openai.com/v1/audio/translations \
- `language: string`
- 输出翻译的语言(始终为 `english`).
+ 输出翻译的语言(始终 `english`).
- `text: string`
- 翻译后的文本。
+ 已翻译的文本。
- `segments: optional array of TranscriptionSegment`
- 翻译文本的片段及其对应详情。
+ 已翻译文本的各片段及其对应详情。
- `id: number`
- 片段的唯一标识符。
+ 该片段的唯一标识符。
- `avg_logprob: number`
- 片段的平均对数概率。如果该值低于 -1,请认为对数概率计算失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 片段的压缩比。如果该值大于 2.4,请认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 片段的结束时间(秒)。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 片段中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,请认为此片段为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 片段的查找偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 片段的开始时间(秒)。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成片段的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
- 片段的文本内容。
+ 该片段的文本内容。
- `tokens: array of number`
- 文本内容的 token ID 数组。
+ 文本内容对应的 token ID 数组。
-### 详细翻译
+### Translation Verbose
- `TranslationVerbose object { duration, language, text, segments }`
@@ -1985,81 +1985,81 @@ curl https://api.openai.com/v1/audio/translations \
- `language: string`
- 输出翻译的语言(始终为 `english`).
+ 输出翻译的语言(始终 `english`).
- `text: string`
- 翻译后的文本。
+ 已翻译的文本。
- `segments: optional array of TranscriptionSegment`
- 翻译文本的片段及其对应的详细信息。
+ 已翻译文本的各片段及其对应详情。
- `id: number`
- 片段的唯一标识符。
+ 该片段的唯一标识符。
- `avg_logprob: number`
- 片段的平均对数概率。如果该值低于 -1,请认为对数概率计算失败。
+ 该片段的平均 logprob。如果该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 片段的压缩比。如果该值大于 2.4,请认为压缩失败。
+ 该片段的压缩率。如果该值大于 2.4,则视为压缩失败。
- `end: number`
- 片段的结束时间(秒)。
+ 该片段的结束时间(以秒为单位)。
- `no_speech_prob: number`
- 片段中无语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1,请认为此片段为静音。
+ 该片段中无语音的概率。如果该值高于 1.0,且 `avg_logprob` 低于 -1,则视为该片段为静音。
- `seek: number`
- 片段的搜索偏移量。
+ 该片段的寻址偏移量。
- `start: number`
- 片段的开始时间(秒)。
+ 该片段的开始时间(以秒为单位)。
- `temperature: number`
- 用于生成片段的温度参数。
+ 用于生成该片段的 temperature 参数。
- `text: string`
- 片段的文本内容。
+ 该片段的文本内容。
- `tokens: array of number`
- 文本内容的标记 ID 数组。
+ 文本内容对应的 token ID 数组。
-# 语音同意
+# Voice Consents
-## 创建语音同意
+## Create voice consent
**post** `/audio/voice_consents`
-上传语音同意录音。
+上传一段语音同意录音。
-### 返回
+### Returns
- `id: string`
- 同意录音标识符。
+ 同意录制标识符。
- `created_at: number`
- 同意录音创建时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2078,7 +2078,7 @@ curl https://api.openai.com/v1/audio/voice_consents \
-F 'recording=@/path/to/recording'
```
-#### 响应
+#### Response
```json
{
@@ -2103,19 +2103,19 @@ curl https://api.openai.com/v1/audio/voice_consents \
## 删除语音同意
-**删除** `/audio/voice_consents/{consent_id}`
+**delete** `/audio/voice_consents/{consent_id}`
-删除一条语音同意录音。
+删除语音同意录音。
### 路径参数
- `consent_id: string`
-### 返回
+### Returns
- `id: string`
- 同意记录标识符。
+ 同意录制标识符。
- `deleted: boolean`
@@ -2131,7 +2131,7 @@ curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### 响应
+#### Response
```json
{
@@ -2149,41 +2149,41 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-## 列出语音同意
+## 列出语音授权
-**获取** `/audio/voice_consents`
+**get** `/audio/voice_consents`
-返回语音同意录音的列表。
+返回语音同意录音列表。
### 查询参数
- `after: optional string`
- 用于分页的游标。 `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
- `data: array of object { id, created_at, language, 2 more }`
- `id: string`
- 同意录音标识符。
+ 同意录制标识符。
- `created_at: number`
- 同意录音创建时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2208,7 +2208,7 @@ curl https://api.openai.com/v1/audio/voice_consents \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### 响应
+#### Response
```json
{
@@ -2235,7 +2235,7 @@ curl https://api.openai.com/v1/audio/voice_consents?limit=20 \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-## 检索语音同意
+## 获取语音授权
**get** `/audio/voice_consents/{consent_id}`
@@ -2245,23 +2245,23 @@ curl https://api.openai.com/v1/audio/voice_consents?limit=20 \
- `consent_id: string`
-### 返回
+### Returns
- `id: string`
- 同意录音的标识符。
+ 同意录制标识符。
- `created_at: number`
- 创建同意录音时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2276,7 +2276,7 @@ curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### 响应
+#### Response
```json
{
@@ -2295,11 +2295,11 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-## 更新语音同意
+## Update voice consent
**post** `/audio/voice_consents/{consent_id}`
-更新语音同意录音(仅元数据)。
+更新一条语音同意录音(仅元数据)。
### 路径参数
@@ -2309,25 +2309,25 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `name: string`
- 此同意记录更新后的标签。
+ 此同意记录的新标签。
-### 返回
+### Returns
- `id: string`
- 同意录音的标识符。
+ 同意录制标识符。
- `created_at: number`
- 创建同意录音时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2346,7 +2346,7 @@ curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \
}'
```
-#### 响应
+#### Response
```json
{
@@ -2372,7 +2372,7 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
## 域类型
-### 语音同意创建响应
+### 语音同意 创建响应
- `VoiceConsentCreateResponse object { id, created_at, language, 2 more }`
@@ -2380,19 +2380,19 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `id: string`
- 同意录音标识符。
+ 同意录制标识符。
- `created_at: number`
- 创建同意录音时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2406,7 +2406,7 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `id: string`
- 同意记录标识符。
+ 同意录制标识符。
- `deleted: boolean`
@@ -2422,19 +2422,19 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `id: string`
- 同意录音标识符。
+ 同意录制标识符。
- `created_at: number`
- 同意录音创建时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2450,19 +2450,19 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `id: string`
- 同意录音标识符。
+ 同意录制标识符。
- `created_at: number`
- 创建同意录音时的 Unix 时间戳(以秒为单位)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2478,19 +2478,19 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `id: string`
- 同意录音标识符。
+ 同意录制标识符。
- `created_at: number`
- 同意录音创建时的 Unix 时间戳(秒)。
+ 同意录制创建时的 Unix 时间戳(单位:秒)。
- `language: string`
- 同意短语的 BCP 47 语言标签(例如, `en-US`).
+ 同意提示的 BCP 47 语言标签(例如, `en-US`).
- `name: string`
- 上传同意录音时提供的标签。
+ 上传同意录制时提供的标签。
- `object: "audio.voice_consent"`
@@ -2498,15 +2498,15 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `"audio.voice_consent"`
-# 声音
+# 语音
-## 创建声音
+## 创建语音
**post** `/audio/voices`
创建自定义语音。
-### 返回
+### Returns
- `id: string`
@@ -2514,11 +2514,11 @@ curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
- `created_at: number`
- 语音创建时的 Unix 时间戳(秒)。
+ 语音创建时的 Unix 时间戳(以秒为单位)。
- `name: string`
- 语音名称。
+ 语音的名称。
- `object: "audio.voice"`
@@ -2537,7 +2537,7 @@ curl https://api.openai.com/v1/audio/voices \
-F name=name
```
-#### 响应
+#### Response
```json
{
@@ -2561,7 +2561,7 @@ curl https://api.openai.com/v1/audio/voices \
## 域类型
-### 语音创建响应
+### 语音 创建响应
- `VoiceCreateResponse object { id, created_at, name, object }`
diff --git a/docs/zh/api/reference/resources/audio/subresources/transcriptions/methods/create.md b/docs/zh/api/reference/resources/audio/subresources/transcriptions/methods/create.md
index 4049854..0acdb53 100644
--- a/docs/zh/api/reference/resources/audio/subresources/transcriptions/methods/create.md
+++ b/docs/zh/api/reference/resources/audio/subresources/transcriptions/methods/create.md
@@ -1,35 +1,35 @@
-> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
-## 创建转录
+## Create transcription
**post** `/audio/transcriptions`
-将音频转写为输入语言。
+将音频转录为输入语言。
-返回一个转录对象,格式为 `json`, `diarized_json`,或 `verbose_json`
-格式,或一个转录事件流。
+以 `json`, `diarized_json`,或 `verbose_json`
+格式返回转录对象,或返回转录事件流。
-### 返回
+### Returns
- `Transcription object { text, languages, logprobs, usage }`
- 表示模型根据提供的输入返回的转录响应。
+ 表示根据所提供输入由模型返回的转录响应。
- `text: string`
- 转录的文本。
+ 转录得到的文本。
- `languages: optional array of TranscriptionLanguage`
- 音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示无法可靠检测到任何语言。
+ 在音频中检测到的语言。由 `gpt-transcribe`。返回。空数组表示无法可靠地检测到任何语言。
- `code: string`
- 音频中检测到的语言的代码。
+ 在音频中检测到的语言代码。
- `logprobs: optional array of object { token, bytes, logprob }`
- 转录中 token 的对数概率。仅在使用模型 `gpt-4o-transcribe` 且 `gpt-4o-mini-transcribe` 如果 `logprobs` 被添加到 `include` 数组时返回。
+ 转录中各 token 的对数概率。仅在使用以下模型时返回: `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe` 当 `logprobs` 被添加到 `include` 数组时。
- `token: optional string`
@@ -37,19 +37,19 @@
- `bytes: optional array of number`
- token 的字节。
+ 该 token 的字节。
- `logprob: optional number`
- token 的对数概率。
+ 该 token 的对数概率。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的 token 使用统计。
+ 本次请求的 token 使用统计信息。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按 token 使用量计费的模型的使用统计。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
@@ -65,139 +65,139 @@
- `type: "tokens"`
- 使用情况对象的类型。始终为 `tokens` 用于此变体。
+ usage 对象的类型。对于该变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 本次请求计费的输入令牌详情。
+ 本次请求计费的输入 token 详情。
- `audio_tokens: optional number`
- 本次请求计费的音频令牌数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 本次请求计费的文本令牌数量。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计信息。
+ 按音频输入时长计费的模型的使用情况统计。
- `seconds: number`
- 输入音频的时长(秒)。
+ 输入音频的时长,单位为秒。
- `type: "duration"`
- 使用情况对象的类型。始终 `duration` 用于此变体。
+ usage 对象的类型。对于该变体始终为 `duration` 。
- `"duration"`
- `TranscriptionDiarized object { duration, segments, task, 2 more }`
- 表示模型返回的带说话人分离的转录响应,包括合并后的转录文本和说话人片段注释。
+ 表示模型返回的说话人分离转写响应,包括合并后的转写文本和说话人分段标注。
- `duration: number`
- 输入音频的时长(秒)。
+ 输入音频的时长,单位为秒。
- `segments: array of TranscriptionDiarizedSegment`
- 带有时间戳和说话人标签注释的转录文本片段。
+ 带有时间戳和说话人标签的转写分段。
- `id: string`
- 片段的唯一标识符。
+ 该分段的唯一标识符。
- `end: number`
- 片段的结束时间戳(秒)。
+ 该分段的结束时间戳,单位为秒。
- `speaker: string`
- 此片段的说话人标签。提供已知说话人时,标签匹配 `known_speaker_names[]`。否则,说话人按顺序使用大写字母标记(`A`, `B`, ...).
+ 该分段的说话人标签。当提供已知说话人时,标签与 `known_speaker_names[]`。匹配;否则,说话人将按顺序使用大写字母标记为(`A`, `B`, ...).
- `start: number`
- 片段的开始时间戳(秒)。
+ 该分段的起始时间戳,单位为秒。
- `text: string`
- 此片段的转录文本。
+ 该分段的转写文本。
- `type: "transcript.text.segment"`
- 片段的类型。始终 `transcript.text.segment`.
+ 分段的类型。始终为 `transcript.text.segment`.
- `"transcript.text.segment"`
- `task: "transcribe"`
- 运行的任务类型。始终 `transcribe`.
+ 所运行任务的类型。始终为 `transcribe`.
- `"transcribe"`
- `text: string`
- 整个音频输入的合并转录文本。
+ 整个音频输入拼接后的转写文本。
- `usage: optional object { input_tokens, output_tokens, total_tokens, 2 more } or object { seconds, type }`
- 请求的令牌或时长使用统计信息。
+ 本次请求的 token 或时长使用情况统计。
- `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`
- 按令牌用量计费的模型的使用统计信息。
+ 按 token 使用量计费的模型的使用统计信息。
- `input_tokens: number`
- 此请求计费的输入令牌数量。
+ 本次请求计费的输入 token 数。
- `output_tokens: number`
- 生成的输出令牌数量。
+ 生成的输出 token 数。
- `total_tokens: number`
- 使用的令牌总数(输入 + 输出)。
+ 使用的 token 总数(输入 + 输出)。
- `type: "tokens"`
- 使用情况对象的类型。始终 `tokens` 用于此变体。
+ usage 对象的类型。对于该变体始终为 `tokens` 。
- `"tokens"`
- `input_token_details: optional object { audio_tokens, text_tokens }`
- 此请求计费的输入令牌的详细信息。
+ 本次请求计费的输入 token 详情。
- `audio_tokens: optional number`
- 此请求计费的音频令牌数量。
+ 本次请求计费的音频 token 数量。
- `text_tokens: optional number`
- 此请求计费的文本令牌数量。
+ 本次请求计费的文本 token 数量。
- `Duration object { seconds, type }`
- 按音频输入时长计费的模型的使用统计信息。
+ 按音频输入时长计费的模型的使用情况统计。
- `seconds: number`
- 输入音频的时长(以秒为单位)。
+ 输入音频的时长,单位为秒。
- `type: "duration"`
- 使用情况对象的类型。始终 `duration` 用于此变体。
+ usage 对象的类型。对于该变体始终为 `duration` 。
- `"duration"`
- `TranscriptionVerbose object { duration, language, text, 3 more }`
- 表示模型根据提供的输入返回的详细 json 转录响应。
+ 表示模型基于提供的输入返回的详细 JSON 转写响应。
- `duration: number`
@@ -209,81 +209,81 @@
- `text: string`
- 转录的文本。
+ 转录得到的文本。
- `segments: optional array of TranscriptionSegment`
- 转录文本的片段及其相应详细信息。
+ 转写文本的分段及其对应的详细信息。
- `id: number`
- 片段的唯一标识符。
+ 该段的唯一标识符。
- `avg_logprob: number`
- 片段的平均 logprob。如果该值低于 -1,则认为 logprobs 计算失败。
+ 该段的平均 logprob。若该值低于 -1,则视为 logprobs 失败。
- `compression_ratio: number`
- 片段压缩比。若该值大于 2.4,则认为压缩失败。
+ 该段的压缩比。若该值大于 2.4,则视为压缩失败。
- `end: number`
- 片段结束时间,单位秒。
+ 该段的结束时间,以秒为单位。
- `no_speech_prob: number`
- 片段中无语音的概率。若该值高于 1.0 且 `avg_logprob` 低于 -1,则认为该片段为静音。
+ 该段中无语音的概率。若该值高于 1.0 并且 `avg_logprob` 低于 -1,则将该段视为静音。
- `seek: number`
- 片段偏移量。
+ 该段的寻址偏移量。
- `start: number`
- 片段开始时间,单位秒。
+ 该段的开始时间,以秒为单位。
- `temperature: number`
- 用于生成片段的温度参数。
+ 用于生成该段的温度参数。
- `text: string`
- 片段的文本内容。
+ 该段的文本内容。
- `tokens: array of number`
- 文本内容对应的 token ID 数组。
+ 该文本内容的 token ID 数组。
- `usage: optional object { seconds, type }`
- 按音频输入时长计费的模型使用统计信息。
+ 按音频输入时长计费的模型的使用情况统计。
- `seconds: number`
- 输入音频的时长,单位秒。
+ 输入音频的时长,单位为秒。
- `type: "duration"`
- 使用情况对象的类型。始终为 `duration` 用于此变体。
+ usage 对象的类型。对于该变体始终为 `duration` 。
- `"duration"`
- `words: optional array of TranscriptionWord`
- 提取的单词及其对应的时间戳。
+ 提取出的词语及其对应的时间戳。
- `end: number`
- 单词结束时间,单位秒。
+ 该词语的结束时间,以秒为单位。
- `start: number`
- 单词开始时间,单位秒。
+ 该词语的开始时间,以秒为单位。
- `word: string`
- 单词的文本内容。
+ 该词语的文本内容。
### 示例
@@ -355,7 +355,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
}
```
-### 说话人分离
+### 说话人区分
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -481,7 +481,7 @@ curl https://api.openai.com/v1/audio/transcriptions \
}
```
-### 片段时间戳
+### 分段时间戳
```http
curl https://api.openai.com/v1/audio/transcriptions \
@@ -604,7 +604,7 @@ data: {"type":"transcript.text.delta","delta":".","logprobs":[{"token":".","logp
data: {"type":"transcript.text.done","text":"I see skies of blue and clouds of white, the bright blessed days, the dark sacred nights, and I think to myself, what a wonderful world.","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]},{"token":" see","logprob":-3.1281633e-7,"bytes":[32,115,101,101]},{"token":" skies","logprob":-2.3392786e-6,"bytes":[32,115,107,105,101,115]},{"token":" of","logprob":-3.1281633e-7,"bytes":[32,111,102]},{"token":" blue","logprob":-1.0280384e-6,"bytes":[32,98,108,117,101]},{"token":" and","logprob":-0.0005108566,"bytes":[32,97,110,100]},{"token":" clouds","logprob":-1.9361265e-7,"bytes":[32,99,108,111,117,100,115]},{"token":" of","logprob":-1.9361265e-7,"bytes":[32,111,102]},{"token":" white","logprob":-7.89631e-7,"bytes":[32,119,104,105,116,101]},{"token":",","logprob":-0.0014890312,"bytes":[44]},{"token":" the","logprob":-0.0110956915,"bytes":[32,116,104,101]},{"token":" bright","logprob":0.0,"bytes":[32,98,114,105,103,104,116]},{"token":" blessed","logprob":-0.000045848617,"bytes":[32,98,108,101,115,115,101,100]},{"token":" days","logprob":-0.000010802739,"bytes":[32,100,97,121,115]},{"token":",","logprob":-0.00001700133,"bytes":[44]},{"token":" the","logprob":-0.0000118755715,"bytes":[32,116,104,101]},{"token":" dark","logprob":-5.5122365e-7,"bytes":[32,100,97,114,107]},{"token":" sacred","logprob":-5.4385737e-6,"bytes":[32,115,97,99,114,101,100]},{"token":" nights","logprob":-4.00813e-6,"bytes":[32,110,105,103,104,116,115]},{"token":",","logprob":-0.0036910512,"bytes":[44]},{"token":" and","logprob":-0.0031903093,"bytes":[32,97,110,100]},{"token":" I","logprob":-1.504853e-6,"bytes":[32,73]},{"token":" think","logprob":-4.3202e-7,"bytes":[32,116,104,105,110,107]},{"token":" to","logprob":-1.9361265e-7,"bytes":[32,116,111]},{"token":" myself","logprob":-1.7432603e-6,"bytes":[32,109,121,115,101,108,102]},{"token":",","logprob":-0.29254505,"bytes":[44]},{"token":" what","logprob":-0.016815351,"bytes":[32,119,104,97,116]},{"token":" a","logprob":-3.1281633e-7,"bytes":[32,97]},{"token":" wonderful","logprob":-2.1008714e-6,"bytes":[32,119,111,110,100,101,114,102,117,108]},{"token":" world","logprob":-8.180258e-6,"bytes":[32,119,111,114,108,100]},{"token":".","logprob":-0.014231676,"bytes":[46]}],"usage":{"input_tokens":14,"input_token_details":{"text_tokens":0,"audio_tokens":14},"output_tokens":45,"total_tokens":59}}
```
-### 单词时间戳
+### 词级时间戳
```http
curl https://api.openai.com/v1/audio/transcriptions \
diff --git a/docs/zh/api/reference/resources/beta/subresources/chatkit.md b/docs/zh/api/reference/resources/beta/subresources/chatkit.md
index 3056273..2e83c3e 100644
--- a/docs/zh/api/reference/resources/beta/subresources/chatkit.md
+++ b/docs/zh/api/reference/resources/beta/subresources/chatkit.md
@@ -1,22 +1,22 @@
# ChatKit
-> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 来获取文档页面的 Markdown 版本。
## 域类型
-### ChatKit 工作流
+### ChatKit Workflow
- `ChatKitWorkflow object { id, state_variables, tracing, version }`
- 工作流元数据和会话返回的状态。
+ 为会话返回的工作流元数据与状态。
- `id: string`
- 支持该会话的工作流的标识符。
+ 支持该会话的工作流标识符。
- `state_variables: map[string or boolean or number] or null`
- 调用工作流时应用的状态变量键值对。未提供覆盖时默认为 null。
+ 调用工作流时应用的状态变量键值对。如果未提供任何覆盖,则默认为 null。
- `string`
@@ -26,15 +26,15 @@
- `tracing: object { enabled }`
- 应用于工作流的追踪设置。
+ 应用于该工作流的追踪设置。
- `enabled: boolean`
- 指示是否启用追踪。
+ 指示是否已启用追踪。
- `version: string or null`
- 会话使用的特定工作流版本。使用最新部署时默认为 null。
+ 该会话使用的特定工作流版本。使用最新部署时,默认为 null。
# 会话
@@ -42,19 +42,19 @@
**post** `/chatkit/sessions/{session_id}/cancel`
-取消一个活动的 ChatKit 会话,并返回其最近的元数据。
+取消一个活动的 ChatKit 会话,并返回其最新的元数据。
-取消将阻止新请求使用已颁发的客户端密钥。
+取消后可防止新请求使用已签发的客户端密钥。
### 路径参数
- `session_id: string`
-### 返回
+### 返回值
- `ChatSession object { id, chatkit_configuration, client_secret, 7 more }`
- 表示一个 ChatKit 会话及其解析后的配置。
+ 表示一个 ChatKit 会话及其已解析的配置。
- `id: string`
@@ -62,7 +62,7 @@
- `chatkit_configuration: ChatSessionChatKitConfiguration`
- 会话的已解析 ChatKit 功能配置。
+ 为该会话解析的 ChatKit 功能配置。
- `automatic_thread_titling: ChatSessionAutomaticThreadTitling`
@@ -74,19 +74,19 @@
- `file_upload: ChatSessionFileUpload`
- 会话的上传设置。
+ 该会话的上传设置。
- `enabled: boolean`
- 指示会话是否启用了上传功能。
+ 指示该会话是否启用了上传功能。
- `max_file_size: number or null`
- 最大上传大小(以兆字节为单位)。
+ 最大上传大小(以 MB 为单位)。
- `max_files: number or null`
- 会话期间允许的最大上传次数。
+ 该会话期间允许的最大上传数量。
- `history: ChatSessionHistory`
@@ -94,19 +94,19 @@
- `enabled: boolean`
- 指示会话的聊天历史记录是否被持久化。
+ 指示是否为该会话保留聊天历史记录。
- `recent_threads: number or null`
- 历史视图中显示的先前线程数量。当保留所有历史时默认为 null。
+ 历史记录视图中显示的先前线程数量。当保留所有历史记录时,默认为 null。
- `client_secret: string`
- 用于认证会话请求的临时客户端密钥。
+ 用于验证会话请求的临时客户端密钥。
- `expires_at: number`
- 会话过期时的 Unix 时间戳(以秒为单位)。
+ 会话过期的 Unix 时间戳(以秒为单位)。
- `max_requests_per_1_minute: number`
@@ -114,7 +114,7 @@
- `object: "chatkit.session"`
- 始终为 `chatkit.session`.
+ 始终为的类型判别字段 `chatkit.session`.
- `"chatkit.session"`
@@ -124,7 +124,7 @@
- `max_requests_per_1_minute: number`
- 每分钟窗口内允许的最大请求数。
+ 一分钟时间窗口内允许的最大请求数。
- `status: ChatSessionStatus`
@@ -138,7 +138,7 @@
- `user: string`
- 与会话关联的用户标识符。
+ 与该会话关联的用户标识符。
- `workflow: ChatKitWorkflow`
@@ -146,11 +146,11 @@
- `id: string`
- 支持该会话的工作流的标识符。
+ 支持该会话的工作流标识符。
- `state_variables: map[string or boolean or number] or null`
- 调用工作流时应用的状态变量键值对。未提供覆盖项时默认为 null。
+ 调用工作流时应用的状态变量键值对。如果未提供任何覆盖,则默认为 null。
- `string`
@@ -164,11 +164,11 @@
- `enabled: boolean`
- 指示是否启用了追踪。
+ 指示是否已启用追踪。
- `version: string or null`
- 会话所使用的特定工作流版本。使用最新部署时默认为 null。
+ 该会话使用的特定工作流版本。使用最新部署时,默认为 null。
### 示例
@@ -255,23 +255,23 @@ curl -X POST \
创建一个 ChatKit 会话。
-### 请求体参数
+### Body Parameters
- `user: string`
- 一个自由格式字符串,用于标识你的最终用户;确保此会话可以访问其他具有相同 `user` 作用域的对象。
+ 用于标识最终用户的自由格式字符串;确保此 Session 能够访问具有相同 `user` scope 的其他对象。
- `workflow: ChatSessionWorkflowParam`
- 驱动会话的工作流。
+ 为会话提供能力的工作流。
- `id: string`
- 会话调用的工作流的标识符。
+ 会话所调用的工作流的标识符。
- `state_variables: optional map[string or boolean or number]`
- 转发给工作流的状态变量。键最多可有 64 个字符,值必须是原始类型,映射默认为空对象。
+ 转发到该工作流的状态变量。键长度最多为 64 个字符,值必须是基本类型,并且映射默认为空对象。
- `string`
@@ -281,7 +281,7 @@ curl -X POST \
- `tracing: optional object { enabled }`
- 可选的追踪覆盖设置,用于工作流调用。省略时,默认启用追踪。
+ 该工作流调用的可选追踪覆盖项。省略时,默认启用追踪。
- `enabled: optional boolean`
@@ -293,11 +293,11 @@ curl -X POST \
- `chatkit_configuration: optional ChatSessionChatKitConfigurationParam`
- ChatKit 运行时配置功能的可选覆盖设置
+ ChatKit 运行时配置功能的可选覆盖项
- `automatic_thread_titling: optional object { enabled }`
- 自动线程标题的配置。省略时,默认启用自动线程标题。
+ 自动线程标题生成的配置。省略时,默认启用自动线程标题生成。
- `enabled: optional boolean`
@@ -305,55 +305,55 @@ curl -X POST \
- `file_upload: optional object { enabled, max_file_size, max_files }`
- 上传启用及其限制的配置。省略时,上传默认禁用(max_files 10,max_file_size 512 MB)。
+ 上传启用与限制的配置。省略时,默认禁用上传(max_files 为 10,max_file_size 为 512 MB)。
- `enabled: optional boolean`
- 为此会话启用上传。默认为 false。
+ 为该会话启用上传。默认为 false。
- `max_file_size: optional number`
- 每个上传文件的最大大小(以兆字节为单位)。默认为 512 MB,这是允许的最大大小。
+ 每个上传文件的最大大小(以 MB 为单位)。默认为 512 MB,这也是允许的最大大小。
- `max_files: optional number`
- 可上传到会话的最大文件数。默认为 10。
+ 可上传到该会话的最大文件数。默认为 10。
- `history: optional object { enabled, recent_threads }`
- 聊天历史记录的保留配置。省略时,历史记录默认启用,且 recent_threads 无限制(null)。
+ 聊天记录保留的配置。省略时,默认启用历史记录,recent_threads 不设上限(null)。
- `enabled: optional boolean`
- 使聊天用户能够访问之前的 ChatKit 线程。默认为 true。
+ 允许聊天用户访问之前的 ChatKit 线程。默认为 true。
- `recent_threads: optional number`
- 用户可访问的近期 ChatKit 线程数量。未设置时默认为无限制。
+ 用户可访问的最近 ChatKit 线程数。未设置时默认为无限制。
- `expires_after: optional ChatSessionExpiresAfterParam`
- 会话过期时间(从创建起以秒计)的可选覆盖设置。默认为 10 分钟。
+ 会话过期时间的可选覆盖项,以创建时起计算的秒数表示。默认为 10 分钟。
- `anchor: "created_at"`
- 用于计算过期时间的基础时间戳。目前固定为 `created_at`.
+ 用于计算过期时间的基础时间戳。当前固定为 `created_at`.
- `"created_at"`
- `seconds: number`
- 锚点后会话过期的秒数。
+ 会话在锚点之后过期的秒数。
- `rate_limits: optional ChatSessionRateLimitsParam`
- 每分钟请求限制的可选覆盖值。省略时默认为 10。
+ 可选的每分钟请求限制覆盖。未提供时默认为 10。
- `max_requests_per_1_minute: optional number`
会话每分钟允许的最大请求数。默认为 10。
-### 返回
+### 返回值
- `ChatSession object { id, chatkit_configuration, client_secret, 7 more }`
@@ -365,31 +365,31 @@ curl -X POST \
- `chatkit_configuration: ChatSessionChatKitConfiguration`
- 会话的已解析 ChatKit 功能配置。
+ 为该会话解析的 ChatKit 功能配置。
- `automatic_thread_titling: ChatSessionAutomaticThreadTitling`
- 自动线程命名偏好。
+ 自动线程标题偏好设置。
- `enabled: boolean`
- 是否启用自动线程命名。
+ 是否启用自动线程标题。
- `file_upload: ChatSessionFileUpload`
- 会话的上传设置。
+ 该会话的上传设置。
- `enabled: boolean`
- 指示会话是否启用上传。
+ 指示该会话是否启用了上传功能。
- `max_file_size: number or null`
- 以兆字节为单位的最大上传大小。
+ 最大上传大小(以 MB 为单位)。
- `max_files: number or null`
- 会话期间允许的最大上传次数。
+ 该会话期间允许的最大上传数量。
- `history: ChatSessionHistory`
@@ -397,11 +397,11 @@ curl -X POST \
- `enabled: boolean`
- 指示会话的聊天历史记录是否持久化。
+ 指示是否为该会话保留聊天历史记录。
- `recent_threads: number or null`
- 历史视图中的先前线程数。保留全部历史时默认为 null。
+ 历史记录视图中显示的先前线程数量。当保留所有历史记录时,默认为 null。
- `client_secret: string`
@@ -409,7 +409,7 @@ curl -X POST \
- `expires_at: number`
- 会话到期时间的 Unix 时间戳(秒)。
+ 会话过期的 Unix 时间戳(以秒为单位)。
- `max_requests_per_1_minute: number`
@@ -417,7 +417,7 @@ curl -X POST \
- `object: "chatkit.session"`
- 类型判别器始终为 `chatkit.session`.
+ 始终为的类型判别字段 `chatkit.session`.
- `"chatkit.session"`
@@ -441,7 +441,7 @@ curl -X POST \
- `user: string`
- 与会话关联的用户标识符。
+ 与该会话关联的用户标识符。
- `workflow: ChatKitWorkflow`
@@ -449,11 +449,11 @@ curl -X POST \
- `id: string`
- 支持该会话的工作流的标识符。
+ 支持该会话的工作流标识符。
- `state_variables: map[string or boolean or number] or null`
- 调用工作流时应用的状态变量键值对。当未提供覆盖项时,默认为 null。
+ 调用工作流时应用的状态变量键值对。如果未提供任何覆盖,则默认为 null。
- `string`
@@ -463,15 +463,15 @@ curl -X POST \
- `tracing: object { enabled }`
- 应用于工作流的追踪设置。
+ 应用于该工作流的追踪设置。
- `enabled: boolean`
- 指示是否启用追踪。
+ 指示是否已启用追踪。
- `version: string or null`
- 会话使用的特定工作流版本。当使用最新部署时,默认为 null。
+ 该会话使用的特定工作流版本。使用最新部署时,默认为 null。
### 示例
@@ -571,19 +571,19 @@ curl https://api.openai.com/v1/chatkit/sessions \
}
```
-# 线程
+# Threads
-## 删除 ChatKit 线程
+## Delete ChatKit thread
-**删除** `/chatkit/threads/{thread_id}`
+**delete** `/chatkit/threads/{thread_id}`
-删除一个 ChatKit 线程及其条目和存储的附件。
+删除一个 ChatKit 对话线程及其中的条目和已存储的附件。
### 路径参数
- `thread_id: string`
-### 返回
+### 返回值
- `id: string`
@@ -595,7 +595,7 @@ curl https://api.openai.com/v1/chatkit/sessions \
- `object: "chatkit.thread.deleted"`
- 类型判别器,始终为 `chatkit.thread.deleted`.
+ 始终为的类型判别字段 `chatkit.thread.deleted`.
- `"chatkit.thread.deleted"`
@@ -622,17 +622,17 @@ curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
**get** `/chatkit/threads`
-列出 ChatKit 线程,支持可选的分页和用户筛选。
+列出 ChatKit 会话线程,支持可选的分页和用户筛选。
### 查询参数
- `after: optional string`
- 列出在该线程项 ID 之后创建的项。第一页默认为 null。
+ 在此线程项 ID 之后创建的列表项。对于第一页,默认为 null。
- `before: optional string`
- 列出在该线程项 ID 之前创建的项。最新结果默认为 null。
+ 在此线程项 ID 之前创建的列表项。对于最新结果,默认为 null。
- `limit: optional number`
@@ -640,7 +640,7 @@ curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
- `order: optional "asc" or "desc"`
- 按创建时间对结果进行排序的顺序。默认为 `desc`.
+ 按创建时间排序结果的顺序。默认为 `desc`.
- `"asc"`
@@ -650,11 +650,11 @@ curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
筛选属于此用户标识符的线程。默认为 null 以返回所有用户。
-### 返回
+### 返回值
- `data: array of ChatKitThread`
- 项目列表
+ 一个项列表
- `id: string`
@@ -666,13 +666,13 @@ curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
- `object: "chatkit.thread"`
- 类型判别器,始终为 `chatkit.thread`.
+ 始终为的类型判别字段 `chatkit.thread`.
- `"chatkit.thread"`
- `status: object { type } or object { reason, type } or object { reason, type }`
- 线程的当前状态。默认值为 `active` 对于新创建的线程。
+ 线程的当前状态。默认为 `active` ,适用于新建线程。
- `Active object { type }`
@@ -680,41 +680,41 @@ curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
- `type: "active"`
- 状态判别器,始终为 `active`.
+ 始终为的状态判别字段 `active`.
- `"active"`
- `Locked object { reason, type }`
- 表示线程已被锁定,无法接受新的输入。
+ 表示线程已锁定,无法接受新的输入。
- `reason: string or null`
- 线程被锁定的原因。未记录原因时默认为 null。
+ 线程被锁定的原因。当没有记录原因时,默认为 null。
- `type: "locked"`
- 状态判别器,始终为 `locked`.
+ 始终为的状态判别字段 `locked`.
- `"locked"`
- `Closed object { reason, type }`
- 表示线程已被关闭。
+ 表示线程已关闭。
- `reason: string or null`
- 线程被关闭的原因。未记录原因时默认为 null。
+ 线程被关闭的原因。当没有记录原因时,默认为 null。
- `type: "closed"`
- 状态判别器,始终为 `closed`.
+ 始终为的状态判别字段 `closed`.
- `"closed"`
- `title: string or null`
- 线程的可选人类可读标题。未生成标题时默认为 null。
+ 可选的、人类可读的线程标题。当尚未生成标题时,默认为 null。
- `user: string`
@@ -722,19 +722,19 @@ curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
- `first_id: string or null`
- 列表中第一个项目的 ID。
+ 列表中第一项的 ID。
- `has_more: boolean`
- 是否还有更多可用项目。
+ 是否还有更多项可用。
- `last_id: string or null`
- 列表中最后一个项目的 ID。
+ 列表中最后一项的 ID。
- `object: "list"`
- 返回的对象类型,必须为 `list`.
+ 返回对象的类型,必须为 `list`.
- `"list"`
@@ -798,11 +798,11 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
}
```
-## 列出 ChatKit 线程条目
+## 列出 ChatKit 会话条目
**get** `/chatkit/threads/{thread_id}/items`
-列出属于 ChatKit 线程的项目。
+列出属于 ChatKit 会话线程的条目。
### 路径参数
@@ -812,11 +812,11 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `after: optional string`
- 在此线程项 ID 之后创建的列表项。默认在第一页中为 null。
+ 在此线程项 ID 之后创建的列表项。对于第一页,默认为 null。
- `before: optional string`
- 在此线程项 ID 之前创建的列表项。默认为最新结果中的 null。
+ 在此线程项 ID 之前创建的列表项。对于最新结果,默认为 null。
- `limit: optional number`
@@ -824,25 +824,25 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `order: optional "asc" or "desc"`
- 按创建时间对结果进行排序的顺序。默认为 `desc`.
+ 按创建时间排序结果的顺序。默认为 `desc`.
- `"asc"`
- `"desc"`
-### 返回
+### 返回值
- `ChatKitThreadItemList object { data, first_id, has_more, 2 more }`
- 为 ChatKit API 渲染的分页线程条目列表。
+ 为 ChatKit API 渲染的线程条目的分页列表。
- `data: array of ChatKitThreadUserMessageItem or ChatKitThreadAssistantMessageItem or ChatKitWidgetItem or 3 more`
- 条目列表
+ 一个项列表
- `ChatKitThreadUserMessageItem object { id, attachments, content, 5 more }`
- 线程中用户撰写的消息。
+ 线程中由用户创作的消息。
- `id: string`
@@ -870,7 +870,7 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "image" or "file"`
- 附件鉴别器。
+ 附件的判别字段。
- `"image"`
@@ -878,19 +878,19 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `content: array of object { text, type } or object { text, type }`
- 用户提供的有序内容元素。
+ 由用户提供的有序内容元素。
- `InputText object { text, type }`
- 用户贡献到线程的文本块。
+ 用户贡献给该线程的文本块。
- `text: string`
- 用户提供的纯文本内容。
+ 由用户提供的纯文本内容。
- `type: "input_text"`
- 类型鉴别器,始终为 `input_text`.
+ 始终为的类型判别字段 `input_text`.
- `"input_text"`
@@ -904,17 +904,17 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "quoted_text"`
- 类型鉴别器,始终为 `quoted_text`.
+ 始终为的类型判别字段 `quoted_text`.
- `"quoted_text"`
- `created_at: number`
- 条目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `inference_options: object { model, tool_choice } or null`
- 应用于消息的推理覆盖。未设置时默认为 null。
+ 应用于此消息的推理覆盖参数。未设置时默认为 null。
- `model: string or null`
@@ -922,7 +922,7 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `tool_choice: object { id } or null`
- 首选调用的工具。当 ChatKit 应自动选择时默认值为 null。
+ 首选调用的工具。在 ChatKit 应自动选择时默认为 null。
- `id: string`
@@ -930,7 +930,7 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -944,19 +944,19 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `ChatKitThreadAssistantMessageItem object { id, content, created_at, 3 more }`
- 线程中由助手撰写的消息。
+ 线程内由助手撰写的消息。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `content: array of ChatKitResponseOutputText`
- 有序的助手响应片段。
+ 按顺序排列的助手响应片段。
- `annotations: array of object { source, type } or object { source, type }`
- 附加到响应文本的注释有序列表。
+ 附加到响应文本上的有序注释列表。
- `File object { source, type }`
@@ -964,21 +964,21 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `source: object { filename, type }`
- 注释引用的文件附件。
+ 该注释所引用的文件附件。
- `filename: string`
- 注释引用的文件名。
+ 该注释所引用的文件名。
- `type: "file"`
- 类型判别器,始终为 `file`.
+ 始终为的类型判别字段 `file`.
- `"file"`
- `type: "file"`
- 类型判别器,始终为 `file` 此注释的类型。
+ 始终为以下值的类型鉴别字段 `file` 用于此注释。
- `"file"`
@@ -988,21 +988,21 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `source: object { type, url }`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url`.
+ 始终为的类型判别字段 `url`.
- `"url"`
- `url: string`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url` 此注释的类型。
+ 始终为以下值的类型鉴别字段 `url` 用于此注释。
- `"url"`
@@ -1012,17 +1012,17 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "output_text"`
- 始终为的类型判别器 `output_text`.
+ 始终为的类型判别字段 `output_text`.
- `"output_text"`
- `created_at: number`
- 项目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 始终为的类型判别器 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -1032,25 +1032,25 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "chatkit.assistant_message"`
- 始终为的类型判别器 `chatkit.assistant_message`.
+ 始终为的类型判别字段 `chatkit.assistant_message`.
- `"chatkit.assistant_message"`
- `ChatKitWidgetItem object { id, created_at, object, 3 more }`
- 渲染小组件负载的线程项目。
+ 用于渲染小组件负载的线程项。
- `id: string`
- 线程项目的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 始终为的类型判别器 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -1060,25 +1060,25 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "chatkit.widget"`
- 始终为的类型判别器 `chatkit.widget`.
+ 始终为的类型判别字段 `chatkit.widget`.
- `"chatkit.widget"`
- `widget: string`
- 在界面中渲染的序列化小组件负载。
+ 在 UI 中渲染的序列化小组件负载。
- `ChatKitClientToolCall object { id, arguments, call_id, 7 more }`
- 由助手发起的客户端工具调用的记录。
+ 由助手发起的客户端工具调用记录。
- `id: string`
- 线程项目的标识符。
+ 线程条目的标识符。
- `arguments: string`
- 发送给工具的 JSON 编码参数。
+ 发送给该工具的 JSON 编码参数。
- `call_id: string`
@@ -1086,7 +1086,7 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `created_at: number`
- 项目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `name: string`
@@ -1094,17 +1094,17 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `object: "chatkit.thread_item"`
- 始终为的类型判别器 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
- `output: string or null`
- 从工具捕获的 JSON 编码输出。执行进行中时默认为 null。
+ 从该工具捕获的 JSON 编码输出。执行进行中时默认为 null。
- `status: "in_progress" or "completed"`
- 工具调用的执行状态。
+ 该工具调用的执行状态。
- `"in_progress"`
@@ -1116,21 +1116,21 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "chatkit.client_tool_call"`
- 类型判别器,始终为 `chatkit.client_tool_call`.
+ 始终为的类型判别字段 `chatkit.client_tool_call`.
- `"chatkit.client_tool_call"`
- `ChatKitTask object { id, created_at, heading, 5 more }`
- 由 工作流 发出的任务,用于显示进度和状态更新。
+ 由工作流发出的任务,用于显示进度和状态更新。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项目创建时的 Unix 时间戳(以秒为单位)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `heading: string or null`
@@ -1138,7 +1138,7 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -1160,31 +1160,31 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "chatkit.task"`
- 类型判别器,始终为 `chatkit.task`.
+ 始终为的类型判别字段 `chatkit.task`.
- `"chatkit.task"`
- `ChatKitTaskGroup object { id, created_at, object, 3 more }`
- 线程中 工作流 任务的集合。
+ 在线程中分组到一起的 工作流 任务的集合。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项目创建时的 Unix 时间戳(以秒为单位)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
- `tasks: array of object { heading, summary, type }`
- 组中包含的任务。
+ 包含在该分组中的任务。
- `heading: string or null`
@@ -1192,7 +1192,7 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `summary: string or null`
- 描述分组任务的可选摘要。省略时默认为 null。
+ 描述该分组任务的可选摘要。省略时默认为 null。
- `type: "custom" or "thought"`
@@ -1208,25 +1208,25 @@ curl "https://api.openai.com/v1/chatkit/threads?limit=2&order=desc" \
- `type: "chatkit.task_group"`
- 始终为 `chatkit.task_group`.
+ 始终为的类型判别字段 `chatkit.task_group`.
- `"chatkit.task_group"`
- `first_id: string or null`
- 列表中第一个条目的 ID。
+ 列表中第一项的 ID。
- `has_more: boolean`
- 是否还有更多条目可用。
+ 是否还有更多项可用。
- `last_id: string or null`
- 列表中最后一个条目的 ID。
+ 列表中最后一项的 ID。
- `object: "list"`
- 返回的对象类型,必须为 `list`.
+ 返回对象的类型,必须为 `list`.
- `"list"`
@@ -1321,21 +1321,21 @@ curl "https://api.openai.com/v1/chatkit/threads/cthr_abc123/items?limit=3" \
}
```
-## 检索 ChatKit 线程
+## 检索 ChatKit 会话线程
**get** `/chatkit/threads/{thread_id}`
-按标识符检索 ChatKit 线程。
+通过其标识符检索 ChatKit 会话线程。
### 路径参数
- `thread_id: string`
-### 返回
+### 返回值
- `ChatKitThread object { id, created_at, object, 3 more }`
- 表示一个 ChatKit 线程及其当前状态。
+ 表示一个 ChatKit 会话线程及其当前状态。
- `id: string`
@@ -1347,13 +1347,13 @@ curl "https://api.openai.com/v1/chatkit/threads/cthr_abc123/items?limit=3" \
- `object: "chatkit.thread"`
- 类型判别器,始终为 `chatkit.thread`.
+ 始终为的类型判别字段 `chatkit.thread`.
- `"chatkit.thread"`
- `status: object { type } or object { reason, type } or object { reason, type }`
- 线程的当前状态。默认为 `active` 对于新创建的线程。
+ 线程的当前状态。默认为 `active` ,适用于新建线程。
- `Active object { type }`
@@ -1361,21 +1361,21 @@ curl "https://api.openai.com/v1/chatkit/threads/cthr_abc123/items?limit=3" \
- `type: "active"`
- 状态判别器,始终为 `active`.
+ 始终为的状态判别字段 `active`.
- `"active"`
- `Locked object { reason, type }`
- 表示线程已锁定,无法接受新输入。
+ 表示线程已锁定,无法接受新的输入。
- `reason: string or null`
- 线程被锁定的原因。未记录原因时默认为 null。
+ 线程被锁定的原因。当没有记录原因时,默认为 null。
- `type: "locked"`
- 状态判别器,始终为 `locked`.
+ 始终为的状态判别字段 `locked`.
- `"locked"`
@@ -1385,17 +1385,17 @@ curl "https://api.openai.com/v1/chatkit/threads/cthr_abc123/items?limit=3" \
- `reason: string or null`
- 线程被关闭的原因。未记录原因时默认为 null。
+ 线程被关闭的原因。当没有记录原因时,默认为 null。
- `type: "closed"`
- 状态判别器,始终为 `closed`.
+ 始终为的状态判别字段 `closed`.
- `"closed"`
- `title: string or null`
- 线程的可选人类可读标题。未生成标题时默认为 null。
+ 可选的、人类可读的线程标题。当尚未生成标题时,默认为 null。
- `user: string`
@@ -1470,13 +1470,13 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
}
```
-## 领域类型
+## 域类型
### 聊天会话
- `ChatSession object { id, chatkit_configuration, client_secret, 7 more }`
- 表示一个 ChatKit 会话及其解析后的配置。
+ 表示一个 ChatKit 会话及其已解析的配置。
- `id: string`
@@ -1484,11 +1484,11 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `chatkit_configuration: ChatSessionChatKitConfiguration`
- 该会话的 ChatKit 功能配置解析结果。
+ 为该会话解析的 ChatKit 功能配置。
- `automatic_thread_titling: ChatSessionAutomaticThreadTitling`
- 自动线程标题设置。
+ 自动线程标题偏好设置。
- `enabled: boolean`
@@ -1496,19 +1496,19 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `file_upload: ChatSessionFileUpload`
- 会话的上传设置。
+ 该会话的上传设置。
- `enabled: boolean`
- 指示会话是否启用上传。
+ 指示该会话是否启用了上传功能。
- `max_file_size: number or null`
- 最大上传大小(以兆字节为单位)。
+ 最大上传大小(以 MB 为单位)。
- `max_files: number or null`
- 会话期间允许的最大上传次数。
+ 该会话期间允许的最大上传数量。
- `history: ChatSessionHistory`
@@ -1516,15 +1516,15 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `enabled: boolean`
- 指示会话是否持久保存聊天历史记录。
+ 指示是否为该会话保留聊天历史记录。
- `recent_threads: number or null`
- 历史记录视图中显示的先前线程数。当保留所有历史记录时默认为 null。
+ 历史记录视图中显示的先前线程数量。当保留所有历史记录时,默认为 null。
- `client_secret: string`
- 为会话请求进行身份验证的临时客户端密钥。
+ 用于验证会话请求的临时客户端密钥。
- `expires_at: number`
@@ -1536,17 +1536,17 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `object: "chatkit.session"`
- 类型鉴别器,始终为 `chatkit.session`.
+ 始终为的类型判别字段 `chatkit.session`.
- `"chatkit.session"`
- `rate_limits: ChatSessionRateLimits`
- 解析后的速率限制值。
+ 已解析的速率限制值。
- `max_requests_per_1_minute: number`
- 一分钟窗口内允许的最大请求数。
+ 一分钟时间窗口内允许的最大请求数。
- `status: ChatSessionStatus`
@@ -1560,7 +1560,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `user: string`
- 与会话关联的用户标识符。
+ 与该会话关联的用户标识符。
- `workflow: ChatKitWorkflow`
@@ -1568,11 +1568,11 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `id: string`
- 支持该会话的工作流的标识符。
+ 支持该会话的工作流标识符。
- `state_variables: map[string or boolean or number] or null`
- 调用工作流时应用的状态变量键值对。未提供覆盖时默认为 null。
+ 调用工作流时应用的状态变量键值对。如果未提供任何覆盖,则默认为 null。
- `string`
@@ -1582,55 +1582,55 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `tracing: object { enabled }`
- 应用于工作流的追踪设置。
+ 应用于该工作流的追踪设置。
- `enabled: boolean`
- 指示是否启用追踪。
+ 指示是否已启用追踪。
- `version: string or null`
- 用于会话的特定工作流版本。使用最新部署时默认为 null。
+ 该会话使用的特定工作流版本。使用最新部署时,默认为 null。
-### 聊天会话自动线程标题
+### 聊天会话自动线程命名
- `ChatSessionAutomaticThreadTitling object { enabled }`
- 会话的自动线程标题偏好。
+ 会话的自动会话标题偏好。
- `enabled: boolean`
是否启用自动线程标题。
-### 聊天会话 ChatKit 配置
+### Chat Session ChatKit 配置
- `ChatSessionChatKitConfiguration object { automatic_thread_titling, file_upload, history }`
- 会话的ChatKit配置。
+ 会话的 ChatKit 配置。
- `automatic_thread_titling: ChatSessionAutomaticThreadTitling`
- 自动线程标题偏好。
+ 自动线程标题偏好设置。
- `enabled: boolean`
- 是否启用了自动线程标题。
+ 是否启用自动线程标题。
- `file_upload: ChatSessionFileUpload`
- 会话的上传设置。
+ 该会话的上传设置。
- `enabled: boolean`
- 指示会话是否启用了上传功能。
+ 指示该会话是否启用了上传功能。
- `max_file_size: number or null`
- 最大上传大小(以兆字节为单位)。
+ 最大上传大小(以 MB 为单位)。
- `max_files: number or null`
- 会话期间允许的最大上传次数。
+ 该会话期间允许的最大上传数量。
- `history: ChatSessionHistory`
@@ -1638,59 +1638,59 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `enabled: boolean`
- 指示会话是否持久化聊天历史记录。
+ 指示是否为该会话保留聊天历史记录。
- `recent_threads: number or null`
- 历史视图中显示的先前线程数量。保留全部历史记录时默认为null。
+ 历史记录视图中显示的先前线程数量。当保留所有历史记录时,默认为 null。
-### 聊天会话 ChatKit 配置参数
+### Chat Session ChatKit Configuration Param
- `ChatSessionChatKitConfigurationParam object { automatic_thread_titling, file_upload, history }`
- ChatKit行为的可选按会话配置设置。
+ 用于 ChatKit 行为的可选每会话配置设置。
- `automatic_thread_titling: optional object { enabled }`
- 自动线程标题的配置。省略时,默认启用自动线程标题。
+ 自动线程标题生成的配置。省略时,默认启用自动线程标题生成。
- `enabled: optional boolean`
- 启用自动线程标题生成。默认为true。
+ 启用自动线程标题生成。默认为 true。
- `file_upload: optional object { enabled, max_file_size, max_files }`
- 上传启用和限制的配置。省略时,上传默认禁用(max_files 10,max_file_size 512 MB)。
+ 上传启用与限制的配置。省略时,默认禁用上传(max_files 为 10,max_file_size 为 512 MB)。
- `enabled: optional boolean`
- 为本次会话启用上传。默认为false。
+ 为该会话启用上传。默认为 false。
- `max_file_size: optional number`
- 每个上传文件的最大大小(以兆字节为单位)。默认为512 MB,这是允许的最大大小。
+ 每个上传文件的最大大小(以 MB 为单位)。默认为 512 MB,这也是允许的最大大小。
- `max_files: optional number`
- 可上传到会话的最大文件数。默认为10。
+ 可上传到该会话的最大文件数。默认为 10。
- `history: optional object { enabled, recent_threads }`
- 聊天历史保留的配置。省略时,默认启用历史记录,且对recent_threads无限制(null)。
+ 聊天记录保留的配置。省略时,默认启用历史记录,recent_threads 不设上限(null)。
- `enabled: optional boolean`
- 允许聊天用户访问以前的ChatKit线程。默认为true。
+ 允许聊天用户访问之前的 ChatKit 线程。默认为 true。
- `recent_threads: optional number`
- 用户可访问的最近ChatKit线程数量。未设置时默认为无限制。
+ 用户可访问的最近 ChatKit 线程数。未设置时默认为无限制。
-### 聊天会话在参数之后过期
+### 聊天会话在参数后过期
- `ChatSessionExpiresAfterParam object { anchor, seconds }`
- 控制会话相对于锚点时间戳的过期时间。
+ 控制会话相对于锚定时间戳的过期时间。
- `anchor: "created_at"`
@@ -1700,9 +1700,9 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `seconds: number`
- 锚点之后会话过期的秒数。
+ 会话在锚点之后过期的秒数。
-### 聊天会话文件上传
+### Chat Session File Upload
- `ChatSessionFileUpload object { enabled, max_file_size, max_files }`
@@ -1714,37 +1714,37 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `max_file_size: number or null`
- 最大上传大小(以兆字节为单位)。
+ 最大上传大小(以 MB 为单位)。
- `max_files: number or null`
- 会话期间允许的最大上传次数。
+ 该会话期间允许的最大上传数量。
-### 聊天会话历史
+### Chat Session History
- `ChatSessionHistory object { enabled, recent_threads }`
- 为会话返回的历史记录保留偏好。
+ 为会话返回的历史记录保留偏好设置。
- `enabled: boolean`
- 指示聊天历史记录是否针对会话持久化。
+ 指示是否为该会话保留聊天历史记录。
- `recent_threads: number or null`
- 在历史视图中显示的先前线程数量。当保留所有历史记录时,默认为 null。
+ 历史记录视图中显示的先前线程数量。当保留所有历史记录时,默认为 null。
-### 聊天会话速率限制
+### Chat 会话速率限制
- `ChatSessionRateLimits object { max_requests_per_1_minute }`
- 会话的每分钟活跃请求限制。
+ 会话中每分钟活跃请求限制。
- `max_requests_per_1_minute: number`
- 一分钟窗口内允许的最大请求数。
+ 一分钟时间窗口内允许的最大请求数。
-### 聊天会话速率限制参数
+### Chat Session Rate Limits Param
- `ChatSessionRateLimitsParam object { max_requests_per_1_minute }`
@@ -1768,7 +1768,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `ChatSessionWorkflowParam object { id, state_variables, tracing, version }`
- 应用于聊天会话的工作流引用和覆盖设置。
+ 应用于聊天会话的工作流参考与覆盖设置。
- `id: string`
@@ -1776,7 +1776,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `state_variables: optional map[string or boolean or number]`
- 转发到工作流的状态变量。键最长可为 64 个字符,值必须是原始类型,映射默认为空对象。
+ 转发到该工作流的状态变量。键长度最多为 64 个字符,值必须是基本类型,并且映射默认为空对象。
- `string`
@@ -1786,7 +1786,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `tracing: optional object { enabled }`
- 针对追踪调用的可选工作流覆盖设置。省略时,追踪默认启用。
+ 该工作流调用的可选追踪覆盖项。省略时,默认启用追踪。
- `enabled: optional boolean`
@@ -1796,11 +1796,11 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
要运行的特定工作流版本。默认为最新部署的版本。
-### ChatKit 附件
+### ChatKit Attachment
- `ChatKitAttachment object { id, mime_type, name, 2 more }`
- 线程项目上包含的附件元数据。
+ 在线程项上附加的附件元数据。
- `id: string`
@@ -1820,43 +1820,43 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "image" or "file"`
- 附件判别器。
+ 附件的判别字段。
- `"image"`
- `"file"`
-### ChatKit 响应输出文本
+### ChatKit Response Output Text
- `ChatKitResponseOutputText object { annotations, text, type }`
- 助手响应文本,附带可选的注释。
+ Assistant 响应文本,可附带可选的注释。
- `annotations: array of object { source, type } or object { source, type }`
- 附加到响应文本的注释的有序列表。
+ 附加到响应文本上的有序注释列表。
- `File object { source, type }`
- 引用上传文件的注释。
+ 引用已上传文件的注释。
- `source: object { filename, type }`
- 注释引用的文件附件。
+ 该注释所引用的文件附件。
- `filename: string`
- 注释引用的文件名。
+ 该注释所引用的文件名。
- `type: "file"`
- 类型判别器,始终为 `file`.
+ 始终为的类型判别字段 `file`.
- `"file"`
- `type: "file"`
- 类型判别器,始终为 `file` 用于此注释。
+ 始终为以下值的类型鉴别字段 `file` 用于此注释。
- `"file"`
@@ -1866,21 +1866,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `source: object { type, url }`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url`.
+ 始终为的类型判别字段 `url`.
- `"url"`
- `url: string`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url` 用于此注释。
+ 始终为以下值的类型鉴别字段 `url` 用于此注释。
- `"url"`
@@ -1890,15 +1890,15 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "output_text"`
- 类型判别器,始终为 `output_text`.
+ 始终为的类型判别字段 `output_text`.
- `"output_text"`
-### ChatKit 线程
+### ChatKit Thread
- `ChatKitThread object { id, created_at, object, 3 more }`
- 表示一个 ChatKit 线程及其当前状态。
+ 表示一个 ChatKit 会话线程及其当前状态。
- `id: string`
@@ -1910,77 +1910,77 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `object: "chatkit.thread"`
- 类型判别器,始终为 `chatkit.thread`.
+ 始终为的类型判别字段 `chatkit.thread`.
- `"chatkit.thread"`
- `status: object { type } or object { reason, type } or object { reason, type }`
- 线程的当前状态。默认为 `active` 用于新创建的线程。
+ 线程的当前状态。默认为 `active` ,适用于新建线程。
- `Active object { type }`
- 指示线程处于活动状态。
+ 表示线程处于活动状态。
- `type: "active"`
- 状态判别器,始终为 `active`.
+ 始终为的状态判别字段 `active`.
- `"active"`
- `Locked object { reason, type }`
- 指示线程已锁定且无法接受新的输入。
+ 表示线程已锁定,无法接受新的输入。
- `reason: string or null`
- 线程被锁定的原因。未记录原因时默认为 null。
+ 线程被锁定的原因。当没有记录原因时,默认为 null。
- `type: "locked"`
- 状态判别器,始终为 `locked`.
+ 始终为的状态判别字段 `locked`.
- `"locked"`
- `Closed object { reason, type }`
- 指示线程已关闭。
+ 表示线程已关闭。
- `reason: string or null`
- 线程被关闭的原因。未记录原因时默认为 null。
+ 线程被关闭的原因。当没有记录原因时,默认为 null。
- `type: "closed"`
- 状态判别器,始终为 `closed`.
+ 始终为的状态判别字段 `closed`.
- `"closed"`
- `title: string or null`
- 线程的可选人类可读标题。未生成标题时默认为 null。
+ 可选的、人类可读的线程标题。当尚未生成标题时,默认为 null。
- `user: string`
用于标识拥有该线程的最终用户的自由格式字符串。
-### ChatKit 线程助手消息项
+### ChatKit Thread Assistant Message Item
- `ChatKitThreadAssistantMessageItem object { id, content, created_at, 3 more }`
- 线程中由助手撰写的消息。
+ 线程内由助手撰写的消息。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `content: array of ChatKitResponseOutputText`
- 有序的助手响应片段。
+ 按顺序排列的助手响应片段。
- `annotations: array of object { source, type } or object { source, type }`
- 附加到响应文本的注释的有序列表。
+ 附加到响应文本上的有序注释列表。
- `File object { source, type }`
@@ -1988,21 +1988,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `source: object { filename, type }`
- 注释引用的文件附件。
+ 该注释所引用的文件附件。
- `filename: string`
- 注释引用的文件名。
+ 该注释所引用的文件名。
- `type: "file"`
- 类型判别器,始终为 `file`.
+ 始终为的类型判别字段 `file`.
- `"file"`
- `type: "file"`
- 类型判别器,始终为 `file` 用于此注释。
+ 始终为以下值的类型鉴别字段 `file` 用于此注释。
- `"file"`
@@ -2012,21 +2012,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `source: object { type, url }`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url`.
+ 始终为的类型判别字段 `url`.
- `"url"`
- `url: string`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url` 用于此注释。
+ 始终为以下值的类型鉴别字段 `url` 用于此注释。
- `"url"`
@@ -2036,17 +2036,17 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "output_text"`
- 类型判别器,始终为 `output_text`.
+ 始终为的类型判别字段 `output_text`.
- `"output_text"`
- `created_at: number`
- 项创建时的 Unix 时间戳(以秒为单位)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2056,27 +2056,27 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.assistant_message"`
- 类型判别器,始终为 `chatkit.assistant_message`.
+ 始终为的类型判别字段 `chatkit.assistant_message`.
- `"chatkit.assistant_message"`
-### ChatKit Thread 条目列表
+### ChatKit Thread Item List
- `ChatKitThreadItemList object { data, first_id, has_more, 2 more }`
- 为 ChatKit API 渲染的线程项分页列表。
+ 为 ChatKit API 渲染的线程条目的分页列表。
- `data: array of ChatKitThreadUserMessageItem or ChatKitThreadAssistantMessageItem or ChatKitWidgetItem or 3 more`
- 项目列表
+ 一个项列表
- `ChatKitThreadUserMessageItem object { id, attachments, content, 5 more }`
- 线程中用户撰写的消息。
+ 线程中由用户创作的消息。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `attachments: array of ChatKitAttachment`
@@ -2100,7 +2100,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "image" or "file"`
- 附件判别器。
+ 附件的判别字段。
- `"image"`
@@ -2108,19 +2108,19 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `content: array of object { text, type } or object { text, type }`
- 用户提供的有序内容元素。
+ 由用户提供的有序内容元素。
- `InputText object { text, type }`
- 用户贡献给线程的文本块。
+ 用户贡献给该线程的文本块。
- `text: string`
- 用户提供的纯文本内容。
+ 由用户提供的纯文本内容。
- `type: "input_text"`
- 类型判别器,始终为 `input_text`.
+ 始终为的类型判别字段 `input_text`.
- `"input_text"`
@@ -2134,17 +2134,17 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "quoted_text"`
- 类型判别器,始终为 `quoted_text`.
+ 始终为的类型判别字段 `quoted_text`.
- `"quoted_text"`
- `created_at: number`
- 项目创建时的 Unix 时间戳(以秒为单位)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `inference_options: object { model, tool_choice } or null`
- 应用于消息的推理覆盖。未设置时默认为 null。
+ 应用于此消息的推理覆盖参数。未设置时默认为 null。
- `model: string or null`
@@ -2152,7 +2152,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `tool_choice: object { id } or null`
- 首选调用的工具。当 ChatKit 应自动选择时,默认为 null。
+ 首选调用的工具。在 ChatKit 应自动选择时默认为 null。
- `id: string`
@@ -2160,7 +2160,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2174,19 +2174,19 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `ChatKitThreadAssistantMessageItem object { id, content, created_at, 3 more }`
- 线程中由助手撰写的消息。
+ 线程内由助手撰写的消息。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `content: array of ChatKitResponseOutputText`
- 有序的助手响应片段。
+ 按顺序排列的助手响应片段。
- `annotations: array of object { source, type } or object { source, type }`
- 附加到响应文本的注释的有序列表。
+ 附加到响应文本上的有序注释列表。
- `File object { source, type }`
@@ -2194,21 +2194,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `source: object { filename, type }`
- 注释引用的文件附件。
+ 该注释所引用的文件附件。
- `filename: string`
- 注释引用的文件名。
+ 该注释所引用的文件名。
- `type: "file"`
- 类型判别器,始终为 `file`.
+ 始终为的类型判别字段 `file`.
- `"file"`
- `type: "file"`
- 类型判别器,始终为 `file` 此注释的类型。
+ 始终为以下值的类型鉴别字段 `file` 用于此注释。
- `"file"`
@@ -2218,21 +2218,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `source: object { type, url }`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url`.
+ 始终为的类型判别字段 `url`.
- `"url"`
- `url: string`
- 注释引用的 URL。
+ 该注释所引用的 URL。
- `type: "url"`
- 类型判别器,始终为 `url` 此注释的类型。
+ 始终为以下值的类型鉴别字段 `url` 用于此注释。
- `"url"`
@@ -2242,17 +2242,17 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "output_text"`
- 类型判别器,始终为 `output_text`.
+ 始终为的类型判别字段 `output_text`.
- `"output_text"`
- `created_at: number`
- 项目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2262,25 +2262,25 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.assistant_message"`
- 类型判别器,始终为 `chatkit.assistant_message`.
+ 始终为的类型判别字段 `chatkit.assistant_message`.
- `"chatkit.assistant_message"`
- `ChatKitWidgetItem object { id, created_at, object, 3 more }`
- 渲染小部件负载的线程项。
+ 用于渲染小组件负载的线程项。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2290,25 +2290,25 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.widget"`
- 类型判别器,始终为 `chatkit.widget`.
+ 始终为的类型判别字段 `chatkit.widget`.
- `"chatkit.widget"`
- `widget: string`
- 在 UI 中渲染的序列化小部件负载。
+ 在 UI 中渲染的序列化小组件负载。
- `ChatKitClientToolCall object { id, arguments, call_id, 7 more }`
- 由助手发起的客户端工具调用的记录。
+ 由助手发起的客户端工具调用记录。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `arguments: string`
- 发送给工具的 JSON 编码参数。
+ 发送给该工具的 JSON 编码参数。
- `call_id: string`
@@ -2316,7 +2316,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `created_at: number`
- 项目创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `name: string`
@@ -2324,17 +2324,17 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
- `output: string or null`
- 从工具捕获的 JSON 编码输出。执行进行中时默认为 null。
+ 从该工具捕获的 JSON 编码输出。执行进行中时默认为 null。
- `status: "in_progress" or "completed"`
- 工具调用的执行状态。
+ 该工具调用的执行状态。
- `"in_progress"`
@@ -2346,21 +2346,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.client_tool_call"`
- 类型判别器,始终为 `chatkit.client_tool_call`.
+ 始终为的类型判别字段 `chatkit.client_tool_call`.
- `"chatkit.client_tool_call"`
- `ChatKitTask object { id, created_at, heading, 5 more }`
- 由 工作流 发出的任务,用于显示进度和状态更新。
+ 由工作流发出的任务,用于显示进度和状态更新。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项创建时的 Unix 时间戳(以秒为单位)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `heading: string or null`
@@ -2368,7 +2368,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2390,31 +2390,31 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.task"`
- 类型判别器,始终为 `chatkit.task`.
+ 始终为的类型判别字段 `chatkit.task`.
- `"chatkit.task"`
- `ChatKitTaskGroup object { id, created_at, object, 3 more }`
- 线程中分组的 工作流 任务集合。
+ 在线程中分组到一起的 工作流 任务的集合。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项创建时的 Unix 时间戳(以秒为单位)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 类型判别器,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
- `tasks: array of object { heading, summary, type }`
- 组中包含的任务。
+ 包含在该分组中的任务。
- `heading: string or null`
@@ -2422,7 +2422,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `summary: string or null`
- 描述分组任务的可选摘要。省略时默认为 null。
+ 描述该分组任务的可选摘要。省略时默认为 null。
- `type: "custom" or "thought"`
@@ -2438,7 +2438,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.task_group"`
- 类型判别器,始终 `chatkit.task_group`.
+ 始终为的类型判别字段 `chatkit.task_group`.
- `"chatkit.task_group"`
@@ -2456,19 +2456,19 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `object: "list"`
- 返回的对象类型,必须为 `list`.
+ 返回对象的类型,必须为 `list`.
- `"list"`
-### ChatKit 线程用户消息条目
+### ChatKit Thread User Message Item
- `ChatKitThreadUserMessageItem object { id, attachments, content, 5 more }`
- 线程中用户编写的消息。
+ 线程中由用户创作的消息。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `attachments: array of ChatKitAttachment`
@@ -2492,7 +2492,7 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "image" or "file"`
- 附件判别器。
+ 附件的判别字段。
- `"image"`
@@ -2500,19 +2500,19 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `content: array of object { text, type } or object { text, type }`
- 用户提供的有序内容元素。
+ 由用户提供的有序内容元素。
- `InputText object { text, type }`
- 用户贡献到线程的文本块。
+ 用户贡献给该线程的文本块。
- `text: string`
- 用户提供的纯文本内容。
+ 由用户提供的纯文本内容。
- `type: "input_text"`
- 类型判别器,始终为 `input_text`.
+ 始终为的类型判别字段 `input_text`.
- `"input_text"`
@@ -2522,21 +2522,21 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `text: string`
- 引用文本内容。
+ 引用的文本内容。
- `type: "quoted_text"`
- 类型判别器,始终为 `quoted_text`.
+ 始终为的类型判别字段 `quoted_text`.
- `"quoted_text"`
- `created_at: number`
- 创建该项时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `inference_options: object { model, tool_choice } or null`
- 应用于消息的推理覆盖。未设置时默认为 null。
+ 应用于此消息的推理覆盖参数。未设置时默认为 null。
- `model: string or null`
@@ -2544,15 +2544,15 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `tool_choice: object { id } or null`
- 要调用的首选工具。当 ChatKit 应自动选择时默认为 null。
+ 首选调用的工具。在 ChatKit 应自动选择时默认为 null。
- `id: string`
- 请求的工具的标识符。
+ 所请求工具的标识符。
- `object: "chatkit.thread_item"`
- 始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2564,23 +2564,23 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `"chatkit.user_message"`
-### ChatKit 组件项
+### ChatKit Widget Item
- `ChatKitWidgetItem object { id, created_at, object, 3 more }`
- 渲染小组件负载的线程项。
+ 用于渲染小组件负载的线程项。
- `id: string`
- 线程项的标识符。
+ 线程条目的标识符。
- `created_at: number`
- 项创建时的 Unix 时间戳(秒)。
+ 条目创建时的 Unix 时间戳(以秒为单位)。
- `object: "chatkit.thread_item"`
- 类型判别符,始终为 `chatkit.thread_item`.
+ 始终为的类型判别字段 `chatkit.thread_item`.
- `"chatkit.thread_item"`
@@ -2590,19 +2590,19 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `type: "chatkit.widget"`
- 类型判别符,始终为 `chatkit.widget`.
+ 始终为的类型判别字段 `chatkit.widget`.
- `"chatkit.widget"`
- `widget: string`
- 在界面中渲染的序列化小组件负载。
+ 在 UI 中渲染的序列化小组件负载。
-### 线程删除响应
+### Thread Delete Response
- `ThreadDeleteResponse object { id, deleted, object }`
- 删除线程后返回的确认负载。
+ 删除 thread 后返回的确认负载。
- `id: string`
@@ -2610,10 +2610,10 @@ curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \
- `deleted: boolean`
- 指示该线程已被删除。
+ 表示该线程已被删除。
- `object: "chatkit.thread.deleted"`
- 类型判别器,始终为 `chatkit.thread.deleted`.
+ 始终为的类型判别字段 `chatkit.thread.deleted`.
- `"chatkit.thread.deleted"`
diff --git a/docs/zh/api/reference/resources/evals.md b/docs/zh/api/reference/resources/evals.md
index 63a1b02..b4fb3f5 100644
--- a/docs/zh/api/reference/resources/evals.md
+++ b/docs/zh/api/reference/resources/evals.md
@@ -1,51 +1,51 @@
-# 评估
+# Evals
-> 有关完整的文档索引,请参见 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获得。
+> 完整文档索引请参见 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 获取文档页面的 Markdown 版本。
-## 创建评估
+## Create eval
**post** `/evals`
-创建可用于测试模型性能的评估结构。
-评估是一组测试标准和数据源的配置,它决定了评估中所用数据的模式。创建评估后,你可以在不同的模型和模型参数上运行它。我们支持多种评分器和数据源。
-有关更多信息,请参阅 [评估指南](/docs/guides/evals).
+创建一个可用于测试模型表现的评估结构。
+评估是一组测试标准以及数据源的配置,它决定了评估中所使用数据的 schema。创建评估后,你可以在不同的模型和模型参数上运行它。我们支持多种评分器和数据源类型。
+更多信息,请参阅 [Evals guide](/docs/guides/evals).
-### 请求体参数
+### Body Parameters
- `data_source_config: object { item_schema, type, include_sample_schema } or object { type, metadata } or object { type, metadata }`
- 用于评估运行的数据源的配置。决定评估中使用的数据的模式。
+ 用于评估运行的数据源的配置。决定评估中使用的数据的 schema。
- `CustomDataSourceConfig object { item_schema, type, include_sample_schema }`
- 一个 CustomDataSourceConfig 对象,定义用于评估运行的数据源的模式。
- 该模式用于定义数据的形状,这些数据将:
+ 一个 CustomDataSourceConfig 对象,用于定义评估运行所用数据源的 schema。
+ 此 schema 用于定义以下数据的形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `item_schema: map[unknown]`
- 数据源中每一行的 JSON 模式。
+ 数据源中每一行的 json schema。
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `include_sample_schema: optional boolean`
- 评估是否应期望你填充样本命名空间(即,通过根据你的数据源生成响应)
+ eval 是否应期望你填充 sample 命名空间(即,基于你的数据源生成响应)
- `LogsDataSourceConfig object { type, metadata }`
- 一个数据源配置,指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
+ 一个数据源配置,指定你的日志查询的 metadata 属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
@@ -55,11 +55,11 @@
- `StoredCompletionsDataSourceConfig object { type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
@@ -69,16 +69,16 @@
- `testing_criteria: array of object { input, labels, model, 3 more } or StringCheckGrader or TextSimilarityGrader or 2 more`
- 此组中所有评估运行的评分器列表。评分器可以使用双花括号表示法引用数据源中的变量,例如 `{{item.variable_name}}`。要引用模型的输出,请使用 `sample` 命名空间(即, `{{sample.output_text}}`).
+ 此组中所有评估运行的评分器列表。评分器可以使用双花括号表示法引用数据源中的变量,例如 `{{item.variable_name}}`。若要引用模型的输出,请使用 `sample` 命名空间(即, `{{sample.output_text}}`).
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `SimpleInputMessage object { content, role }`
@@ -92,27 +92,27 @@
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -122,7 +122,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -132,11 +132,11 @@
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -146,21 +146,21 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -170,11 +170,11 @@
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -189,24 +189,24 @@
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -216,21 +216,21 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -238,7 +238,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -257,7 +257,7 @@
- `labels: array of string`
- 用于对评估中的每个项目进行分类的标签。
+ 用于对评估中每个项目进行分类的标签。
- `model: string`
@@ -269,7 +269,7 @@
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -279,11 +279,11 @@
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -291,7 +291,7 @@
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -303,7 +303,7 @@
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -313,7 +313,7 @@
- `TextSimilarity = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -321,7 +321,7 @@
- `Python = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -329,7 +329,7 @@
- `ScoreModel = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
@@ -337,108 +337,108 @@
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: optional string`
评估的名称。
-### 返回
+### Returns
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -453,30 +453,30 @@
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -486,7 +486,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -496,11 +496,11 @@
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -510,21 +510,21 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -534,11 +534,11 @@
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -553,24 +553,24 @@
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -580,21 +580,21 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -602,7 +602,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -621,7 +621,7 @@
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -633,7 +633,7 @@
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -643,11 +643,11 @@
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -655,7 +655,7 @@
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -667,7 +667,7 @@
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -677,7 +677,7 @@
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -685,7 +685,7 @@
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -693,7 +693,7 @@
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
@@ -887,13 +887,13 @@ curl https://api.openai.com/v1/evals \
**删除** `/evals/{eval_id}`
-删除一个评估。
+删除评测。
### 路径参数
- `eval_id: string`
-### 返回
+### Returns
- `deleted: boolean`
@@ -937,7 +937,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
}
```
-## 列出评估
+## 列出 evals
**get** `/evals`
@@ -947,15 +947,15 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `after: optional string`
- 上一个分页请求中最后一个评估的标识符。
+ 上一次分页请求中最后一条 eval 的标识符。
- `limit: optional number`
- 要检索的评估数量。
+ 要检索的 eval 数量。
- `order: optional "asc" or "desc"`
- 按时间戳对评估的排序顺序。使用 `asc` 表示升序或 `desc` 表示降序。
+ 按时间戳对 eval 排序的顺序。使用 `asc` 表示升序,或 `desc` 表示降序。
- `"asc"`
@@ -963,108 +963,108 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `order_by: optional "created_at" or "updated_at"`
- 评估可以按创建时间或最后更新时间排序。使用
- `created_at` 表示创建时间或 `updated_at` 表示最后更新时间。
+ eval 可以按创建时间或最后更新时间排序。使用
+ `created_at` 表示创建时间,或 `updated_at` 表示最后更新时间。
- `"created_at"`
- `"updated_at"`
-### 返回
+### Returns
- `data: array of object { id, created_at, data_source_config, 4 more }`
- 评估对象数组。
+ eval 对象数组。
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -1079,30 +1079,30 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -1112,7 +1112,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -1122,11 +1122,11 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -1136,21 +1136,21 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1160,11 +1160,11 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -1179,24 +1179,24 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -1206,21 +1206,21 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1228,7 +1228,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -1247,7 +1247,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -1259,7 +1259,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -1269,11 +1269,11 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -1281,7 +1281,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -1293,7 +1293,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -1303,7 +1303,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -1311,7 +1311,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -1319,7 +1319,7 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
@@ -1327,15 +1327,15 @@ curl https://api.openai.com/v1/evals/eval_abc123 \
- `first_id: string`
- 数据数组中第一个评估的标识符。
+ data 数组中第一条 eval 的标识符。
- `has_more: boolean`
- 指示是否还有更多评估可用。
+ 指示是否还有更多 eval 可用。
- `last_id: string`
- 数据数组中最后一个评估的标识符。
+ data 数组中最后一条 eval 的标识符。
- `object: "list"`
@@ -1487,103 +1487,103 @@ curl https://api.openai.com/v1/evals?limit=1 \
**get** `/evals/{eval_id}`
-按 ID 获取评估。
+通过 ID 获取评估。
### 路径参数
- `eval_id: string`
-### 返回
+### Returns
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -1598,30 +1598,30 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -1631,7 +1631,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -1641,11 +1641,11 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -1655,21 +1655,21 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1679,11 +1679,11 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -1698,24 +1698,24 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -1725,21 +1725,21 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1747,7 +1747,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -1766,7 +1766,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -1778,7 +1778,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -1788,11 +1788,11 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -1800,7 +1800,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -1812,7 +1812,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -1822,7 +1822,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -1830,7 +1830,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -1838,7 +1838,7 @@ curl https://api.openai.com/v1/evals?limit=1 \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
@@ -1947,7 +1947,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
}
```
-## 更新评估
+## 更新评测
**post** `/evals/{eval_id}`
@@ -1957,112 +1957,112 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `eval_id: string`
-### 请求体参数
+### Body Parameters
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: optional string`
重命名评估。
-### 返回
+### Returns
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -2077,30 +2077,30 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -2110,7 +2110,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -2120,11 +2120,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -2134,21 +2134,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2158,11 +2158,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -2177,24 +2177,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -2204,21 +2204,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2226,7 +2226,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -2245,7 +2245,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -2257,7 +2257,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -2267,11 +2267,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -2279,7 +2279,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -2291,7 +2291,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -2301,7 +2301,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -2309,7 +2309,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -2317,7 +2317,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
@@ -2429,109 +2429,109 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
}
```
-## 域类型
+## 域名类型
-### Eval 创建响应
+### 评估创建响应
- `EvalCreateResponse object { id, created_at, data_source_config, 4 more }`
- 一个带有数据源配置和测试标准的 Eval 对象。
- Eval 表示要为你的 LLM 集成完成的任务。
+ 一个包含数据源配置和测试标准的 Eval 对象。
+ Eval 代表需要为你的 LLM 集成完成的一项任务。
例如:
- - 提高我的聊天机器人的质量
- - 看看我的聊天机器人处理客户支持的效果如何
- - 检查 o4-mini 是否比 gpt-4o 更适合我的使用场景
+ - 提升我的聊天机器人质量
+ - 查看我的聊天机器人在客户支持方面的表现
+ - 检查 o4-mini 在我的用例上是否优于 gpt-5.6-sol
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -2546,30 +2546,30 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -2579,7 +2579,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -2589,11 +2589,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -2603,21 +2603,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2627,11 +2627,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -2646,24 +2646,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -2673,21 +2673,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2695,7 +2695,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -2714,7 +2714,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -2726,7 +2726,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -2736,11 +2736,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -2748,7 +2748,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -2760,7 +2760,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -2770,7 +2770,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -2778,7 +2778,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -2786,34 +2786,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
分数的阈值。
-### 评估自定义数据源配置
+### Eval 自定义数据源配置
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
-### 评估删除响应
+### Eval 删除响应
- `EvalDeleteResponse object { deleted, eval_id, object }`
@@ -2823,107 +2823,107 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `object: string`
-### 评估列表响应
+### Eval 列表响应
- `EvalListResponse object { id, created_at, data_source_config, 4 more }`
- 一个带有数据源配置和测试标准的 Eval 对象。
- Eval 表示要为你的 LLM 集成完成的任务。
+ 一个包含数据源配置和测试标准的 Eval 对象。
+ Eval 代表需要为你的 LLM 集成完成的一项任务。
例如:
- - 提高我的聊天机器人的质量
- - 看看我的聊天机器人处理客户支持的效果如何
- - 检查 o4-mini 是否比 gpt-4o 更适合我的使用场景
+ - 提升我的聊天机器人质量
+ - 查看我的聊天机器人在客户支持方面的表现
+ - 检查 o4-mini 在我的用例上是否优于 gpt-5.6-sol
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -2938,30 +2938,30 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -2971,7 +2971,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -2981,11 +2981,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -2995,21 +2995,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3019,11 +3019,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -3038,24 +3038,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -3065,21 +3065,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3087,7 +3087,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -3106,7 +3106,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -3118,7 +3118,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -3128,11 +3128,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -3140,7 +3140,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -3152,7 +3152,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -3162,7 +3162,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -3170,7 +3170,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -3178,113 +3178,113 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
分数的阈值。
-### 评估检索响应
+### Eval 检索响应
- `EvalRetrieveResponse object { id, created_at, data_source_config, 4 more }`
- 一个带有数据源配置和测试标准的 Eval 对象。
- Eval 表示要为你的 LLM 集成完成的任务。
+ 一个包含数据源配置和测试标准的 Eval 对象。
+ Eval 代表需要为你的 LLM 集成完成的一项任务。
例如:
- - 提高我的聊天机器人的质量
- - 看看我的聊天机器人处理客户支持的效果如何
- - 检查 o4-mini 是否比 gpt-4o 更适合我的使用场景
+ - 提升我的聊天机器人质量
+ - 查看我的聊天机器人在客户支持方面的表现
+ - 检查 o4-mini 在我的用例上是否优于 gpt-5.6-sol
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -3299,30 +3299,30 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -3332,7 +3332,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -3342,11 +3342,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -3356,21 +3356,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3380,11 +3380,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -3399,24 +3399,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -3426,21 +3426,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3448,7 +3448,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -3467,7 +3467,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -3479,7 +3479,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -3489,11 +3489,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -3501,7 +3501,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -3513,7 +3513,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -3523,7 +3523,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -3531,7 +3531,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -3539,139 +3539,139 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
分数的阈值。
-### 评估存储补全数据源配置
+### Eval 已存储补全数据源配置
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
-### 评估更新响应
+### Eval 更新响应
- `EvalUpdateResponse object { id, created_at, data_source_config, 4 more }`
- 一个带有数据源配置和测试标准的 Eval 对象。
- Eval 表示要为你的 LLM 集成完成的任务。
+ 一个包含数据源配置和测试标准的 Eval 对象。
+ Eval 代表需要为你的 LLM 集成完成的一项任务。
例如:
- - 提高我的聊天机器人的质量
- - 看看我的聊天机器人处理客户支持的效果如何
- - 检查 o4-mini 是否比 gpt-4o 更适合我的使用场景
+ - 提升我的聊天机器人质量
+ - 查看我的聊天机器人在客户支持方面的表现
+ - 检查 o4-mini 在我的用例上是否优于 gpt-5.6-sol
- `id: string`
- 评估的唯一标识符。
+ 评估任务的唯一标识符。
- `created_at: number`
- 评估创建时的 Unix 时间戳(秒)。
+ 评估任务创建时的 Unix 时间戳(以秒为单位)。
- `data_source_config: EvalCustomDataSourceConfig or object { schema, type, metadata } or EvalStoredCompletionsDataSourceConfig`
- 评估运行中使用的数据源配置。
+ 用于评估运行的数据源配置。
- `EvalCustomDataSourceConfig object { schema, type }`
- 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选地 `sample` 命名空间。
- 响应模式定义了数据的形状,数据将被:
+ 一个 CustomDataSourceConfig,用于指定你的 `item` 以及可选的 `sample` 命名空间。
+ 响应架构定义了数据的以下形状:
- - 用于定义你的测试标准,并且
- - 创建运行所需的数据
+ - 用于定义你的测试标准,以及
+ - 创建运行 (run) 时所需的数据
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "custom"`
- 数据源的类型。始终是 `custom`.
+ 数据源的类型。始终为 `custom`.
- `"custom"`
- `LogsDataSourceConfig object { schema, type, metadata }`
- 一个 LogsDataSourceConfig,用于指定你的日志查询的元数据属性。
- 这通常是这样的一些元数据,例如 `usecase=chatbot` 或 `prompt-version=v2`,等。
- 此数据源配置返回的模式用于定义评估中可用的变量。
- `item` 和 `sample` 在使用此数据源配置时,两者均被定义。
+ 一个 LogsDataSourceConfig,用于指定日志查询的元数据属性。
+ 这通常是类似 `usecase=chatbot` 或 `prompt-version=v2`,等元数据。
+ 此数据源配置返回的架构用于定义评估中可用的变量。
+ `item` 和 `sample` 在使用此数据源配置时均会被定义。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "logs"`
- 数据源的类型。始终是 `logs`.
+ 数据源的类型。始终为 `logs`.
- `"logs"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `EvalStoredCompletionsDataSourceConfig object { schema, type, metadata }`
- 已弃用,改用 LogsDataSourceConfig。
+ 已弃用,建议改用 LogsDataSourceConfig。
- `schema: map[unknown]`
- 运行数据源项目的 JSON 模式。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 运行数据源条目的 json 架构。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "stored_completions"`
- 数据源的类型。始终是 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: string`
@@ -3686,30 +3686,30 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `testing_criteria: array of LabelModelGrader or StringCheckGrader or TextSimilarityGrader or 2 more`
- 测试标准列表。
+ 测试条件列表。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,使用模型为评估中的每个项目分配标签
+ 一个 LabelModelGrader 对象,使用模型为评估中的每一项分配标签
。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -3719,7 +3719,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -3729,11 +3729,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -3743,21 +3743,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3767,11 +3767,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -3786,24 +3786,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -3813,21 +3813,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3835,7 +3835,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -3854,7 +3854,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要分配给评估中每个条目标签。
- `model: string`
@@ -3866,7 +3866,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -3876,11 +3876,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,使用指定操作对输入和参考文本执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入和参考之间进行字符串比较。
- `input: string`
- 输入文本。可能包含模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -3888,7 +3888,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。可选值: `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`、或 `ilike`.
- `"eq"`
@@ -3900,7 +3900,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reference: string`
- 参考文本。可能包含模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -3910,7 +3910,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `TextSimilarityGrader = TextSimilarityGrader`
- 一个 TextSimilarityGrader 对象,根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `pass_threshold: number`
@@ -3918,7 +3918,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `PythonGrader = PythonGrader`
- 一个 PythonGrader 对象,对输入运行 Python 脚本。
+ 一个 PythonGrader 对象,对输入运行 python 脚本。
- `pass_threshold: optional number`
@@ -3926,7 +3926,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ScoreModelGrader = ScoreModelGrader`
- 一个 ScoreModelGrader 对象,使用模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `pass_threshold: optional number`
@@ -3934,7 +3934,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
# 运行
-## 取消评估运行
+## 取消 eval 运行
**post** `/evals/{eval_id}/runs/{run_id}`
@@ -3946,27 +3946,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `run_id: string`
-### 返回
+### Returns
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -3980,7 +3980,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -3992,23 +3992,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -4022,7 +4022,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -4034,44 +4034,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -4081,43 +4081,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -4127,7 +4127,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -4141,7 +4141,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -4163,11 +4163,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -4187,7 +4187,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -4197,7 +4197,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -4213,7 +4213,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -4223,7 +4223,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -4236,9 +4236,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -4252,31 +4252,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -4286,21 +4286,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -4310,11 +4310,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -4329,24 +4329,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -4356,21 +4356,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -4378,7 +4378,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -4405,7 +4405,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -4415,7 +4415,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -4425,13 +4425,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -4449,20 +4449,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -4472,34 +4472,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -4510,10 +4510,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -4523,53 +4523,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -4583,7 +4583,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -4595,13 +4595,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -4611,49 +4611,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -4663,13 +4663,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -4683,31 +4683,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -4717,21 +4717,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -4739,12 +4739,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -4771,7 +4771,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -4781,7 +4781,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -4791,64 +4791,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -4858,42 +4858,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -4901,11 +4901,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -4923,54 +4923,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -4990,7 +4990,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -5006,15 +5006,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -5028,27 +5028,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -5056,29 +5056,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -5096,18 +5096,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -5115,22 +5115,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -5152,7 +5152,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -5160,14 +5160,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -5189,48 +5189,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -5250,12 +5250,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -5264,41 +5264,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -5311,23 +5311,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -5335,17 +5335,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -5367,7 +5367,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -5375,33 +5375,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -5417,7 +5417,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -5427,13 +5427,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -5443,11 +5443,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5457,7 +5457,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -5465,31 +5465,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -5504,7 +5504,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -5516,8 +5516,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -5527,12 +5527,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -5544,13 +5544,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -5562,7 +5562,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -5572,7 +5572,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -5594,13 +5594,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -5624,7 +5624,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -5674,7 +5674,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -5688,7 +5688,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -5700,7 +5700,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -5716,7 +5716,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -5724,7 +5724,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -5738,7 +5738,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -5750,11 +5750,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -5768,7 +5768,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -5776,21 +5776,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -5814,23 +5814,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -5838,7 +5838,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -5852,7 +5852,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -5864,27 +5864,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -5892,15 +5892,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -5914,7 +5914,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -5924,11 +5924,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -5942,7 +5942,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -5950,11 +5950,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -5968,11 +5968,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -5984,20 +5984,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -6005,21 +6005,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -6031,31 +6031,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -6063,11 +6063,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -6168,8 +6168,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
"eval_id": "eval_67abd54d9b0081909a86353f6fb9317a",
"report_url": "https://platform.openai.com/evaluations/eval_67abd54d9b0081909a86353f6fb9317a?run_id=evalrun_67abd54d60ec8190832b46859da808f7",
"status": "canceled",
- "model": "gpt-4o-mini",
- "name": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
+ "name": "gpt-5.6-sol",
"created_at": 1743092069,
"result_counts": {
"total": 0,
@@ -6297,11 +6297,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
}
]
},
- "model": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
"sampling_params": {
- "seed": 42,
- "temperature": 1.0,
- "top_p": 1.0,
"max_completions_tokens": 2048
}
},
@@ -6314,25 +6311,25 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
**post** `/evals/{eval_id}/runs`
-为给定评估启动新的运行,指定数据源以及用于测试的模型配置。数据源将根据评估配置中指定的模式进行验证。
+为给定的评估启动一次新的运行,指定数据源以及要使用的模型配置以进行测试。数据源将根据评估配置中指定的 schema 进行校验。
### 路径参数
- `eval_id: string`
-### 请求体参数
+### Body Parameters
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 关于运行数据源的详细信息。
+ 运行数据源的详细信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -6346,7 +6343,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -6358,23 +6355,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -6388,7 +6385,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -6400,44 +6397,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -6447,43 +6444,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -6493,7 +6490,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -6507,7 +6504,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -6529,11 +6526,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -6553,7 +6550,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -6563,7 +6560,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -6579,7 +6576,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -6589,7 +6586,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -6602,9 +6599,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -6618,31 +6615,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -6652,21 +6649,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -6676,11 +6673,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -6695,24 +6692,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -6722,21 +6719,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -6744,7 +6741,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -6771,7 +6768,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -6781,7 +6778,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -6791,13 +6788,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -6815,20 +6812,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -6838,34 +6835,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -6876,10 +6873,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -6889,53 +6886,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -6949,7 +6946,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -6961,13 +6958,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -6977,49 +6974,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -7029,13 +7026,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -7049,31 +7046,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -7083,21 +7080,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -7105,12 +7102,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -7137,7 +7134,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -7147,7 +7144,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -7157,64 +7154,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -7224,42 +7221,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -7267,11 +7264,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -7289,54 +7286,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -7356,7 +7353,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -7372,15 +7369,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -7394,27 +7391,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -7422,29 +7419,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -7462,18 +7459,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -7481,22 +7478,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -7518,7 +7515,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -7526,14 +7523,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -7555,48 +7552,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -7616,12 +7613,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -7630,41 +7627,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -7677,23 +7674,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -7701,17 +7698,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -7733,7 +7730,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -7741,33 +7738,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -7783,7 +7780,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -7793,13 +7790,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -7809,11 +7806,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -7823,7 +7820,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -7831,31 +7828,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -7870,7 +7867,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -7882,8 +7879,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -7893,12 +7890,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -7910,13 +7907,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -7928,7 +7925,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -7938,7 +7935,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -7960,13 +7957,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -7990,7 +7987,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -8040,7 +8037,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -8054,7 +8051,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -8066,7 +8063,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -8082,7 +8079,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8090,7 +8087,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -8104,7 +8101,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -8116,11 +8113,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -8134,7 +8131,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -8142,21 +8139,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -8180,23 +8177,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8204,7 +8201,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -8218,7 +8215,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -8230,27 +8227,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -8258,15 +8255,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -8280,7 +8277,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -8290,11 +8287,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -8308,7 +8305,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -8316,11 +8313,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -8334,42 +8331,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `name: optional string`
运行的名称。
-### 返回
+### Returns
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -8383,7 +8380,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -8395,23 +8392,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -8425,7 +8422,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -8437,44 +8434,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -8484,43 +8481,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -8530,7 +8527,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -8544,7 +8541,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -8566,11 +8563,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -8590,7 +8587,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -8600,7 +8597,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -8616,7 +8613,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -8626,7 +8623,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -8639,9 +8636,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -8655,31 +8652,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -8689,21 +8686,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -8713,11 +8710,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -8732,24 +8729,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -8759,21 +8756,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -8781,7 +8778,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -8808,7 +8805,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -8818,7 +8815,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -8828,13 +8825,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -8852,20 +8849,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -8875,34 +8872,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -8913,10 +8910,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -8926,53 +8923,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -8986,7 +8983,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -8998,13 +8995,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -9014,49 +9011,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -9066,13 +9063,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -9086,31 +9083,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -9120,21 +9117,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -9142,12 +9139,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -9174,7 +9171,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -9184,7 +9181,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -9194,64 +9191,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -9261,42 +9258,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -9304,11 +9301,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -9326,54 +9323,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -9393,7 +9390,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -9409,15 +9406,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -9431,27 +9428,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -9459,29 +9456,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -9499,18 +9496,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -9518,22 +9515,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -9555,7 +9552,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -9563,14 +9560,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -9592,48 +9589,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -9653,12 +9650,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -9667,41 +9664,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -9714,23 +9711,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -9738,17 +9735,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -9770,7 +9767,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -9778,33 +9775,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -9820,7 +9817,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -9830,13 +9827,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -9846,11 +9843,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -9860,7 +9857,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -9868,31 +9865,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -9907,7 +9904,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -9919,8 +9916,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -9930,12 +9927,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -9947,13 +9944,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -9965,7 +9962,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -9975,7 +9972,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -9997,13 +9994,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -10027,7 +10024,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -10077,7 +10074,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -10091,7 +10088,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -10103,7 +10100,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -10119,7 +10116,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -10127,7 +10124,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -10141,7 +10138,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -10153,11 +10150,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -10171,7 +10168,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -10179,21 +10176,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -10217,23 +10214,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -10241,7 +10238,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -10255,7 +10252,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -10267,27 +10264,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -10295,15 +10292,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -10317,7 +10314,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -10327,11 +10324,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -10345,7 +10342,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -10353,11 +10350,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -10371,11 +10368,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -10387,20 +10384,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -10408,21 +10405,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -10434,31 +10431,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -10466,11 +10463,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -10575,7 +10572,7 @@ curl https://api.openai.com/v1/evals/eval_67e579652b548190aaa83ada4b125f47/runs
-X POST \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-H "Content-Type: application/json" \
- -d '{"name":"gpt-4o-mini","data_source":{"type":"completions","input_messages":{"type":"template","template":[{"role":"developer","content":"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\n\n# Steps\n\n1. Analyze the content of the news headline to understand its primary focus.\n2. Extract the subject matter, identifying any key indicators or keywords.\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\n4. Ensure only one category is selected per headline.\n\n# Output Format\n\nRespond with the chosen category as a single word. For instance: \"Technology\", \"Markets\", \"World\", \"Business\", or \"Sports\".\n\n# Examples\n\n**Input**: \"Apple Unveils New iPhone Model, Featuring Advanced AI Features\" \n**Output**: \"Technology\"\n\n**Input**: \"Global Stocks Mixed as Investors Await Central Bank Decisions\" \n**Output**: \"Markets\"\n\n**Input**: \"War in Ukraine: Latest Updates on Negotiation Status\" \n**Output**: \"World\"\n\n**Input**: \"Microsoft in Talks to Acquire Gaming Company for $2 Billion\" \n**Output**: \"Business\"\n\n**Input**: \"Manchester United Secures Win in Premier League Football Match\" \n**Output**: \"Sports\" \n\n# Notes\n\n- If the headline appears to fit into more than one category, choose the most dominant theme.\n- Keywords or phrases such as \"stocks\", \"company acquisition\", \"match\", or technological brands can be good indicators for classification.\n"} , {"role":"user","content":"{{item.input}}"}]} ,"sampling_params":{"temperature":1,"max_completions_tokens":2048,"top_p":1,"seed":42},"model":"gpt-4o-mini","source":{"type":"file_content","content":[{"item":{"input":"Tech Company Launches Advanced Artificial Intelligence Platform","ground_truth":"Technology"}}]}}'
+ -d '{"name":"gpt-5.6-sol","data_source":{"type":"completions","input_messages":{"type":"template","template":[{"role":"developer","content":"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\n\n# Steps\n\n1. Analyze the content of the news headline to understand its primary focus.\n2. Extract the subject matter, identifying any key indicators or keywords.\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\n4. Ensure only one category is selected per headline.\n\n# Output Format\n\nRespond with the chosen category as a single word. For instance: \"Technology\", \"Markets\", \"World\", \"Business\", or \"Sports\".\n\n# Examples\n\n**Input**: \"Apple Unveils New iPhone Model, Featuring Advanced AI Features\" \n**Output**: \"Technology\"\n\n**Input**: \"Global Stocks Mixed as Investors Await Central Bank Decisions\" \n**Output**: \"Markets\"\n\n**Input**: \"War in Ukraine: Latest Updates on Negotiation Status\" \n**Output**: \"World\"\n\n**Input**: \"Microsoft in Talks to Acquire Gaming Company for $2 Billion\" \n**Output**: \"Business\"\n\n**Input**: \"Manchester United Secures Win in Premier League Football Match\" \n**Output**: \"Sports\" \n\n# Notes\n\n- If the headline appears to fit into more than one category, choose the most dominant theme.\n- Keywords or phrases such as \"stocks\", \"company acquisition\", \"match\", or technological brands can be good indicators for classification.\n"} , {"role":"user","content":"{{item.input}}"}]} ,"sampling_params":{"max_completions_tokens":2048},"model":"gpt-5.6-sol","source":{"type":"file_content","content":[{"item":{"input":"Tech Company Launches Advanced Artificial Intelligence Platform","ground_truth":"Technology"}}]}}}'
```
#### 响应
@@ -10587,8 +10584,8 @@ curl https://api.openai.com/v1/evals/eval_67e579652b548190aaa83ada4b125f47/runs
"eval_id": "eval_67e579652b548190aaa83ada4b125f47",
"report_url": "https://platform.openai.com/evaluations/eval_67e579652b548190aaa83ada4b125f47&run_id=evalrun_67e57965b480819094274e3a32235e4c",
"status": "queued",
- "model": "gpt-4o-mini",
- "name": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
+ "name": "gpt-5.6-sol",
"created_at": 1743092069,
"result_counts": {
"total": 0,
@@ -10632,11 +10629,8 @@ curl https://api.openai.com/v1/evals/eval_67e579652b548190aaa83ada4b125f47/runs
}
]
},
- "model": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
"sampling_params": {
- "seed": 42,
- "temperature": 1.0,
- "top_p": 1.0,
"max_completions_tokens": 2048
}
},
@@ -10649,7 +10643,7 @@ curl https://api.openai.com/v1/evals/eval_67e579652b548190aaa83ada4b125f47/runs
**删除** `/evals/{eval_id}/runs/{run_id}`
-删除一次评估运行。
+删除评测运行。
### 路径参数
@@ -10657,7 +10651,7 @@ curl https://api.openai.com/v1/evals/eval_67e579652b548190aaa83ada4b125f47/runs
- `run_id: string`
-### 返回
+### Returns
- `deleted: optional boolean`
@@ -10702,7 +10696,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
}
```
-## 获取评估运行
+## 获取评估运行列表
**get** `/evals/{eval_id}/runs`
@@ -10724,7 +10718,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `order: optional "asc" or "desc"`
- 按时间戳对运行进行排序的顺序。使用 `asc` 表示升序或 `desc` 表示降序。默认为 `asc`.
+ 按时间戳排序运行的方向。使用 `asc` 表示升序,或 `desc` 表示降序。默认为 `asc`.
- `"asc"`
@@ -10732,7 +10726,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `status: optional "queued" or "in_progress" or "completed" or 2 more`
- 按状态筛选运行。可选值为 `queued` | `in_progress` | `failed` | `completed` | `canceled`.
+ 按状态过滤运行。可选值之一 `queued` | `in_progress` | `failed` | `completed` | `canceled`.
- `"queued"`
@@ -10744,31 +10738,31 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `"failed"`
-### 返回
+### Returns
- `data: array of object { id, created_at, data_source, 11 more }`
- 评估运行对象的数组。
+ 一个由评估运行对象组成的数组。
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -10782,7 +10776,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -10794,23 +10788,23 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -10824,7 +10818,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -10836,44 +10830,44 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -10883,43 +10877,43 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -10929,7 +10923,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -10943,7 +10937,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -10965,11 +10959,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -10989,7 +10983,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -10999,7 +10993,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -11015,7 +11009,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -11025,7 +11019,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -11038,9 +11032,9 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -11054,31 +11048,31 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -11088,21 +11082,21 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -11112,11 +11106,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -11131,24 +11125,24 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -11158,21 +11152,21 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -11180,7 +11174,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -11207,7 +11201,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -11217,7 +11211,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -11227,13 +11221,13 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -11251,20 +11245,20 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -11274,34 +11268,34 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -11312,10 +11306,10 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -11325,53 +11319,53 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -11385,7 +11379,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -11397,13 +11391,13 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -11413,49 +11407,49 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -11465,13 +11459,13 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -11485,31 +11479,31 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -11519,21 +11513,21 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -11541,12 +11535,12 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -11573,7 +11567,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -11583,7 +11577,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -11593,64 +11587,64 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -11660,42 +11654,42 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -11703,11 +11697,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -11725,54 +11719,54 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -11792,7 +11786,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -11808,15 +11802,15 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -11830,27 +11824,27 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -11858,29 +11852,29 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -11898,18 +11892,18 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -11917,22 +11911,22 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -11954,7 +11948,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -11962,14 +11956,14 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -11991,48 +11985,48 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -12052,12 +12046,12 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -12066,41 +12060,41 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -12113,23 +12107,23 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -12137,17 +12131,17 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -12169,7 +12163,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -12177,33 +12171,33 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -12219,7 +12213,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -12229,13 +12223,13 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -12245,11 +12239,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -12259,7 +12253,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -12267,31 +12261,31 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -12306,7 +12300,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -12318,8 +12312,8 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -12329,12 +12323,12 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -12346,13 +12340,13 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -12364,7 +12358,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -12374,7 +12368,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -12396,13 +12390,13 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -12426,7 +12420,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -12476,7 +12470,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -12490,7 +12484,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -12502,7 +12496,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -12518,7 +12512,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -12526,7 +12520,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -12540,7 +12534,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -12552,11 +12546,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -12570,7 +12564,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -12578,21 +12572,21 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -12616,23 +12610,23 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -12640,7 +12634,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -12654,7 +12648,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -12666,27 +12660,27 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -12694,15 +12688,15 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -12716,7 +12710,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -12726,11 +12720,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -12744,7 +12738,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -12752,11 +12746,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -12770,11 +12764,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -12786,20 +12780,20 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -12807,21 +12801,21 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -12833,31 +12827,31 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -12865,11 +12859,11 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -12889,7 +12883,7 @@ curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \
- `has_more: boolean`
- 指示是否还有更多评估可用。
+ 指示是否还有更多 eval 可用。
- `last_id: string`
@@ -13069,11 +13063,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
}
```
-## 获取一次评估运行
+## 获取评估运行
**get** `/evals/{eval_id}/runs/{run_id}`
-按 ID 获取一次评估运行。
+通过 ID 获取评估运行。
### 路径参数
@@ -13081,27 +13075,27 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `run_id: string`
-### 返回
+### Returns
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -13115,7 +13109,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -13127,23 +13121,23 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -13157,7 +13151,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -13169,44 +13163,44 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -13216,43 +13210,43 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -13262,7 +13256,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -13276,7 +13270,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -13298,11 +13292,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -13322,7 +13316,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -13332,7 +13326,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -13348,7 +13342,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -13358,7 +13352,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -13371,9 +13365,9 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -13387,31 +13381,31 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -13421,21 +13415,21 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -13445,11 +13439,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -13464,24 +13458,24 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -13491,21 +13485,21 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -13513,7 +13507,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -13540,7 +13534,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -13550,7 +13544,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -13560,13 +13554,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -13584,20 +13578,20 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -13607,34 +13601,34 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -13645,10 +13639,10 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -13658,53 +13652,53 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -13718,7 +13712,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -13730,13 +13724,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -13746,49 +13740,49 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -13798,13 +13792,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -13818,31 +13812,31 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -13852,21 +13846,21 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -13874,12 +13868,12 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -13906,7 +13900,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -13916,7 +13910,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -13926,64 +13920,64 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -13993,42 +13987,42 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -14036,11 +14030,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -14058,54 +14052,54 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -14125,7 +14119,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -14141,15 +14135,15 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -14163,27 +14157,27 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -14191,29 +14185,29 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -14231,18 +14225,18 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -14250,22 +14244,22 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -14287,7 +14281,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -14295,14 +14289,14 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -14324,48 +14318,48 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -14385,12 +14379,12 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -14399,41 +14393,41 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -14446,23 +14440,23 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -14470,17 +14464,17 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -14502,7 +14496,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -14510,33 +14504,33 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -14552,7 +14546,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -14562,13 +14556,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -14578,11 +14572,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -14592,7 +14586,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -14600,31 +14594,31 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -14639,7 +14633,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -14651,8 +14645,8 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -14662,12 +14656,12 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -14679,13 +14673,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -14697,7 +14691,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -14707,7 +14701,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -14729,13 +14723,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -14759,7 +14753,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -14809,7 +14803,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -14823,7 +14817,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -14835,7 +14829,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -14851,7 +14845,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -14859,7 +14853,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -14873,7 +14867,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -14885,11 +14879,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -14903,7 +14897,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -14911,21 +14905,21 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -14949,23 +14943,23 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -14973,7 +14967,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -14987,7 +14981,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -14999,27 +14993,27 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -15027,15 +15021,15 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -15049,7 +15043,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -15059,11 +15053,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -15077,7 +15071,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -15085,11 +15079,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -15103,11 +15097,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -15119,20 +15113,20 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -15140,21 +15134,21 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -15166,31 +15160,31 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -15198,11 +15192,11 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -15301,8 +15295,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
"eval_id": "eval_67abd54d9b0081909a86353f6fb9317a",
"report_url": "https://platform.openai.com/evaluations/eval_67abd54d9b0081909a86353f6fb9317a?run_id=evalrun_67abd54d60ec8190832b46859da808f7",
"status": "queued",
- "model": "gpt-4o-mini",
- "name": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
+ "name": "gpt-5.6-sol",
"created_at": 1743092069,
"result_counts": {
"total": 0,
@@ -15430,11 +15424,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
}
]
},
- "model": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
"sampling_params": {
- "seed": 42,
- "temperature": 1.0,
- "top_p": 1.0,
"max_completions_tokens": 2048
}
},
@@ -15443,17 +15434,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
}
```
-## 域类型
+## 域名类型
-### 创建评估补全运行数据源
+### 创建 Eval Completions 运行数据源
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -15467,7 +15458,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -15479,44 +15470,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -15526,43 +15517,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -15572,7 +15563,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -15586,7 +15577,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -15608,11 +15599,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -15632,7 +15623,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -15642,7 +15633,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -15658,7 +15649,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -15668,7 +15659,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -15681,9 +15672,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -15697,31 +15688,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -15731,21 +15722,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -15755,11 +15746,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -15774,24 +15765,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -15801,21 +15792,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -15823,7 +15814,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -15850,7 +15841,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -15860,7 +15851,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -15870,13 +15861,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -15894,20 +15885,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -15917,34 +15908,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -15955,10 +15946,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -15968,55 +15959,55 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
-### 创建评估 JSONL 运行数据源
+### 创建 Eval JSONL 运行数据源
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -16030,7 +16021,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -16042,21 +16033,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
-### 评估 API 错误
+### Eval API 错误
- `EvalAPIError object { code, message }`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -16070,27 +16061,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `RunCancelResponse object { id, created_at, data_source, 11 more }`
- 表示一次评估运行的架构。
+ 表示评估运行结果的架构。
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -16104,7 +16095,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -16116,23 +16107,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -16146,7 +16137,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -16158,44 +16149,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -16205,43 +16196,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -16251,7 +16242,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -16265,7 +16256,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -16287,11 +16278,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -16311,7 +16302,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -16321,7 +16312,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -16337,7 +16328,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -16347,7 +16338,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -16360,9 +16351,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -16376,31 +16367,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -16410,21 +16401,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -16434,11 +16425,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -16453,24 +16444,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -16480,21 +16471,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -16502,7 +16493,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -16529,7 +16520,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -16539,7 +16530,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -16549,13 +16540,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -16573,20 +16564,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -16596,34 +16587,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -16634,10 +16625,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -16647,53 +16638,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -16707,7 +16698,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -16719,13 +16710,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -16735,49 +16726,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -16787,13 +16778,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -16807,31 +16798,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -16841,21 +16832,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -16863,12 +16854,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -16895,7 +16886,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -16905,7 +16896,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -16915,64 +16906,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -16982,42 +16973,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -17025,11 +17016,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -17047,54 +17038,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -17114,7 +17105,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -17130,15 +17121,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -17152,27 +17143,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -17180,29 +17171,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -17220,18 +17211,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -17239,22 +17230,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -17276,7 +17267,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -17284,14 +17275,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -17313,48 +17304,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -17374,12 +17365,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -17388,41 +17379,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -17435,23 +17426,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -17459,17 +17450,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -17491,7 +17482,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -17499,33 +17490,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -17541,7 +17532,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -17551,13 +17542,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -17567,11 +17558,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -17581,7 +17572,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -17589,31 +17580,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -17628,7 +17619,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -17640,8 +17631,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -17651,12 +17642,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -17668,13 +17659,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -17686,7 +17677,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -17696,7 +17687,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -17718,13 +17709,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -17748,7 +17739,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -17798,7 +17789,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -17812,7 +17803,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -17824,7 +17815,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -17840,7 +17831,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -17848,7 +17839,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -17862,7 +17853,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -17874,11 +17865,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -17892,7 +17883,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -17900,21 +17891,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -17938,23 +17929,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -17962,7 +17953,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -17976,7 +17967,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -17988,27 +17979,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -18016,15 +18007,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -18038,7 +18029,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -18048,11 +18039,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -18066,7 +18057,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -18074,11 +18065,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -18092,11 +18083,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -18108,20 +18099,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -18129,21 +18120,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -18155,31 +18146,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -18187,11 +18178,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -18205,31 +18196,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
评估运行的状态。
-### 运行创建响应
+### Run Create Response
- `RunCreateResponse object { id, created_at, data_source, 11 more }`
- 表示一次评估运行的架构。
+ 表示评估运行结果的架构。
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -18243,7 +18234,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -18255,23 +18246,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -18285,7 +18276,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -18297,44 +18288,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -18344,43 +18335,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -18390,7 +18381,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -18404,7 +18395,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -18426,11 +18417,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -18450,7 +18441,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -18460,7 +18451,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -18476,7 +18467,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -18486,7 +18477,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -18499,9 +18490,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -18515,31 +18506,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -18549,21 +18540,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -18573,11 +18564,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -18592,24 +18583,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -18619,21 +18610,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -18641,7 +18632,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -18668,7 +18659,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -18678,7 +18669,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -18688,13 +18679,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -18712,20 +18703,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -18735,34 +18726,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -18773,10 +18764,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -18786,53 +18777,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -18846,7 +18837,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -18858,13 +18849,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -18874,49 +18865,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -18926,13 +18917,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -18946,31 +18937,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -18980,21 +18971,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -19002,12 +18993,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -19034,7 +19025,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -19044,7 +19035,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -19054,64 +19045,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -19121,42 +19112,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -19164,11 +19155,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -19186,54 +19177,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -19253,7 +19244,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -19269,15 +19260,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -19291,27 +19282,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -19319,29 +19310,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -19359,18 +19350,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -19378,22 +19369,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -19415,7 +19406,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -19423,14 +19414,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -19452,48 +19443,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -19513,12 +19504,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -19527,41 +19518,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -19574,23 +19565,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -19598,17 +19589,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -19630,7 +19621,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -19638,33 +19629,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -19680,7 +19671,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -19690,13 +19681,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -19706,11 +19697,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -19720,7 +19711,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -19728,31 +19719,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -19767,7 +19758,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -19779,8 +19770,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -19790,12 +19781,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -19807,13 +19798,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -19825,7 +19816,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -19835,7 +19826,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -19857,13 +19848,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -19887,7 +19878,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -19937,7 +19928,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -19951,7 +19942,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -19963,7 +19954,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -19979,7 +19970,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -19987,7 +19978,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -20001,7 +19992,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -20013,11 +20004,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -20031,7 +20022,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -20039,21 +20030,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -20077,23 +20068,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -20101,7 +20092,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -20115,7 +20106,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -20127,27 +20118,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -20155,15 +20146,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -20177,7 +20168,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -20187,11 +20178,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -20205,7 +20196,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -20213,11 +20204,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -20231,11 +20222,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -20247,20 +20238,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -20268,21 +20259,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -20294,31 +20285,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -20326,11 +20317,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -20344,7 +20335,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
评估运行的状态。
-### 运行删除响应
+### Run Delete Response
- `RunDeleteResponse object { deleted, object, run_id }`
@@ -20354,31 +20345,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `run_id: optional string`
-### 运行列表响应
+### Run List Response
- `RunListResponse object { id, created_at, data_source, 11 more }`
- 表示一次评估运行的架构。
+ 表示评估运行结果的架构。
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -20392,7 +20383,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -20404,23 +20395,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -20434,7 +20425,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -20446,44 +20437,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -20493,43 +20484,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -20539,7 +20530,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -20553,7 +20544,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -20575,11 +20566,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -20599,7 +20590,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -20609,7 +20600,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -20625,7 +20616,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -20635,7 +20626,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -20648,9 +20639,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -20664,31 +20655,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -20698,21 +20689,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -20722,11 +20713,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -20741,24 +20732,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -20768,21 +20759,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -20790,7 +20781,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -20817,7 +20808,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -20827,7 +20818,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -20837,13 +20828,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -20861,20 +20852,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -20884,34 +20875,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -20922,10 +20913,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -20935,53 +20926,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -20995,7 +20986,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -21007,13 +20998,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -21023,49 +21014,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -21075,13 +21066,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -21095,31 +21086,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -21129,21 +21120,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -21151,12 +21142,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -21183,7 +21174,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -21193,7 +21184,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -21203,64 +21194,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -21270,42 +21261,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -21313,11 +21304,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -21335,54 +21326,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -21402,7 +21393,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -21418,15 +21409,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -21440,27 +21431,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -21468,29 +21459,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -21508,18 +21499,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -21527,22 +21518,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -21564,7 +21555,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -21572,14 +21563,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -21601,48 +21592,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -21662,12 +21653,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -21676,41 +21667,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -21723,23 +21714,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -21747,17 +21738,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -21779,7 +21770,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -21787,33 +21778,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -21829,7 +21820,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -21839,13 +21830,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -21855,11 +21846,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -21869,7 +21860,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -21877,31 +21868,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -21916,7 +21907,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -21928,8 +21919,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -21939,12 +21930,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -21956,13 +21947,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -21974,7 +21965,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -21984,7 +21975,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -22006,13 +21997,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -22036,7 +22027,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -22086,7 +22077,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -22100,7 +22091,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -22112,7 +22103,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -22128,7 +22119,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -22136,7 +22127,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -22150,7 +22141,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -22162,11 +22153,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -22180,7 +22171,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -22188,21 +22179,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -22226,23 +22217,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -22250,7 +22241,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -22264,7 +22255,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -22276,27 +22267,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -22304,15 +22295,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -22326,7 +22317,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -22336,11 +22327,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -22354,7 +22345,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -22362,11 +22353,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -22380,11 +22371,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -22396,20 +22387,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -22417,21 +22408,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -22443,31 +22434,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -22475,11 +22466,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -22493,31 +22484,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
评估运行的状态。
-### 运行检索响应
+### Run Retrieve Response
- `RunRetrieveResponse object { id, created_at, data_source, 11 more }`
- 表示一次评估运行的架构。
+ 表示评估运行结果的架构。
- `id: string`
- 评估运行的唯一标识符。
+ 评估运行(evaluation run)的唯一标识符。
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 有关运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定一个 JSONL 文件,该文件与评估
+ 一个 JsonlRunDataSource 对象,用于指定与该评估匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定什么填充 `item` 数据源中的命名空间。
+ 决定数据源中如何填充 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -22531,7 +22522,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -22543,23 +22534,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `type: "jsonl"`
- 数据源的类型。始终是 `jsonl`.
+ 数据源的类型。始终为 `jsonl`.
- `"jsonl"`
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 CompletionsRunDataSource 对象。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -22573,7 +22564,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -22585,44 +22576,44 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 描述一组过滤器的 StoredCompletionsRunDataSource 配置
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 数据源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之后创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于过滤在此时间之前创建的项。
+ 一个可选的 Unix 时间戳,用于筛选在此时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回项数。
+ 一个可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional string or null`
- 可选的模型过滤条件(例如,'gpt-4o')。
+ 一个可选的用于筛选的模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -22632,43 +22623,43 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputMessageContentList`
发送给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含先前的助手响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同类型的内容
- 。
+ 发送给模型的一个或多个输入项的列表,其中包含不同的内容
+ 类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -22678,7 +22669,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -22692,7 +22683,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。之一。默认为 `auto`.
- `"low"`
@@ -22714,11 +22705,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像的 URL。可以是完整的 URL,也可以是 base64 编码的 data URL 图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -22738,7 +22729,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 要发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可降低渲染成本,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -22748,7 +22739,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `file_data: optional string`
- 要发送给模型的文件的内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
@@ -22764,7 +22755,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会向上取整到 token 块。
- `mode: "explicit"`
@@ -22774,7 +22765,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -22787,9 +22778,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`) 或最终答案 (`final_answer`).
- 对于像 `gpt-5.3-codex` 及更新的模型,发送后续请求时,请保留并重新发送
- 阶段到所有助手消息中——省略该阶段可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间补充说明(`commentary`) 或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本,发送后续请求时,请在所有助手消息上保留并重新发送
+ 阶段,遗漏会降低性能。不用于用户消息。
- `"commentary"`
@@ -22803,31 +22794,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -22837,21 +22828,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -22861,11 +22852,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `data: string`
- Base64 编码的音频数据。
+ 经过 Base64 编码的音频数据。
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式有 `mp3` 和
`wav`.
- `"mp3"`
@@ -22880,24 +22871,24 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -22907,21 +22898,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -22929,7 +22920,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -22956,7 +22947,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 命名空间中的变量引用。例如“ `item` .item.input_trajectory”
- `type: "item_reference"`
@@ -22966,7 +22957,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, response_format, 4 more }`
@@ -22976,13 +22967,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `"none"`
@@ -23000,20 +22991,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用
- 结构化输出,确保模型匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 会启用
+ Structured Outputs,用于确保模型匹配你提供的 JSON
+ schema。详细了解请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -23023,34 +23014,34 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- 结构化输出配置选项,包括 JSON Schema。
+ Structured Outputs 配置选项,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
@@ -23061,10 +23052,10 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `type: "json_object"`
@@ -23074,53 +23065,53 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可能调用的工具列表。目前,仅支持函数作为工具。使用此选项提供模型可能生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前,作为工具仅支持函数。使用此项提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。在 [函数调用指南](/docs/guides/function-calling).
+ 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的一个子集,当 `strict` 是 `true`。在以下位置详细了解结构化输出 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 中了解更多关于结构化输出的信息。工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 是受支持的。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定什么填充 `item` 此运行数据源中的命名空间。
+ 决定数据源中如何填充 `item` 此运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
@@ -23134,7 +23125,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -23146,13 +23137,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -23162,49 +23153,49 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_after: optional number or null`
- 仅包含在此时间戳之后(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳之前(含)创建的项。这是用于选择响应的查询参数。
+ 仅包含在此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索“instructions”字段的可选字符串。这是用于选择响应的查询参数。
+ 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是用于选择响应的查询参数。
+ 响应的元数据过滤器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是用于选择响应的查询参数。
+ 要为其查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `temperature: optional number or null`
- 采样温度。这是用于选择响应的查询参数。
+ 采样温度。这是一个用于选择响应的查询参数。
- `tools: optional array of string or null`
- 工具名称列表。这是用于选择响应的查询参数。
+ 工具名称列表。这是一个用于选择响应的查询参数。
- `top_p: optional number or null`
- 核采样参数。这是用于选择响应的查询参数。
+ 核采样参数。这是一个用于选择响应的查询参数。
- `users: optional array of string or null`
- 用户标识符列表。这是用于选择响应的查询参数。
+ 用户标识符列表。这是一个用于选择响应的查询参数。
- `type: "responses"`
@@ -23214,13 +23205,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 用于从模型采样时。决定传入模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),或是包含变量引用的模板,这些变量引用指向 `item` 命名空间。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以是对预置轨迹的引用(即, `item.input_trajectory`),也可以是带有对以下项变量引用的模板: `item` namespace.
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -23234,31 +23225,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `EvalMessageObject object { content, role, type }`
- 输入给模型的消息,其角色指示指令遵循
- 层级。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被认为是由模型在之前的
- 交互中生成的。
+ 输入到模型的消息,其角色指示指令的
+ 层级关系。使用 `developer` 或 `system` 角色给出的指令优先于使用
+ 角色给出的指令。使用 `user` 角色的消息被假定为先前由模型生成的
+ `assistant` 消息。
+ 互动。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `OutputText object { text, type }`
- 模型的文本输出。
+ 来自模型的文本输出。
- `text: string`
- 模型的文本输出。
+ 来自模型的文本输出。
- `type: "output_text"`
@@ -23268,21 +23259,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图片输入块。
- `image_url: string`
- 图像输入的 URL。
+ 图片输入的 URL。
- `type: "input_image"`
- 图像输入的类型。始终为 `input_image`.
+ 图片输入的类型。始终为 `input_image`.
- `"input_image"`
- `detail: optional string`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
+ 发送到模型的图片的细节级别。可选值为 `high`, `low`、或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -23290,12 +23281,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每个输入可以是输入文本、输出文本、输入
- 图像或输入音频对象。
+ 输入列表,其中每个输入可以是输入文本、输出文本、输入
+ 图片或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可选值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`、或
`developer`.
- `"user"`
@@ -23322,7 +23313,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `item_reference: string`
- 对 `item` 命名空间。即“item.name”
+ 命名空间中的变量引用。例如“ `item` 命名空间。例如,“item.name”
- `type: "item_reference"`
@@ -23332,7 +23323,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `model: optional string`
- 用于生成补全的模型名称(例如 "o3-mini")。
+ 用于生成补全的模型名称(例如 “o3-mini”)。
- `sampling_params: optional object { max_completion_tokens, reasoning_effort, seed, 4 more }`
@@ -23342,64 +23333,64 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `reasoning_effort: optional ReasoningEffort or null`
- 约束推理模型的推理工作量。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理工作量可以加快响应速度并减少响应中
- 用于推理的令牌数。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以加快响应速度,并减少响应中用于推理的令牌
+ 消耗。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持。
+ 了解特定模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 更高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 来自模型的文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多信息:
- [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。更多信息请参阅
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
默认格式为 `{ "type": "text" }` ,无其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,该模式
- 确保模型生成的消是有效的 JSON。对于支持它的模型,建议使用 `json_schema`
- 。
+ 确保模型生成的消息是合法的 JSON。如果模型支持,建议优先 `json_schema`
+ 使用。
- `ResponseFormatText object { type }`
- 默认响应格式,用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式,用于生成结构化的 JSON 响应。
- 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
- 下划线和破折号,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 模式 [此处](https://json-schema.org/).
+ 响应格式对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON 架构 [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -23409,42 +23400,42 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `description: optional string`
- 响应格式用途的描述,模型使用它来
- 决定如何以该格式进行响应。
+ 对响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的精确架构
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 若设置为 true,模型将始终遵循在
+ 中定义的精确 schema `schema` 字段。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种生成 JSON 响应的较旧方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
- 模型在没有系统或用户消息指示它的情况下不会生成 JSON
- 去这样做。
+ JSON 对象响应格式。生成 JSON 响应的旧方法。
+ 对于支持的模型,推荐使用 `json_schema` 。请注意,如果没有系统或用户消息指示,
+ 模型将不会生成 JSON
+ 。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定使用哪个工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
- 你可以提供给模型的工具分为两类:
+ 你可以向模型提供的两类工具包括:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**: 由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够调用你自己的代码。了解更多关于
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够调用你自己的代码。详细了解
[函数调用](/docs/guides/function-calling).
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -23452,11 +23443,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数验证。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -23474,54 +23465,54 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否延迟并通过工具搜索加载。
+ 此函数是否被延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种从上传文件中搜索相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在…中
- - `nin`:不在…中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -23541,7 +23532,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `value: string or number or boolean or array of string or number`
- 要与属性键比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -23557,15 +23548,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个过滤器: `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用定义的比较操作将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定的属性键与给定值按定义的比较操作进行比较的筛选条件。
- `unknown`
@@ -23579,27 +23570,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含 1 和 50)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 嵌入在倒数排名融合中的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排名器。
+ 用于文件搜索的排序器。
- `"auto"`
@@ -23607,29 +23598,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `score_threshold: optional number`
- 文件搜索的分数阈值,为 0 到 1 之间的数字。接近 1 的数字将尝试仅返回最相关的结果,但可能返回更少的结果。
+ 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终是 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示屏的高度。
+ 计算机显示器的高度。
- `display_width: number`
- 计算机显示屏的宽度。
+ 计算机显示器的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -23647,18 +23638,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use 工具的类型。始终是 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。详细了解
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。之一为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。其一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -23666,22 +23657,22 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为 true。为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当值为 false 时,网页搜索 工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 搜索允许的域。如果未提供,则允许所有域。
- 也允许所提供域的子域。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -23703,7 +23694,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -23711,14 +23702,14 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol 向模型提供额外工具的访问权限
- (MCP)服务器。 [了解更多关于 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器让模型访问更多工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
@@ -23740,48 +23731,48 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或过滤器对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许的工具名称的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以
- 使用自定义 MCP 服务器 URL 或服务连接器。您的应用程序
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。其中一个
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。值为以下之一
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 关于服务连接器的信息 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 目前支持的 `connector_id` 值为:
+ 当前支持的 `connector_id` 值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -23801,12 +23792,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此 MCP 工具是否被推迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于认证
- 或其他目的。
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -23815,41 +23806,41 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤器对象。
+ 用于指定允许使用哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示工具是否会修改数据或仅为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标注,则会匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一审批策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定一个统一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当设置为
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -23862,23 +23853,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `server_url: optional string`
- MCP 服务器的 URL。必须是 `server_url`, `connector_id`,或
- `tunnel_id` 中的一项。
+ MCP 服务器的 URL。 `server_url`, `connector_id`、或
+ `tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,而非直接服务器 URL。必须是
- `server_url`, `connector_id`,或 `tunnel_id` 中的一项。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`、或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一种运行 Python 代码以帮助生成提示响应的工具。
+ 用于运行 Python 代码以辅助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个对象,该对象
- 指定上传的文件 ID 以供你的代码使用,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是一个指定了供代码使用的已上传文件 ID 的对象,以及
+ ,该对象同时包含一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -23886,17 +23877,17 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定要运行代码的文件的 ID。
+ 代码解释器容器的配置。可指定运行代码所需文件的 ID。
- `type: "auto"`
- 始终 `auto`.
+ Always `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -23918,7 +23909,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -23926,33 +23917,33 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选,针对允许列表域名的域范围密钥。
+ 可选的、限定域的密钥,用于允许列表中的域。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 要为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 要为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -23968,7 +23959,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -23978,13 +23969,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 是否生成新图像或编辑现有图像。默认: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -23994,11 +23985,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值之一: `transparent`,
- `opaque`,或 `auto`。透明背景可用于
+ 设置生成图像的背景。可选值为 `transparent`,
+ `opaque`、或 `auto`。透明背景适用于
支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认: `auto`.
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -24008,7 +23999,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面投入的努力程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。之一。默认为 `low`.
- `"high"`
@@ -24016,31 +24007,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选掩码。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 掩码图像的文件ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64编码的掩码图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。其中一个为 `gpt-image-1`,
+ 要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认:
+ `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -24055,7 +24046,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -24067,8 +24058,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。其中一个为 `png`, `webp`,或
- `jpeg`。默认: `png`.
+ 生成图像的输出格式。可选值为 `png`, `webp`、或
+ `jpeg`。默认值: `png`.
- `"png"`
@@ -24078,12 +24069,12 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `partial_images: optional number`
- 流式模式下生成的部分图像数量,范围从0(默认值)到3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。其中一个为 `low`, `medium`, `high`,
- 或 `auto`。默认: `auto`.
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -24095,13 +24086,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率作为 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须都能被16整除,且请求的宽高比必须在1:3到3:1之间。超过的分辨率 `2560x1440` 为实验性的,支持的最大分辨率为 `3840x2160`. 请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受GPT图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用其中一个 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用其中一个 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且所请求的长宽比必须在 1:3 到 3:1 之间。高于 `1536x864`。的分辨率属于实验性质,最高支持的分辨率为 `2560x1440` 。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`。由 GPT 图像模型支持; `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下方式之一 `256x256`, `512x512`、或 `1024x1024`。对于 `dall-e-3`,请使用以下方式之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
- `"1024x1024"`
@@ -24113,7 +24104,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -24123,7 +24114,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -24145,13 +24136,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "container_auto"`
- 自动为此请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的已上传文件列表,供你的代码使用。
+ 提供给代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -24175,7 +24166,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of SkillReference or InlineSkill`
- 可选的技能列表,通过 ID 或内联数据引用。
+ 通过 id 引用或内联数据的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -24225,7 +24216,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "inline"`
- 为此请求定义内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -24239,7 +24230,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `skills: optional array of LocalSkill`
- 可选技能列表。
+ 可选的技能列表。
- `description: string`
@@ -24251,7 +24242,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `path: string`
- 包含技能的目录路径。
+ 包含该技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -24267,7 +24258,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -24275,7 +24266,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -24289,7 +24280,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -24301,11 +24292,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `Text object { type }`
- 无约束的自由形式文本。
+ 无约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -24319,7 +24310,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -24327,21 +24318,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 语法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
- 显示给模型的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -24365,23 +24356,23 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索发现。
+ 是否应推迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。此描述不适用于 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制进行严格的参数验证。如果省略,Responses 会在 schema 兼容时尝试使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种自定义工具,使用指定格式处理输入。了解更多 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -24389,7 +24380,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "custom"`
- 自定义工具的类型。始终 `custom`.
+ 自定义工具的类型。始终为 `custom`.
- `"custom"`
@@ -24403,7 +24394,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 该工具是否应被延迟,并通过工具搜索发现。
- `description: optional string`
@@ -24415,27 +24406,27 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 针对延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 为客户端执行的工具搜索工具向模型显示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务器还是客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -24443,15 +24434,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网页上搜索相关内容以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。其一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -24465,7 +24456,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `search_context_size: optional "low" or "medium" or "high"`
- 关于搜索使用的上下文窗口空间量的高级指导。之一为 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 搜索使用的上下文窗口空间的高级指引。其一为 `low`, `medium`、或 `high`. `medium` 为默认值。
- `"low"`
@@ -24475,11 +24466,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
@@ -24493,7 +24484,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `region: optional string or null`
- 用户的地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -24501,11 +24492,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -24519,11 +24510,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有标记。
+ 作为温度参数的替代方案,用于核采样;1.0 表示包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -24535,20 +24526,20 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `eval_id: string`
- 相关评估的标识符。
+ 关联评估的标识符。
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可以
- 用于以结构化格式存储有关对象的额外信息,
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关对象的附加信息,
并通过 API 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如果适用)。
+ 被评估的模型(如适用)。
- `name: string`
@@ -24556,21 +24547,21 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run"`
- 对象的类型。始终为 "eval.run"。
+ 对象类型,始终为 "eval.run"。
- `"eval.run"`
- `per_model_usage: array of object { cached_tokens, completion_tokens, invocation_count, 3 more }`
- 评估运行期间每个模型的使用统计。
+ 评估运行期间每个模型的使用统计信息。
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `invocation_count: number`
@@ -24582,31 +24573,31 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
- 评估运行期间应用的每项测试标准的结果。
+ 评估运行期间应用的每个测试条件的测试结果。
- `failed: number`
- 此标准失败的测试数量。
+ 此条件下未通过的测试数。
- `passed: number`
- 此标准通过的测试数量。
+ 此条件下通过的测试数。
- `testing_criteria: string`
- 测试标准的说明。
+ 测试条件的描述。
- `report_url: string`
- UI 仪表板上呈现的评估运行报告的 URL。
+ 在 UI 仪表板上指向已渲染评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -24614,11 +24605,11 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `errored: number`
- 导致错误的输出项数量。
+ 出现错误的输出项数量。
- `failed: number`
- 未能通过评估的输出项数量。
+ 未通过评估的输出项数量。
- `passed: number`
@@ -24632,9 +24623,9 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
评估运行的状态。
-# 输出项
+# Output Items
-## 获取评估运行输出项
+## Get eval run output items
**get** `/evals/{eval_id}/runs/{run_id}/output_items`
@@ -24650,7 +24641,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `after: optional string`
- 上一次分页请求中最后一个输出项的标识符。
+ 上一次分页请求中最后一条输出项的标识符。
- `limit: optional number`
@@ -24658,7 +24649,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `order: optional "asc" or "desc"`
- 按时间戳对输出项进行排序的顺序。使用 `asc` 表示升序或 `desc` 表示降序。默认为 `asc`.
+ 按时间戳排序输出项的顺序。使用 `asc` 表示升序,或 `desc` 表示降序。默认为 `asc`.
- `"asc"`
@@ -24666,18 +24657,18 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `status: optional "fail" or "pass"`
- 按状态筛选输出项。使用 `failed` 筛选失败输出
- 项,或 `pass` 筛选通过的输出项。
+ 按状态筛选输出项。使用 `failed` 可筛选失败的输出
+ 项,或 `pass` 可筛选通过的输出项。
- `"fail"`
- `"pass"`
-### 返回
+### Returns
- `data: array of object { id, created_at, datasource_item, 7 more }`
- 评估运行输出项对象的数组。
+ eval 运行输出项对象的数组。
- `id: string`
@@ -24685,7 +24676,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `datasource_item: map[unknown]`
@@ -24701,13 +24692,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run.output_item"`
- 对象的类型。始终为 "eval.run.output_item"。
+ 对象的类型,始终为 "eval.run.output_item"。
- `"eval.run.output_item"`
- `results: array of object { name, passed, score, 2 more }`
- 此输出项的评分器结果列表。
+ 该输出项的评分器结果列表。
- `name: string`
@@ -24715,15 +24706,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `passed: boolean`
- 评分器是否认为输出通过。
+ 评分器是否将该输出视为通过。
- `score: number`
- 评分器产生的数字分数。
+ 评分器生成的数值分数。
- `sample: optional map[unknown] or null`
- 评分器产生的可选样本或中间数据。
+ 评分器生成的可选样本或中间数据。
- `type: optional string`
@@ -24739,7 +24730,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -24755,7 +24746,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input: array of object { content, role }`
- 输入消息的数组。
+ 输入消息数组。
- `content: string`
@@ -24767,7 +24758,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_completion_tokens: number`
- 完成允许的 token 最大数量。
+ 补全允许的最大 token 数。
- `model: string`
@@ -24775,7 +24766,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output: array of object { content, role }`
- 输出消息的数组。
+ 输出消息数组。
- `content: optional string`
@@ -24791,7 +24782,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `temperature: number`
- 使用的采样温度。
+ 所使用的采样温度。
- `top_p: number`
@@ -24803,19 +24794,19 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `status: string`
@@ -24823,15 +24814,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `first_id: string`
- 数据数组中第一个评估运行输出项的标识符。
+ data 数组中第一个 eval run 输出项的标识符。
- `has_more: boolean`
- 指示是否还有更多评估运行输出项可用。
+ 指示是否还有更多 eval run 输出项可用。
- `last_id: string`
- 数据数组中最后一个评估运行输出项的标识符。
+ data 数组中最后一个 eval run 输出项的标识符。
- `object: "list"`
@@ -24973,7 +24964,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
}
],
"finish_reason": "stop",
- "model": "gpt-4o-mini-2024-07-18",
+ "model": "gpt-5.6-sol",
"usage": {
"total_tokens": 325,
"completion_tokens": 2,
@@ -24998,7 +24989,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
**get** `/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}`
-按 ID 获取评估运行输出项。
+通过 ID 获取评估运行输出项。
### 路径参数
@@ -25008,7 +24999,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `output_item_id: string`
-### 返回
+### Returns
- `id: string`
@@ -25016,7 +25007,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `datasource_item: map[unknown]`
@@ -25032,13 +25023,13 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `object: "eval.run.output_item"`
- 对象的类型。始终为 "eval.run.output_item"。
+ 对象的类型,始终为 "eval.run.output_item"。
- `"eval.run.output_item"`
- `results: array of object { name, passed, score, 2 more }`
- 此输出项的评分器结果列表。
+ 该输出项的评分器结果列表。
- `name: string`
@@ -25046,15 +25037,15 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `passed: boolean`
- 评分器是否认为输出通过。
+ 评分器是否将该输出视为通过。
- `score: number`
- 评分器产生的数字分数。
+ 评分器生成的数值分数。
- `sample: optional map[unknown] or null`
- 评分器产生的可选样本或中间数据。
+ 评分器生成的可选样本或中间数据。
- `type: optional string`
@@ -25070,7 +25061,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -25086,7 +25077,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `input: array of object { content, role }`
- 输入消息的数组。
+ 输入消息数组。
- `content: string`
@@ -25098,7 +25089,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `max_completion_tokens: number`
- 完成允许的 token 最大数量。
+ 补全允许的最大 token 数。
- `model: string`
@@ -25106,7 +25097,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `output: array of object { content, role }`
- 输出消息的数组。
+ 输出消息数组。
- `content: optional string`
@@ -25122,7 +25113,7 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `temperature: number`
- 使用的采样温度。
+ 所使用的采样温度。
- `top_p: number`
@@ -25134,19 +25125,19 @@ curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/run
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `status: string`
@@ -25275,7 +25266,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
}
],
"finish_reason": "stop",
- "model": "gpt-4o-mini-2024-07-18",
+ "model": "gpt-5.6-sol",
"usage": {
"total_tokens": 325,
"completion_tokens": 2,
@@ -25291,13 +25282,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
}
```
-## 域类型
+## 域名类型
### 输出项列表响应
- `OutputItemListResponse object { id, created_at, datasource_item, 7 more }`
- 表示评估运行输出项的模式。
+ 表示评估运行输出项的架构。
- `id: string`
@@ -25305,7 +25296,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `datasource_item: map[unknown]`
@@ -25321,13 +25312,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run.output_item"`
- 对象的类型。始终为 "eval.run.output_item"。
+ 对象的类型,始终为 "eval.run.output_item"。
- `"eval.run.output_item"`
- `results: array of object { name, passed, score, 2 more }`
- 此输出项的评分器结果列表。
+ 该输出项的评分器结果列表。
- `name: string`
@@ -25335,15 +25326,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `passed: boolean`
- 评分器是否认为输出通过。
+ 评分器是否将该输出视为通过。
- `score: number`
- 评分器产生的数字分数。
+ 评分器生成的数值分数。
- `sample: optional map[unknown] or null`
- 评分器产生的可选样本或中间数据。
+ 评分器生成的可选样本或中间数据。
- `type: optional string`
@@ -25359,7 +25350,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -25375,7 +25366,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input: array of object { content, role }`
- 输入消息的数组。
+ 输入消息数组。
- `content: string`
@@ -25387,7 +25378,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_completion_tokens: number`
- 完成允许的 token 最大数量。
+ 补全允许的最大 token 数。
- `model: string`
@@ -25395,7 +25386,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output: array of object { content, role }`
- 输出消息的数组。
+ 输出消息数组。
- `content: optional string`
@@ -25411,7 +25402,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `temperature: number`
- 使用的采样温度。
+ 所使用的采样温度。
- `top_p: number`
@@ -25423,29 +25414,29 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `status: string`
评估运行的状态。
-### 输出项检索响应
+### Output Item Retrieve Response
- `OutputItemRetrieveResponse object { id, created_at, datasource_item, 7 more }`
- 表示评估运行输出项的模式。
+ 表示评估运行输出项的架构。
- `id: string`
@@ -25453,7 +25444,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `created_at: number`
- 评估运行创建时的 Unix 时间戳(秒)。
+ 评估运行创建时的 Unix 时间戳(以秒为单位)。
- `datasource_item: map[unknown]`
@@ -25469,13 +25460,13 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `object: "eval.run.output_item"`
- 对象的类型。始终为 "eval.run.output_item"。
+ 对象的类型,始终为 "eval.run.output_item"。
- `"eval.run.output_item"`
- `results: array of object { name, passed, score, 2 more }`
- 此输出项的评分器结果列表。
+ 该输出项的评分器结果列表。
- `name: string`
@@ -25483,15 +25474,15 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `passed: boolean`
- 评分器是否认为输出通过。
+ 评分器是否将该输出视为通过。
- `score: number`
- 评分器产生的数字分数。
+ 评分器生成的数值分数。
- `sample: optional map[unknown] or null`
- 评分器产生的可选样本或中间数据。
+ 评分器生成的可选样本或中间数据。
- `type: optional string`
@@ -25507,7 +25498,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -25523,7 +25514,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `input: array of object { content, role }`
- 输入消息的数组。
+ 输入消息数组。
- `content: string`
@@ -25535,7 +25526,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `max_completion_tokens: number`
- 完成允许的 token 最大数量。
+ 补全允许的最大 token 数。
- `model: string`
@@ -25543,7 +25534,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `output: array of object { content, role }`
- 输出消息的数组。
+ 输出消息数组。
- `content: optional string`
@@ -25559,7 +25550,7 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `temperature: number`
- 使用的采样温度。
+ 所使用的采样温度。
- `top_p: number`
@@ -25571,19 +25562,19 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
- `cached_tokens: number`
- 从缓存中检索到的令牌数。
+ 从缓存中检索到的 token 数量。
- `completion_tokens: number`
- 生成的完成令牌数。
+ 生成的 completion token 数量。
- `prompt_tokens: number`
- 使用的提示令牌数。
+ 使用的 prompt token 数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `status: string`
diff --git a/docs/zh/api/reference/resources/evals/subresources/runs/methods/cancel.md b/docs/zh/api/reference/resources/evals/subresources/runs/methods/cancel.md
index 3aaf375..2851da9 100644
--- a/docs/zh/api/reference/resources/evals/subresources/runs/methods/cancel.md
+++ b/docs/zh/api/reference/resources/evals/subresources/runs/methods/cancel.md
@@ -1,4 +1,4 @@
-> 有关完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
## 取消评估运行
@@ -24,21 +24,21 @@
- `data_source: CreateEvalJSONLRunDataSource or CreateEvalCompletionsRunDataSource or object { source, type, input_messages, 2 more }`
- 关于运行数据源的信息。
+ 关于该运行数据源的信息。
- `CreateEvalJSONLRunDataSource object { source, type }`
- 一个 JsonlRunDataSource 对象,指定与评估匹配的 JSONL 文件。
+ 一个 JsonlRunDataSource 对象,指定与该评估相匹配的 JSONL 文件
- `source: object { content, type } or object { id, type }`
- 决定哪些内容填充 `item` 数据源中的命名空间。
+ 用于确定如何填充数据源中的 `item` 命名空间。
- `EvalJSONLFileContentSource object { content, type }`
- `content: array of object { item, sample }`
- jsonl 文件的内容。
+ 该 jsonl 文件的内容。
- `item: map[unknown]`
@@ -46,7 +46,7 @@
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -54,11 +54,11 @@
- `id: string`
- 文件的标识符。
+ 该文件的标识符。
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
@@ -70,17 +70,17 @@
- `CreateEvalCompletionsRunDataSource object { source, type, input_messages, 2 more }`
- 一个 CompletionsRunDataSource 对象,描述模型采样配置。
+ 一个 CompletionsRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 3 more }`
- 决定哪些内容填充 `item` 此运行数据源中的命名空间。
+ 用于确定如何填充数据源中的 `item` 本次运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
- `content: array of object { item, sample }`
- jsonl 文件的内容。
+ 该 jsonl 文件的内容。
- `item: map[unknown]`
@@ -88,7 +88,7 @@
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -96,48 +96,48 @@
- `id: string`
- 文件的标识符。
+ 该文件的标识符。
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `StoredCompletionsRunDataSource object { type, created_after, created_before, 3 more }`
- 一个 StoredCompletionsRunDataSource 配置,描述一组筛选条件。
+ 一个 StoredCompletionsRunDataSource 配置,用于描述一组筛选条件
- `type: "stored_completions"`
- 源的类型。始终为 `stored_completions`.
+ 来源的类型。始终为 `stored_completions`.
- `"stored_completions"`
- `created_after: optional number or null`
- 可选的 Unix 时间戳,用于筛选此后创建的条目。
+ 可选的 Unix 时间戳,用于筛选在该时间之后创建的项。
- `created_before: optional number or null`
- 可选的 Unix 时间戳,用于筛选此前创建的条目。
+ 可选的 Unix 时间戳,用于筛选在该时间之前创建的项。
- `limit: optional number or null`
- 可选的最大返回条目数。
+ 可选的返回项的最大数量。
- `metadata: optional Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可用于
- 以结构化方式存储对象的附加信息,
- 并通过API或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关该对象的附加信息,并通过
+ API 或仪表板查询对象。
键是字符串,最大长度为 64 个字符。值是字符串
,最大长度为 512 个字符。
- `model: optional string or null`
- 用于筛选的可选模型(例如 'gpt-4o')。
+ 用于筛选的可选模型(例如 'gpt-5.6-sol')。
- `type: "completions"`
@@ -147,21 +147,21 @@
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 从模型采样时使用。决定传递给模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),也可以是带有对 `item` 命名空间变量引用的模板。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以引用预构建的轨迹(即, `item.input_trajectory`),也可以使用引用了 `item` 命名空间的模板。
- `TemplateInputMessages object { template, type }`
- `template: array of EasyInputMessage or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,即 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `EasyInputMessage object { content, role, phase, type }`
- 传递给模型的消息输入,带有表明指令遵循
- 层级的角色。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被假定为模型在之前的
- 交互中生成的。
+ 作为模型输入的消息,其角色指示指令遵循
+ hierarchy。使用 developer `developer` 或 `system` role 给出的指令优先于使用 system
+ role 给出的指令。使用 assistant `user` role 的消息被认为是在之前的
+ `assistant` role 交互中由模型生成的。
+ interactions。
- `content: string or ResponseInputMessageContentList`
@@ -174,7 +174,7 @@
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一个或多个输入项的列表,包含不同的内容
类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
@@ -183,7 +183,7 @@
- `text: string`
- 给模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -193,7 +193,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示词前缀的确切结尾。断点继承请求的 TTL `prompt_cache_options.ttl`;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的确切结束位置。该断点会从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会被取整到 token 块。
- `mode: "explicit"`
@@ -203,11 +203,11 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。以下之一 `high`, `low`, `auto`,或 `original`。默认值为 `auto`.
+ 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `"low"`
@@ -225,15 +225,15 @@
- `file_id: optional string or null`
- 要发送给模型的文件的 ID。
+ 要发送给模型的文件 ID。
- `image_url: optional string or null`
- 要发送给模型的图像的 URL。完全限定的 URL 或数据 URL 中的 base64 编码图像。
+ 要发送给模型的图像 URL。可以是完整 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示词前缀的确切结尾。断点继承请求的 TTL `prompt_cache_options.ttl`;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的确切结束位置。该断点会从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会被取整到 token 块。
- `mode: "explicit"`
@@ -243,7 +243,7 @@
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 给模型的文件输入。
+ 发送给模型的文件输入。
- `type: "input_file"`
@@ -253,7 +253,7 @@
- `detail: optional "auto" or "low" or "high"`
- 要发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入令牌的使用量。使用 `low` 进行低成本渲染,或 `high` 以更高质量渲染文件。默认值为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 进行较低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -267,7 +267,7 @@
- `file_id: optional string or null`
- 要发送给模型的文件的 ID。
+ 要发送给模型的文件 ID。
- `file_url: optional string`
@@ -275,11 +275,11 @@
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 要发送给模型的文件名。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示词前缀的确切结尾。断点继承请求的 TTL `prompt_cache_options.ttl`;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的确切结束位置。该断点会从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会被取整到 token 块。
- `mode: "explicit"`
@@ -289,7 +289,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可以是以下之一: `user`, `assistant`, `system`,或
+ 消息输入的角色。其一为 `user`, `assistant`, `system`,或
`developer`.
- `"user"`
@@ -302,9 +302,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段的所有助手消息——省略它可能会降低性能。不适用于用户消息。
+ 将消息标记为 `assistant` 中间评注(`commentary`)或最终答案(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段在所有助手消息中——删除它可能会降低性能。不用于用户消息。
- `"commentary"`
@@ -318,15 +318,15 @@
- `EvalMessageObject object { content, role, type }`
- 传递给模型的消息输入,带有表明指令遵循
- 层级的角色。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被假定为模型在之前的
- 交互中生成的。
+ 作为模型输入的消息,其角色指示指令遵循
+ hierarchy。使用 developer `developer` 或 `system` role 给出的指令优先于使用 system
+ role 给出的指令。使用 assistant `user` role 的消息被认为是在之前的
+ `assistant` role 交互中由模型生成的。
+ interactions。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项数组。
- `TextInput = string`
@@ -338,11 +338,11 @@
- `OutputText object { text, type }`
- 模型的文本输出。
+ 模型输出的文本。
- `text: string`
- 模型的文本输出。
+ 模型输出的文本。
- `type: "output_text"`
@@ -366,7 +366,7 @@
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一 `high`, `low`,或 `auto`。默认值为 `auto`.
+ 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -380,7 +380,7 @@
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 以及
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -408,11 +408,11 @@
- `OutputText object { text, type }`
- 模型的文本输出。
+ 模型输出的文本。
- `text: string`
- 模型的文本输出。
+ 模型输出的文本。
- `type: "output_text"`
@@ -436,7 +436,7 @@
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一 `high`, `low`,或 `auto`。默认值为 `auto`.
+ 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -444,7 +444,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可以是以下之一: `user`, `assistant`, `system`,或
+ 消息输入的角色。其一为 `user`, `assistant`, `system`,或
`developer`.
- `"user"`
@@ -471,7 +471,7 @@
- `item_reference: string`
- 对 `item` 命名空间中变量的引用。例如,"item.input_trajectory"
+ 对 `item` 命名空间中某个变量的引用。例如 "item.input_trajectory"
- `type: "item_reference"`
@@ -487,17 +487,17 @@
- `max_completion_tokens: optional number`
- 生成的输出中的最大 token 数。
+ 生成输出中允许的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型的推理投入程度。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理投入可以加快响应速度,并减少响应中用于推理的
- token 数。并非所有推理模型都支持每个
- 值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并减少在单次响应中用于推理的 token 数量。
+ 并非所有推理模型都支持所有
+ 取值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持情况。
+ 了解各模型的支持情况。
- `"none"`
@@ -515,16 +515,16 @@
- `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject`
- 指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 设置为 `{ "type": "json_schema", "json_schema": {...} }` 时启用
- 结构化输出,确保模型将匹配你提供的 JSON
- 架构。更多信息请参阅 [Structured Outputs
+ 设置为 `{ "type": "json_schema", "json_schema": {...} }` 即可启用
+ Structured Outputs,可确保模型匹配你提供的 JSON
+ schema。了解更多,请参阅 [Structured Outputs
指南](/docs/guides/structured-outputs).
- 设置为 `{ "type": "json_object" }` 启用较旧的 JSON 模式,该模式
- 确保模型生成的消息是有效的 JSON。对于支持该功能的模型,建议使用 `json_schema`
- 更为合适。
+ 设置为 `{ "type": "json_object" }` 启用旧版 JSON 模式,该模式
+ 可确保模型生成的消息是合法 JSON。对于支持的模型,建议使用 `json_schema`
+ 方式。
- `ResponseFormatText object { type }`
@@ -532,116 +532,116 @@
- `type: "text"`
- 正在定义的响应格式类型。始终为 `text`.
+ 正在定义的响应格式的类型。始终为 `text`.
- `"text"`
- `ResponseFormatJSONSchema object { json_schema, type }`
- JSON Schema 响应格式。用于生成结构化的 JSON 响应。
- 了解有关 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化 JSON 响应。
+ 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
- `json_schema: object { name, description, schema, strict }`
- Structured Outputs 配置选项(包括 JSON Schema)的更多信息。
+ Structured Outputs 配置选项的信息,包括 JSON Schema。
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
下划线和短横线,最大长度为 64。
- `description: optional string`
- 对响应格式用途的描述,模型会使用该描述来
+ 响应格式的用途说明,供模型用于
确定如何按该格式进行响应。
- `schema: optional map[unknown]`
- 响应格式的架构,描述为 JSON Schema 对象。
- 了解如何构建 JSON 架构 [此处](https://json-schema.org/).
+ 响应格式的 schema,以 JSON Schema 对象描述。
+ 了解如何构建 JSON schema [请参见此处](https://json-schema.org/).
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的确切 schema
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多信息,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 如果设置为 true,模型将始终遵循在
+ 字段中定义的确切 `schema` 模式。仅支持 JSON Schema 的一个子集,当
+ `strict` 为 `true`。时。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `type: "json_schema"`
- 正在定义的响应格式类型。始终为 `json_schema`.
+ 正在定义的响应格式的类型。始终为 `json_schema`.
- `"json_schema"`
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 使用 `json_schema` 对于支持它的模型是推荐的。请注意,
- 模型在没有系统或用户消息指示时不会生成 JSON
+ JSON object 响应格式。生成 JSON 响应的一种较旧的方法。
+ 建议对支持该方法的模型使用 `json_schema` 。注意,如果没有系统或用户消息指示模型生成 JSON,
+ 模型将不会生成 JSON
。
- `type: "json_object"`
- 正在定义的响应格式类型。始终为 `json_object`.
+ 正在定义的响应格式的类型。始终为 `json_object`.
- `"json_object"`
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 较高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `tools: optional array of ChatCompletionFunctionTool`
- 模型可以调用的工具列表。目前仅支持函数作为工具。使用此参数提供模型可以为其生成 JSON 输入的函数列表。最多支持 128 个函数。
+ 模型可以调用的工具列表。目前仅支持函数作为工具。使用此参数可提供一个函数列表,模型可为其生成 JSON 输入。最多支持 128 个函数。
- `function: FunctionDefinition`
- `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` 定义一个具有空参数列表的函数。
- `strict: optional boolean or null`
- 是否在生成函数调用时启用严格模式校验。如果设为 true,模型将遵循 `parameters` 字段。仅支持 JSON Schema 的子集,当 `strict` 为 `true`。中定义的确切模式。有关结构化输出的更多信息,请参阅 [函数调用指南](/docs/guides/function-calling).
+ 是否在生成函数调用时启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 模式。仅支持 JSON Schema 的一个子集,当 `strict` 为 `true`。中定义的确切模式。在 [函数调用指南](/docs/guides/function-calling).
- `type: "function"`
- 工具的类型。目前仅支持 `function` 。
+ 工具的类型。目前,仅支持 `function` 。
- `"function"`
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有令牌。
+ 作为核采样替代方案的一个参数;1.0 包含所有 token。
- `ResponsesRunDataSource object { source, type, input_messages, 2 more }`
- 一个描述模型采样配置的 ResponsesRunDataSource 对象。
+ 一个 ResponsesRunDataSource 对象,用于描述模型采样配置。
- `source: object { content, type } or object { id, type } or object { type, created_after, created_before, 8 more }`
- 决定哪些内容填充 `item` 此运行数据源中的命名空间。
+ 用于确定如何填充数据源中的 `item` 本次运行数据源中的命名空间。
- `EvalJSONLFileContentSource object { content, type }`
- `content: array of object { item, sample }`
- jsonl 文件的内容。
+ 该 jsonl 文件的内容。
- `item: map[unknown]`
@@ -649,7 +649,7 @@
- `type: "file_content"`
- jsonl 源的类型。始终为 `file_content`.
+ jsonl 数据源的类型。始终为 `file_content`.
- `"file_content"`
@@ -657,17 +657,17 @@
- `id: string`
- 文件的标识符。
+ 该文件的标识符。
- `type: "file_id"`
- jsonl 源的类型。始终为 `file_id`.
+ jsonl 数据源的类型。始终为 `file_id`.
- `"file_id"`
- `EvalResponsesSource object { type, created_after, created_before, 8 more }`
- 一个描述运行数据源配置的 EvalResponsesSource 对象。
+ 一个 EvalResponsesSource 对象,用于描述运行数据源配置。
- `type: "responses"`
@@ -677,33 +677,33 @@
- `created_after: optional number or null`
- 仅包含在此时间戳(含)之后创建的条目。这是一个用于选择响应的查询参数。
+ 仅包含此时间戳之后(包含)创建的项目。这是一个用于选择响应的查询参数。
- `created_before: optional number or null`
- 仅包含在此时间戳(含)之前创建的条目。这是一个用于选择响应的查询参数。
+ 仅包含此时间戳之前(包含)创建的项目。这是一个用于选择响应的查询参数。
- `instructions_search: optional string or null`
- 用于搜索 'instructions' 字段的可选字符串。这是一个用于选择响应的查询参数。
+ 用于搜索 “instructions” 字段的可选字符串。这是一个用于选择响应的查询参数。
- `metadata: optional unknown or null`
- 响应的元数据过滤器。这是一个用于选择响应的查询参数。
+ 响应的元数据筛选器。这是一个用于选择响应的查询参数。
- `model: optional string or null`
- 要查找响应的模型名称。这是一个用于选择响应的查询参数。
+ 用于查找响应的模型名称。这是一个用于选择响应的查询参数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型的推理投入程度。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理投入可以加快响应速度,并减少响应中用于推理的
- token 数。并非所有推理模型都支持每个
- 值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并减少在单次响应中用于推理的 token 数量。
+ 并非所有推理模型都支持所有
+ 取值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持情况。
+ 了解各模型的支持情况。
- `temperature: optional number or null`
@@ -729,13 +729,13 @@
- `input_messages: optional object { template, type } or object { item_reference, type }`
- 从模型采样时使用。决定传递给模型的消息结构。可以是预构建轨迹的引用(即, `item.input_trajectory`),也可以是带有对 `item` 命名空间变量引用的模板。
+ 在对模型进行采样时使用。决定传入模型的消息结构。可以引用预构建的轨迹(即, `item.input_trajectory`),也可以使用引用了 `item` 命名空间的模板。
- `InputMessagesTemplate object { template, type }`
- `template: array of object { content, role } or object { content, role, type }`
- 构成提示或上下文的聊天消息列表。可能包含对 `item` 命名空间的变量引用,即 {{item.name}}。
+ 构成提示或上下文的聊天消息列表。可以包含对 `item` 命名空间的变量引用,例如 {{item.name}}。
- `ChatMessage object { content, role }`
@@ -745,19 +745,19 @@
- `role: string`
- 消息的角色(例如 "system"、"assistant"、"user")。
+ 消息的角色(例如 “system”、“assistant”、“user”)。
- `EvalMessageObject object { content, role, type }`
- 传递给模型的消息输入,带有表明指令遵循
- 层级的角色。以 `developer` 或 `system` 角色给出的指令
- 优先于以 `user` 角色给出的指令。具有
- `assistant` 角色的消息被假定为模型在之前的
- 交互中生成的。
+ 作为模型输入的消息,其角色指示指令遵循
+ hierarchy。使用 developer `developer` 或 `system` role 给出的指令优先于使用 system
+ role 给出的指令。使用 assistant `user` role 的消息被认为是在之前的
+ `assistant` role 交互中由模型生成的。
+ interactions。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项数组。
- `TextInput = string`
@@ -769,11 +769,11 @@
- `OutputText object { text, type }`
- 模型的文本输出。
+ 模型输出的文本。
- `text: string`
- 模型的文本输出。
+ 模型输出的文本。
- `type: "output_text"`
@@ -797,7 +797,7 @@
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一 `high`, `low`,或 `auto`。默认值为 `auto`.
+ 发送给模型的图像的细节级别。可选值为 `high`, `low`,或 `auto`。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -810,7 +810,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。可以是以下之一: `user`, `assistant`, `system`,或
+ 消息输入的角色。其一为 `user`, `assistant`, `system`,或
`developer`.
- `"user"`
@@ -837,7 +837,7 @@
- `item_reference: string`
- 对 `item` 命名空间。例如,"item.name"
+ 对 `item` namespace。例如 "item.name"
- `type: "item_reference"`
@@ -853,49 +853,49 @@
- `max_completion_tokens: optional number`
- 生成的输出中的最大 token 数。
+ 生成输出中允许的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型的推理投入程度。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
- 降低推理投入可以加快响应速度,并减少响应中用于推理的
- token 数。并非所有推理模型都支持每个
- 值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并减少在单次响应中用于推理的 token 数量。
+ 并非所有推理模型都支持所有
+ 取值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的特定支持情况。
+ 了解各模型的支持情况。
- `seed: optional number`
- 用于在采样时初始化随机性的种子值。
+ 用于在采样过程中初始化随机性的种子值。
- `temperature: optional number`
- 较高的温度会增加输出的随机性。
+ 较高的 temperature 会增加输出的随机性。
- `text: optional object { format }`
模型文本响应的配置选项。可以是纯
文本或结构化 JSON 数据。了解更多:
- - [文本输入和输出](/docs/guides/text)
+ - [文本输入与输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 启用结构化输出,
- 这确保模型将匹配你提供的 JSON 模式。在以下指南中了解更多:
+ 设置 `{ "type": "json_schema" }` 启用结构化输出,
+ 可确保模型匹配你提供的 JSON schema。详情请参阅
[结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,无额外选项。
+ 默认格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新模型:**
+ **不推荐用于 gpt-4o 及更新模型:**
- 设置为 `{ "type": "json_object" }` 启用较旧的 JSON 模式,该模式
- 确保模型生成的消息是有效的 JSON。对于支持该功能的模型,建议使用 `json_schema`
- 更为合适。
+ 设置为 `{ "type": "json_object" }` 启用旧版 JSON 模式,该模式
+ 可确保模型生成的消息是合法 JSON。对于支持的模型,建议使用 `json_schema`
+ 方式。
- `ResponseFormatText object { type }`
@@ -903,54 +903,54 @@
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化的 JSON 响应。
- 了解有关 [Structured Outputs](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化 JSON 响应。
+ 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须是 a-z、A-Z、0-9,或包含
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,描述为 JSON Schema 对象。
- 了解如何构建 JSON 架构 [此处](https://json-schema.org/).
+ 响应格式的 schema,以 JSON Schema 对象描述。
+ 了解如何构建 JSON schema [请参见此处](https://json-schema.org/).
- `type: "json_schema"`
- 正在定义的响应格式类型。始终为 `json_schema`.
+ 正在定义的响应格式的类型。始终为 `json_schema`.
- `"json_schema"`
- `description: optional string`
- 对响应格式用途的描述,模型会使用该描述来
+ 响应格式的用途说明,供模型用于
确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循定义的确切 schema
- 中的 `schema` 字段。仅支持 JSON Schema 的子集,当
- `strict` 为 `true`。要了解更多信息,请阅读 [Structured Outputs
+ 是否在生成输出时启用严格的 schema 遵循。
+ 如果设置为 true,模型将始终遵循在
+ 字段中定义的确切 `schema` 模式。仅支持 JSON Schema 的一个子集,当
+ `strict` 为 `true`。时。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 使用 `json_schema` 对于支持它的模型是推荐的。请注意,
- 模型在没有系统或用户消息指示时不会生成 JSON
+ JSON object 响应格式。生成 JSON 响应的一种较旧的方法。
+ 建议对支持该方法的模型使用 `json_schema` 。注意,如果没有系统或用户消息指示模型生成 JSON,
+ 模型将不会生成 JSON
。
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可能调用的工具数组。你可以通过设置
- 来指定使用哪个工具,通过设置 `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定使用的工具。
- 你可以提供给模型的两类工具是:
+ 你可以提供给模型的工具有两类:
- - **内置工具**:由 OpenAI 提供的工具,扩展了
- 模型的能力,如 [网页搜索](/docs/guides/tools-web-search)
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
[内置工具](/docs/guides/tools).
- **函数调用(自定义工具)**:由你定义的函数,
@@ -959,19 +959,19 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中的一个函数,模型可以选择调用它。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
- 描述函数参数的 JSON schema 对象。
+ 描述该函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制进行严格的参数验证。
+ 是否对该函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -989,19 +989,19 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟并通过工具搜索加载。
+ 该函数是否为延迟加载,并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述。模型用它来决定是否调用该函数。
+ 函数的描述。由模型用于确定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中编码的 JSON 值的 JSON schema 对象。
+ 描述此函数字符串输出中 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 一种搜索上传文件中相关内容的工具。了解更多关于 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容的工具。了解更多关于文件搜索工具 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -1011,32 +1011,32 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于通过定义的比较操作将指定属性键与给定值进行比较的筛选器。
+ 用于在指定的比较操作下,将指定的属性键与给定值进行比较的过滤器。
- `key: string`
- 要与值进行比较的键。
+ 要与该值进行比较的属性键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`:等于
- - `ne`:不等于
- - `gt`:大于
- - `gte`:大于或等于
- - `lt`:小于
- - `lte`:小于或等于
- - `in`:在集合中
- - `nin`:不在集合中
+ - `eq`: 等于
+ - `ne`: 不等于
+ - `gt`: 大于
+ - `gte`: 大于或等于
+ - `lt`: 小于
+ - `lte`: 小于或等于
+ - `in`: 包含于
+ - `nin`: 不包含于
- `"eq"`
@@ -1056,7 +1056,7 @@
- `value: string or number or boolean or array of string or number`
- 要与属性键进行比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值,支持字符串、数字或布尔类型。
- `string`
@@ -1072,15 +1072,15 @@
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式组合多个过滤器: `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选器数组。项目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的过滤器数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于通过定义的比较操作将指定属性键与给定值进行比较的筛选器。
+ 用于在指定的比较操作下,将指定的属性键与给定值进行比较的过滤器。
- `unknown`
@@ -1094,23 +1094,23 @@
- `max_num_results: optional number`
- 要返回的最大结果数。此数字应在 1 到 50 之间(含)。
+ 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
- 搜索的排名选项。
+ 搜索的排序选项。
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 当启用混合搜索时,控制倒数排名融合如何平衡语义嵌入匹配与稀疏关键字匹配的权重。
+ 在启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 嵌入在倒数排名融合中的权重。
- `text_weight: number`
- 文本在倒数排名融合中的权重。
+ 文本在倒数排序融合中的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -1122,33 +1122,33 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,为0到1之间的数字。越接近1的数字将尝试仅返回最相关的结果,但可能返回较少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数值。越接近 1 的数值会尝试仅返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 控制虚拟计算机的工具。了解更多关于 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示屏的高度。
- `display_width: number`
- 计算机显示器的宽度。
+ 计算机显示屏的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
- 要控制的计算机环境的类型。
+ 要控制的计算机环境类型。
- `"windows"`
@@ -1162,18 +1162,18 @@
- `type: "computer_use_preview"`
- 计算机使用工具的类型。始终为 `computer_use_preview`.
+ computer use tool 的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 搜索互联网以获取与提示相关的来源。了解更多关于
- [网页搜索工具](/docs/guides/tools-web-search).
+ 在互联网上搜索与提示相关的来源。了解更多关于
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。其中之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1181,22 +1181,22 @@
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。省略时默认为true。当为false时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许网页搜索实时访问互联网。如果省略,默认值为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
搜索允许的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也允许。
+ 也允许所提供域名的子域名。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指导。其中之一 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 用于搜索的上下文窗口空间使用量的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -1206,7 +1206,7 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的大致位置。
+ 用户的近似位置。
- `city: optional string or null`
@@ -1214,7 +1214,7 @@
- `country: optional string or null`
- 两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 由两位字母组成的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -1226,22 +1226,22 @@
- `type: optional "approximate"`
- 位置近似类型。始终 `approximate`.
+ 位置近似值的类型,固定为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议为模型提供附加工具
- (MCP)服务器。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 通过远程 Model Context Protocol
+ (MCP)服务器为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 此 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
- MCP 工具的类型。始终 `mcp`.
+ MCP 工具的类型,固定为 `mcp`.
- `"mcp"`
@@ -1255,21 +1255,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许的工具名称列表或过滤器对象。
- `McpAllowedTools = array of string`
- 允许的工具名称字符串数组
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示该工具是修改数据还是只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 则会匹配此过滤器。
- `tool_names: optional array of string`
@@ -1277,25 +1277,25 @@
- `authorization: optional string`
- 一个 OAuth 访问令牌,可用于远程 MCP 服务器,
- 无论是自定义 MCP 服务器 URL 还是服务连接器。你的应用
- 必须处理 OAuth 授权流程并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合自定义 MCP 服务器 URL
+ 或服务连接器使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,如 ChatGPT 中可用的那些。必须提供
- `server_url`, `connector_id`,或 `tunnel_id` 其中之一。了解更多
- 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。需要
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中一个。了解更多
+ 关于服务连接器 [请参见此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 值有:
+ 当前支持 `connector_id` 的值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
- - Google 日历: `connector_googlecalendar`
- - Google 云端硬盘: `connector_googledrive`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
- Microsoft Teams: `connector_microsoftteams`
- - Outlook 日历: `connector_outlookcalendar`
- - Outlook 电子邮件: `connector_outlookemail`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
- SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -1316,11 +1316,11 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 此 MCP 工具是否为延迟加载并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 头。用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 头。用于认证或
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
@@ -1330,18 +1330,18 @@
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器的哪些工具需要审批。可以是
- `always`, `never`,或一个与需要审批的工具关联的过滤器对象
- 。
+ `always`, `never`,或与工具关联的过滤器对象
+ 需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示该工具是修改数据还是只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 则会匹配此过滤器。
- `tool_names: optional array of string`
@@ -1349,13 +1349,13 @@
- `never: optional object { read_only, tool_names }`
- 指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果
- MCP 服务器 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- 它将匹配此过滤器。
+ 指示该工具是修改数据还是只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 则会匹配此过滤器。
- `tool_names: optional array of string`
@@ -1363,8 +1363,8 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一的审批策略。取值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 为所有工具指定单一的审批策略。可选值为 `always` 或
+ `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -1377,23 +1377,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。其中 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供。
+ MCP 服务器的 URL。 `server_url`, `connector_id`,或
+ `tunnel_id` 必须提供一个。
- `tunnel_id: optional string`
- 要使用的安全 MCP 隧道 ID,而不是直接使用服务器 URL。其中
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个运行 Python 代码以帮助生成提示词响应的工具。
+ 运行 Python 代码以帮助生成对提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是对象,
- 指定要提供给你的代码的上传文件 ID,以及一个
- 可选 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID,也可以是指定可用于你代码的上传文件 ID 以及
+ 的对象,并附带一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -1401,17 +1401,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选指定要运行代码的文件 ID。
+ 代码解释器容器的配置。可选地指定要对其运行代码的文件 ID。
- `type: "auto"`
- 始终 `auto`.
+ 始终为 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1433,7 +1433,7 @@
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。始终为 `disabled`.
- `"disabled"`
@@ -1441,33 +1441,33 @@
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域进行出站网络访问。始终 `allowlist`.
+ 仅允许向指定域的出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 可选的域作用域机密,用于允许列表中的域。
+ 针对允许列表中域的可选域作用域密钥。
- `domain: string`
- 与机密关联的域。
+ 与该密钥关联的域。
- `name: string`
- 要注入该域的机密名称。
+ 为该域注入的密钥名称。
- `value: string`
- 要注入该域的机密值。
+ 为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -1483,7 +1483,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -1493,7 +1493,7 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
@@ -1509,11 +1509,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。选项之一为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT 图像模型。对于 `gpt-image-2` 以及
- `gpt-image-2-2026-04-21`,此支持目前处于预览阶段。使用
- `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ 设置生成图像的背景。以下之一 `transparent`,
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT Image 模型。对于
+ 受支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。使用时
+ `transparent`,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1523,7 +1523,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)方面投入的努力程度。此参数仅受 `gpt-image-1` 以及 `gpt-image-1.5` 及更高版本模型支持,不适用于 `gpt-image-1-mini`。支持 `high` 以及 `low`。默认值为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持, `gpt-image-1-mini`。不支持。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -1531,20 +1531,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选遮罩。包含 `image_url`
+ 用于局部重绘的可选蒙版。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 遮罩图像的文件 ID。
+ 蒙版图像的文件 ID。
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值之一为 `gpt-image-1`,
+ 要使用的图像生成模型。值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -1553,7 +1553,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值之一为 `gpt-image-1`,
+ 要使用的图像生成模型。值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -1570,7 +1570,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -1582,7 +1582,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值之一为 `png`, `webp`,或
+ 生成图像的输出格式。值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -1593,11 +1593,11 @@
- `partial_images: optional number`
- 流式模式下生成的局部图像数量,范围从 0(默认值)到 3。
+ 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。可选值之一为 `low`, `medium`, `high`,
+ 生成图像的质量。值为 `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -1610,13 +1610,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 以及 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式指定,例如 `1536x864`. 宽度和高度都必须能被16整除,且请求的宽高比必须在1:3到3:1之间。高于 `2560x1440` 的分辨率是实验性的,支持的最大分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用 `256x256`, `512x512`,或 `1024x1024`。之一。对于 `dall-e-3`,使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须同时能被 16 整除,且请求的长宽比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性质,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动尺寸的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 以及 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式指定,例如 `1536x864`. 宽度和高度都必须能被16整除,且请求的宽高比必须在1:3到3:1之间。高于 `2560x1440` 的分辨率是实验性的,支持的最大分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边缘限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用 `256x256`, `512x512`,或 `1024x1024`。之一。对于 `dall-e-3`,使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`. 宽度和高度必须同时能被 16 整除,且请求的长宽比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性质,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动尺寸的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -1628,7 +1628,7 @@
- `LocalShell object { type }`
- 一种允许模型在本地环境中执行 shell 命令的工具。
+ 允许模型在本地环境中执行 shell 命令的工具。
- `type: "local_shell"`
@@ -1638,7 +1638,7 @@
- `Shell object { type, allowed_callers, environment }`
- 一种允许模型执行 shell 命令的工具。
+ 允许模型执行 shell 命令的工具。
- `type: "shell"`
@@ -1660,13 +1660,13 @@
- `type: "container_auto"`
- 为此请求自动创建容器
+ 为本次请求自动创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1690,13 +1690,13 @@
- `skills: optional array of SkillReference or InlineSkill`
- 一个可选的技能列表,可通过 ID 或内联数据引用。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
- `skill_id: string`
- 引用的技能的 ID。
+ 所引用技能的 ID。
- `type: "skill_reference"`
@@ -1706,7 +1706,7 @@
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
+ 可选的技能版本。使用正整数或 'latest'。省略时使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -1724,23 +1724,23 @@
- `data: string`
- Base64 编码的技能 zip 压缩包。
+ Base64 编码的 skill zip 包。
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联 skill 负载的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联 skill 源的类型。必须为 `base64`.
- `"base64"`
- `type: "inline"`
- 为本次请求定义一个内联技能。
+ 为本次请求定义一个内联 skill。
- `"inline"`
@@ -1754,7 +1754,7 @@
- `skills: optional array of LocalSkill`
- 可选的技能列表。
+ 可选的 skill 列表。
- `description: string`
@@ -1766,13 +1766,13 @@
- `path: string`
- 包含该技能的目录路径。
+ 包含 skill 的目录路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用的容器 ID。
+ 所引用容器的 ID。
- `type: "container_reference"`
@@ -1782,11 +1782,11 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -1808,7 +1808,7 @@
- `description: optional string`
- 可选的自定义工具描述,用于提供更多上下文。
+ 自定义工具的可选描述,用于提供更多上下文。
- `format: optional CustomToolInputFormat`
@@ -1820,7 +1820,7 @@
- `type: "text"`
- 无约束的文本格式。始终为 `text`.
+ 无约束文本格式。始终为 `text`.
- `"text"`
@@ -1834,7 +1834,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法。之一 `lark` 或 `regex`.
+ 文法定义的语法。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -1842,21 +1842,21 @@
- `type: "grammar"`
- 语法格式。始终 `grammar`.
+ 文法格式。始终为 `grammar`.
- `"grammar"`
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具分组到共享命名空间下。
+ 将函数/自定义工具归入同一命名空间下。
- `description: string`
- 向模型显示的命名空间描述。
+ 展示给模型的命名空间描述。
- `name: string`
- 工具调用中使用的命名空间名称(例如, `crm`).
+ 在工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -1880,27 +1880,27 @@
- `defer_loading: optional boolean`
- 此函数是否应延迟并通过工具搜索发现。
+ 是否应延后此函数并通过工具搜索来发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。这不描述内容数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制严格参数验证。如果省略,Responses 会尝试在模式兼容时使用严格验证,否则回退到非严格验证。
+ 是否强制执行严格的参数校验。如果省略,Responses 会在 Schema 兼容时尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一种使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -1922,7 +1922,7 @@
- `description: optional string`
- 可选的自定义工具描述,用于提供更多上下文。
+ 自定义工具的可选描述,用于提供更多上下文。
- `format: optional CustomToolInputFormat`
@@ -1930,27 +1930,27 @@
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 托管或 BYOT 工具搜索配置,用于延迟工具。
+ 用于延后工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 向模型显示的客户端执行工具搜索工具的描述。
+ 展示给模型的、用于客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是客户端执行。
+ 工具搜索由服务端还是由客户端执行。
- `"server"`
@@ -1958,15 +1958,15 @@
- `parameters: optional unknown or null`
- 客户端执行工具搜索工具的参数模式。
+ 客户端执行的工具搜索工具的参数 Schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具在网络上搜索相关结果以用于响应。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以供回复使用。详细了解 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。其中之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -1980,7 +1980,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指导。其中之一 `low`, `medium`,或 `high`. `medium` 是默认值。
+ 用于搜索的上下文窗口空间使用量的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -1990,11 +1990,11 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
- 位置近似类型。始终 `approximate`.
+ 位置近似值的类型,固定为 `approximate`.
- `"approximate"`
@@ -2004,7 +2004,7 @@
- `country: optional string or null`
- 两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 由两位字母组成的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2016,11 +2016,11 @@
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一差异创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -2034,11 +2034,11 @@
- `top_p: optional number`
- 用于核采样的温度替代参数;1.0 包含所有令牌。
+ 作为核采样替代方案的一个参数;1.0 包含所有 token。
- `error: EvalAPIError`
- 表示 Eval API 错误响应的对象。
+ 表示来自 Eval API 错误响应的对象。
- `code: string`
@@ -2054,16 +2054,16 @@
- `metadata: Metadata or null`
- 一组 16 个键值对,可附加到对象上。这可用于
- 以结构化方式存储对象的附加信息,
- 并通过API或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储有关该对象的附加信息,并通过
+ API 或仪表板查询对象。
键是字符串,最大长度为 64 个字符。值是字符串
,最大长度为 512 个字符。
- `model: string`
- 被评估的模型(如适用)。
+ 被评估的模型(如果适用)。
- `name: string`
@@ -2081,11 +2081,11 @@
- `cached_tokens: number`
- 从缓存中检索的令牌数量。
+ 从缓存中检索到的 token 数。
- `completion_tokens: number`
- 生成的完成令牌数量。
+ 生成的 completion token 数。
- `invocation_count: number`
@@ -2097,11 +2097,11 @@
- `prompt_tokens: number`
- 使用的提示令牌数量。
+ 使用的 prompt token 数。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `per_testing_criteria_results: array of object { failed, passed, testing_criteria }`
@@ -2109,11 +2109,11 @@
- `failed: number`
- 此标准失败的测试数。
+ 此标准下未通过的测试数。
- `passed: number`
- 此标准通过的测试数。
+ 此标准下通过的测试数。
- `testing_criteria: string`
@@ -2121,7 +2121,7 @@
- `report_url: string`
- UI 仪表盘上渲染的评估运行报告的 URL。
+ 在 UI 仪表板上渲染的评估运行报告的 URL。
- `result_counts: object { errored, failed, passed, total }`
@@ -2129,15 +2129,15 @@
- `errored: number`
- 导致错误的输出项数量。
+ 发生错误的输出项数。
- `failed: number`
- 未通过评估的输出项数量。
+ 未通过评估的输出项数。
- `passed: number`
- 通过评估的输出项数量。
+ 通过评估的输出项数。
- `total: number`
@@ -2234,8 +2234,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
"eval_id": "eval_67abd54d9b0081909a86353f6fb9317a",
"report_url": "https://platform.openai.com/evaluations/eval_67abd54d9b0081909a86353f6fb9317a?run_id=evalrun_67abd54d60ec8190832b46859da808f7",
"status": "canceled",
- "model": "gpt-4o-mini",
- "name": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
+ "name": "gpt-5.6-sol",
"created_at": 1743092069,
"result_counts": {
"total": 0,
@@ -2363,11 +2363,8 @@ curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/
}
]
},
- "model": "gpt-4o-mini",
+ "model": "gpt-5.6-sol",
"sampling_params": {
- "seed": 42,
- "temperature": 1.0,
- "top_p": 1.0,
"max_completions_tokens": 2048
}
},
diff --git a/docs/zh/api/reference/resources/fine_tuning.md b/docs/zh/api/reference/resources/fine_tuning.md
index 5bfcf3e..450ed4b 100644
--- a/docs/zh/api/reference/resources/fine_tuning.md
+++ b/docs/zh/api/reference/resources/fine_tuning.md
@@ -1,6 +1,6 @@
# 微调
-> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。
+> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取文档页面的 Markdown 版本。
# Alpha
@@ -10,21 +10,21 @@
**post** `/fine_tuning/alpha/graders/run`
-运行一个评分器。
+运行评分器。
### 请求体参数
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -32,7 +32,7 @@
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -44,7 +44,7 @@
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -54,11 +54,11 @@
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -94,7 +94,7 @@
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -104,7 +104,7 @@
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -126,15 +126,15 @@
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -156,7 +156,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -180,7 +180,7 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -194,7 +194,7 @@
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -208,7 +208,7 @@
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -223,7 +223,7 @@
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -250,7 +250,7 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -264,7 +264,7 @@
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -272,7 +272,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -305,7 +305,7 @@
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -313,17 +313,17 @@
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -345,50 +345,50 @@
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -414,7 +414,7 @@
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -428,7 +428,7 @@
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -436,12 +436,12 @@
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -460,7 +460,7 @@
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -472,7 +472,7 @@
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -492,15 +492,15 @@
- `model_sample: string`
- 要评估的模型样本。该值将用于填充
- 该 `sample` 命名空间。请参阅 [该指南](/docs/guides/graders) 了解更多详情。
- 该 `output_json` 如果模型样本是
- 有效的 JSON 字符串,该变量将被填充。
+ 待评估的模型输出样例。此值将用于填充
+ 该 `sample` namespace。参见 [指南](/docs/guides/graders) 了解更多信息。
+ 该 `output_json` 变量将在模型输出样例为
+ 有效的 JSON 字符串时被填充。
- `item: optional unknown`
- 提供给评分器的数据集项目。这将用于填充
- 该 `item` 命名空间。请参阅 [该指南](/docs/guides/graders) 了解更多详情。
+ 提供给评分器的数据集数据项。将用于填充
+ 该 `item` namespace。参见 [指南](/docs/guides/graders) 了解更多信息。
### 返回值
@@ -655,7 +655,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
}'
```
-### 对图像标题进行评分
+### 对图片说明进行评分
```http
curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
@@ -761,11 +761,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
"completion_tokens": 134,
"cached_tokens": 0
},
- "sampled_model_name": "gpt-4o-2024-08-06"
+ "sampled_model_name": "gpt-5-mini"
},
"sub_rewards": {},
"model_grader_token_usage_per_model": {
- "gpt-4o-2024-08-06": {
+ "gpt-5-mini": {
"prompt_tokens": 190,
"total_tokens": 324,
"completion_tokens": 134,
@@ -785,15 +785,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -801,7 +801,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -813,7 +813,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -823,11 +823,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -863,7 +863,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -873,7 +873,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -895,15 +895,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -925,7 +925,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -949,7 +949,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -963,7 +963,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -977,7 +977,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -992,7 +992,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -1019,7 +1019,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -1033,7 +1033,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1041,7 +1041,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -1074,7 +1074,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -1082,17 +1082,17 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -1114,50 +1114,50 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -1183,7 +1183,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -1197,7 +1197,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1205,12 +1205,12 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -1229,7 +1229,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -1241,7 +1241,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -1263,15 +1263,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `grader: optional StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -1279,7 +1279,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -1291,7 +1291,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -1301,11 +1301,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -1341,7 +1341,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -1351,7 +1351,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -1373,15 +1373,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -1403,7 +1403,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1427,7 +1427,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -1441,7 +1441,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1455,7 +1455,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -1470,7 +1470,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -1497,7 +1497,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -1511,7 +1511,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1519,7 +1519,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -1552,7 +1552,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -1560,17 +1560,17 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -1592,50 +1592,50 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -1661,7 +1661,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -1675,7 +1675,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -1683,12 +1683,12 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -1707,7 +1707,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -1719,7 +1719,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -1799,9 +1799,9 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
}
```
-## 领域类型
+## 域类型
-### 评分器运行响应
+### Grader 运行响应
- `GraderRunResponse object { metadata, model_grader_token_usage_per_model, reward, sub_rewards }`
@@ -1855,21 +1855,21 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `sub_rewards: map[unknown]`
-### 评分器验证响应
+### Grader 校验响应
- `GraderValidateResponse object { grader }`
- `grader: optional StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -1877,7 +1877,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -1889,7 +1889,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -1899,11 +1899,11 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -1939,7 +1939,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -1949,7 +1949,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -1971,15 +1971,15 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -2001,7 +2001,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -2025,7 +2025,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -2039,7 +2039,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2053,7 +2053,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -2068,7 +2068,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -2095,7 +2095,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -2109,7 +2109,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2117,7 +2117,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -2150,7 +2150,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -2158,17 +2158,17 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -2190,50 +2190,50 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -2259,7 +2259,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -2273,7 +2273,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -2281,12 +2281,12 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -2305,7 +2305,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -2317,7 +2317,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -2345,7 +2345,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
**注意:** 调用此端点需要 [管理员 API 密钥](../admin-api-keys).
-这使组织所有者能够与组织内的其他项目共享微调模型。
+这使组织所有者能够将微调模型共享给其组织内的其他项目。
### 路径参数
@@ -2355,7 +2355,7 @@ curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \
- `project_ids: array of string`
- 要授予访问权限的项目标识符。
+ 授予访问权限的项目标识符。
### 返回值
@@ -2448,13 +2448,13 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
}
```
-## 删除检查点权限
+## 删除 checkpoint 权限
-**删除** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}`
+**delete** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}`
**注意:** 此端点需要一个 [管理员 API 密钥](../admin-api-keys).
-组织所有者可以使用此端点删除针对已微调模型检查点的权限。
+组织所有者可使用此端点删除某个微调模型检查点的权限。
### 路径参数
@@ -2513,13 +2513,13 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
}
```
-## 列出检查点权限
+## 列检查点权限
**get** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`
**注意:** 此端点需要一个 [管理员 API 密钥](../admin-api-keys).
-组织所有者可以使用此端点查看微调模型检查点的所有权限。
+组织所有者可以使用此端点查看某个微调模型检查点的所有权限。
### 路径参数
@@ -2529,7 +2529,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `after: optional string`
- 上一次分页请求中最后一个权限 ID 的标识符。
+ 上一页分页请求中最后一个权限 ID 的标识符。
- `limit: optional number`
@@ -2537,7 +2537,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `order: optional "ascending" or "descending"`
- 检索权限的顺序。
+ 检索权限时所采用的顺序。
- `"ascending"`
@@ -2545,7 +2545,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `project_id: optional string`
- 要获取权限的项目 ID。
+ 要获取其权限的项目 ID。
### 返回值
@@ -2637,13 +2637,13 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
}
```
-## 列出检查点权限
+## 列检查点权限
**get** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`
**注意:** 此端点需要一个 [管理员 API 密钥](../admin-api-keys).
-组织所有者可以使用此端点查看微调模型检查点的所有权限。
+组织所有者可以使用此端点查看某个微调模型检查点的所有权限。
### 路径参数
@@ -2653,7 +2653,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `after: optional string`
- 上一次分页请求中最后一个权限 ID 的标识符。
+ 上一页分页请求中最后一个权限 ID 的标识符。
- `limit: optional number`
@@ -2661,7 +2661,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `order: optional "ascending" or "descending"`
- 检索权限的顺序。
+ 检索权限时所采用的顺序。
- `"ascending"`
@@ -2669,7 +2669,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `project_id: optional string`
- 要获取权限的项目 ID。
+ 要获取其权限的项目 ID。
### 返回值
@@ -2761,13 +2761,13 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
}
```
-## 领域类型
+## 域类型
-### 权限 创建响应
+### Permission Create Response
- `PermissionCreateResponse object { id, created_at, object, project_id }`
- 该 `checkpoint.permission` 对象表示微调模型检查点的权限。
+ 该 `checkpoint.permission` object 表示某个微调模型检查点的权限。
- `id: string`
@@ -2787,7 +2787,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
该权限对应的项目标识符。
-### 权限删除响应
+### Permission Delete 响应
- `PermissionDeleteResponse object { id, deleted, object }`
@@ -2805,11 +2805,11 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `"checkpoint.permission"`
-### 权限列表响应
+### Permission List 响应
- `PermissionListResponse object { id, created_at, object, project_id }`
- 该 `checkpoint.permission` 对象表示微调模型检查点的权限。
+ 该 `checkpoint.permission` object 表示某个微调模型检查点的权限。
- `id: string`
@@ -2829,7 +2829,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
该权限对应的项目标识符。
-### 权限检索响应
+### Permission Retrieve 响应
- `PermissionRetrieveResponse object { data, has_more, object, 2 more }`
@@ -2863,13 +2863,13 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `last_id: optional string or null`
-# 作业
+# Jobs
## 取消微调
**post** `/fine_tuning/jobs/{fine_tuning_job_id}/cancel`
-立即取消微调任务。
+立即取消微调作业。
### 路径参数
@@ -2879,7 +2879,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `FineTuningJob object { id, created_at, error, 16 more }`
- 该 `fine_tuning.job` 对象表示一个已通过 API 创建的微调作业。
+ 该 `fine_tuning.job` 对象表示已通过 API 创建的微调作业。
- `id: string`
@@ -2887,11 +2887,11 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -2903,24 +2903,24 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -2941,8 +2941,8 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -2952,7 +2952,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -2962,19 +2962,19 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -2990,19 +2990,19 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -3016,35 +3016,35 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -3053,7 +3053,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -3067,11 +3067,11 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -3081,7 +3081,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -3101,7 +3101,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -3115,15 +3115,15 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -3131,7 +3131,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -3143,7 +3143,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -3153,11 +3153,11 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -3193,7 +3193,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -3203,7 +3203,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -3225,15 +3225,15 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -3255,7 +3255,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -3279,7 +3279,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -3293,7 +3293,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3307,7 +3307,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -3322,7 +3322,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -3349,7 +3349,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -3363,7 +3363,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3371,7 +3371,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -3404,7 +3404,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -3412,17 +3412,17 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -3444,50 +3444,50 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -3513,7 +3513,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -3527,7 +3527,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -3535,12 +3535,12 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -3559,7 +3559,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -3571,7 +3571,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -3591,11 +3591,11 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -3615,7 +3615,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -3625,7 +3625,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -3645,7 +3645,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -3655,7 +3655,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -3671,11 +3671,11 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -3695,7 +3695,7 @@ curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -3820,29 +3820,29 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
}
```
-## 创建微调作业
+## 创建微调任务
**post** `/fine_tuning/jobs`
-创建微调作业,该作业将开始从给定数据集创建新模型的过程。
+创建一个微调作业,开始从给定数据集构建新模型的过程。
-响应包含排队作业的详细信息,包括作业状态以及完成后的微调模型名称。
+响应包括已排队作业的详细信息,包括作业状态以及完成后微调模型的名称。
-[了解更多关于微调的信息](/docs/guides/model-optimization)
+[了解有关微调的更多信息](/docs/guides/model-optimization)
### 请求体参数
- `model: string or "babbage-002" or "davinci-002" or "gpt-3.5-turbo" or "gpt-4o-mini"`
- 用于微调的模型名称。你可以选择以下
- [受支持的模型](/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
+ 要微调的模型名称。你可以从以下列表中选择一个
+ [支持的模型](/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
- `string`
- `"babbage-002" or "davinci-002" or "gpt-3.5-turbo" or "gpt-4o-mini"`
- 用于微调的模型名称。你可以选择以下
- [受支持的模型](/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
+ 要微调的模型名称。你可以从以下列表中选择一个
+ [支持的模型](/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
- `"babbage-002"`
@@ -3854,25 +3854,25 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `training_file: string`
- 包含训练数据的已上传文件的 ID。
+ 包含训练数据的上传文件的 ID。
- 参见 [上传文件](/docs/api-reference/files/create) 了解如何上传文件。
+ 参见 [upload file](/docs/api-reference/files/create) 了解如何上传文件。
- 你的数据集必须格式化为 JSONL 文件。此外,你必须以上传目的 `fine-tune`.
+ 你的数据集必须格式化为 JSONL 文件。此外,你必须使用以下用途上传你的文件 `fine-tune`.
- 上传文件。文件内容应根据模型使用的是 [聊天](/docs/api-reference/fine-tuning/chat-input), [补全](/docs/api-reference/fine-tuning/completions-input) 格式,还是微调方法使用的是 [偏好](/docs/api-reference/fine-tuning/preference-input) 格式而有所不同。
+ 文件内容因模型使用的是 [chat](/docs/api-reference/fine-tuning/chat-input), [completions](/docs/api-reference/fine-tuning/completions-input) 格式,还是微调方法使用的是 [preference](/docs/api-reference/fine-tuning/preference-input) 格式而有所不同。
- 参见 [微调指南](/docs/guides/model-optimization) 了解更多详情。
+ 参见 [fine-tuning guide](/docs/guides/model-optimization) 了解更多信息。
- `hyperparameters: optional object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。
- 此值已弃用,请改用 `method`,应将其传入 `method` 参数。
+ 用于微调任务的超参数。
+ 该值现已弃用,推荐使用 `method`,应通过以下参数传入 `method` 参数。
- `batch_size: optional "auto" or number`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -3893,8 +3893,8 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -3904,45 +3904,45 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `integrations: optional array of object { type, wandb } or null`
- 要为你的微调作业启用的集成列表。
+ 为微调任务启用的集成列表。
- `type: "wandb"`
- 要启用的集成类型。目前仅支持“wandb”(Weights and Biases)。
+ 要启用的集成类型。目前仅支持 "wandb"(Weights and Biases)。
- `"wandb"`
- `wandb: object { project, entity, name, tags }`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -3951,7 +3951,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -3965,11 +3965,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -3979,7 +3979,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -3999,7 +3999,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -4013,15 +4013,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -4029,7 +4029,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -4041,7 +4041,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -4051,11 +4051,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -4091,7 +4091,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -4101,7 +4101,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -4123,15 +4123,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -4153,7 +4153,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -4177,7 +4177,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -4191,7 +4191,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -4205,7 +4205,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -4220,7 +4220,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -4247,7 +4247,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -4261,7 +4261,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -4269,7 +4269,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -4302,7 +4302,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -4310,17 +4310,17 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -4342,50 +4342,50 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -4411,7 +4411,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -4425,7 +4425,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -4433,12 +4433,12 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -4457,7 +4457,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -4469,7 +4469,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -4489,11 +4489,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -4513,7 +4513,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -4523,7 +4523,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -4543,7 +4543,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -4553,7 +4553,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -4569,11 +4569,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -4593,7 +4593,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -4603,33 +4603,33 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `seed: optional number or null`
- 该种子控制任务的复现性。传入相同的种子和任务参数应产生相同的结果,但在极少数情况下可能会有所不同。
- 如果未指定种子,将为你生成一个。
+ seed 用于控制任务的可复现性。传入相同的 seed 和任务参数应能产生相同的结果,但在极少数情况下可能会有所不同。
+ 如果未指定 seed,系统会为你生成一个。
- `suffix: optional string or null`
- 一个最多 64 个字符的字符串,将添加到你的微调模型名称中。
+ 一段最多 64 个字符的字符串,将被添加到你微调后的模型名称中。
- 例如,一个 `suffix` 为“custom-model-name”的 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.
+ 例如,一个 `suffix` 为 "custom-model-name" 会生成类似下面的模型名称 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.
- `validation_file: optional string or null`
- 包含验证数据的上传文件的 ID。
+ 已上传文件的 ID,该文件包含验证数据。
- 如果提供此文件,则数据将用于在微调期间定期生成验证
+ 如果你提供此文件,数据将用于在微调过程中定期生成验证
指标。这些指标可以在
微调结果文件中查看。
- 相同的数据不应同时出现在训练文件和验证文件中。
+ 同一份数据不应同时出现在训练文件和验证文件中。
- 你的数据集必须格式化为 JSONL 文件。你必须以 `fine-tune`.
+ 你的数据集必须格式化为 JSONL 文件。你必须使用以下用途上传你的文件 `fine-tune`.
- 参见 [微调指南](/docs/guides/model-optimization) 了解更多详情。
+ 参见 [fine-tuning guide](/docs/guides/model-optimization) 了解更多信息。
### 返回值
- `FineTuningJob object { id, created_at, error, 16 more }`
- 该 `fine_tuning.job` 对象表示一个已通过 API 创建的微调作业。
+ 该 `fine_tuning.job` 对象表示已通过 API 创建的微调作业。
- `id: string`
@@ -4637,11 +4637,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -4653,24 +4653,24 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -4691,8 +4691,8 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -4702,7 +4702,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -4712,19 +4712,19 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -4740,19 +4740,19 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -4766,35 +4766,35 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -4803,7 +4803,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -4817,11 +4817,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -4831,7 +4831,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -4851,7 +4851,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -4865,15 +4865,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -4881,7 +4881,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -4893,7 +4893,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -4903,11 +4903,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -4943,7 +4943,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -4953,7 +4953,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -4975,15 +4975,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -5005,7 +5005,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -5029,7 +5029,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -5043,7 +5043,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -5057,7 +5057,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -5072,7 +5072,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -5099,7 +5099,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -5113,7 +5113,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -5121,7 +5121,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -5154,7 +5154,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -5162,17 +5162,17 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -5194,50 +5194,50 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -5263,7 +5263,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -5277,7 +5277,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -5285,12 +5285,12 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -5309,7 +5309,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -5321,7 +5321,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -5341,11 +5341,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -5365,7 +5365,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -5375,7 +5375,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -5395,7 +5395,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -5405,7 +5405,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -5421,11 +5421,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -5445,7 +5445,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -5655,7 +5655,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
}
```
-### 周期
+### 训练轮次
```http
curl https://api.openai.com/v1/fine_tuning/jobs \
@@ -5799,7 +5799,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
```
-### 验证文件
+### 校验文件
```http
curl https://api.openai.com/v1/fine_tuning/jobs \
@@ -5903,25 +5903,25 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
}
```
-## 列出微调作业
+## 列出微调任务
**get** `/fine_tuning/jobs`
-列出你所在组织的微调作业
+列出你所在组织的微调任务
### 查询参数
- `after: optional string`
- 上一次分页请求中最后一个作业的标识符。
+ 上一次分页请求中最后一个任务的标识符。
- `limit: optional number`
- 要检索的微调作业数量。
+ 要检索的微调任务数量。
- `metadata: optional map[string] or null`
- 可选的元数据过滤器。要使用过滤器,请使用语法 `metadata[k]=v`。或者,设置 `metadata=null` 以表示无元数据。
+ 可选的元数据过滤器。若要进行过滤,请使用以下语法 `metadata[k]=v`. 或者,也可以设置 `metadata=null` 以表示无元数据。
### 返回值
@@ -5933,11 +5933,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -5949,24 +5949,24 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -5987,8 +5987,8 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -5998,7 +5998,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -6008,19 +6008,19 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -6036,19 +6036,19 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -6062,35 +6062,35 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -6099,7 +6099,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -6113,11 +6113,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -6127,7 +6127,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -6147,7 +6147,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -6161,15 +6161,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -6177,7 +6177,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -6189,7 +6189,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -6199,11 +6199,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -6239,7 +6239,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -6249,7 +6249,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -6271,15 +6271,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -6301,7 +6301,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -6325,7 +6325,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -6339,7 +6339,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -6353,7 +6353,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -6368,7 +6368,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -6395,7 +6395,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -6409,7 +6409,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -6417,7 +6417,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -6450,7 +6450,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -6458,17 +6458,17 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -6490,50 +6490,50 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -6559,7 +6559,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -6573,7 +6573,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -6581,12 +6581,12 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -6605,7 +6605,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -6617,7 +6617,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -6637,11 +6637,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -6661,7 +6661,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -6671,7 +6671,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -6691,7 +6691,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -6701,7 +6701,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -6717,11 +6717,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -6741,7 +6741,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -6891,7 +6891,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value \
**get** `/fine_tuning/jobs/{fine_tuning_job_id}/events`
-获取微调作业的状态更新。
+获取微调任务的状态更新。
### 路径参数
@@ -6901,7 +6901,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value \
- `after: optional string`
- 上一次分页请求中最后一个事件的标识符。
+ 上一次分页请求中最后一条事件的标识符。
- `limit: optional number`
@@ -6917,7 +6917,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `level: "info" or "warn" or "error"`
@@ -6941,11 +6941,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value \
- `data: optional unknown`
- 与该事件关联的数据。
+ 与事件关联的数据。
- `type: optional "message" or "metrics"`
- 事件类型。
+ 事件的类型。
- `"message"`
@@ -7024,7 +7024,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
**post** `/fine_tuning/jobs/{fine_tuning_job_id}/pause`
-暂停一个微调任务。
+暂停微调任务。
### 路径参数
@@ -7034,7 +7034,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `FineTuningJob object { id, created_at, error, 16 more }`
- 该 `fine_tuning.job` 对象表示一个已通过 API 创建的微调作业。
+ 该 `fine_tuning.job` 对象表示已通过 API 创建的微调作业。
- `id: string`
@@ -7042,11 +7042,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -7058,24 +7058,24 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -7096,8 +7096,8 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -7107,7 +7107,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -7117,19 +7117,19 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -7145,19 +7145,19 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -7171,35 +7171,35 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -7208,7 +7208,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -7222,11 +7222,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -7236,7 +7236,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -7256,7 +7256,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -7270,15 +7270,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -7286,7 +7286,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -7298,7 +7298,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -7308,11 +7308,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -7348,7 +7348,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -7358,7 +7358,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -7380,15 +7380,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -7410,7 +7410,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -7434,7 +7434,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -7448,7 +7448,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -7462,7 +7462,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -7477,7 +7477,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -7504,7 +7504,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -7518,7 +7518,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -7526,7 +7526,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -7559,7 +7559,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -7567,17 +7567,17 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -7599,50 +7599,50 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -7668,7 +7668,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -7682,7 +7682,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -7690,12 +7690,12 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -7714,7 +7714,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -7726,7 +7726,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -7746,11 +7746,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -7770,7 +7770,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -7780,7 +7780,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -7800,7 +7800,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -7810,7 +7810,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -7826,11 +7826,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -7850,7 +7850,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -7975,11 +7975,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
}
```
-## 恢复微调
+## Resume fine-tuning
**post** `/fine_tuning/jobs/{fine_tuning_job_id}/resume`
-恢复微调作业。
+恢复一个微调任务。
### 路径参数
@@ -7989,7 +7989,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `FineTuningJob object { id, created_at, error, 16 more }`
- 该 `fine_tuning.job` 对象表示一个已通过 API 创建的微调作业。
+ 该 `fine_tuning.job` 对象表示已通过 API 创建的微调作业。
- `id: string`
@@ -7997,11 +7997,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -8013,24 +8013,24 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -8051,8 +8051,8 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -8062,7 +8062,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -8072,19 +8072,19 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -8100,19 +8100,19 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -8126,35 +8126,35 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -8163,7 +8163,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -8177,11 +8177,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -8191,7 +8191,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -8211,7 +8211,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -8225,15 +8225,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -8241,7 +8241,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -8253,7 +8253,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -8263,11 +8263,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -8303,7 +8303,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -8313,7 +8313,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -8335,15 +8335,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -8365,7 +8365,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -8389,7 +8389,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -8403,7 +8403,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -8417,7 +8417,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -8432,7 +8432,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -8459,7 +8459,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -8473,7 +8473,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -8481,7 +8481,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -8514,7 +8514,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -8522,17 +8522,17 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -8554,50 +8554,50 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -8623,7 +8623,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -8637,7 +8637,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -8645,12 +8645,12 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -8669,7 +8669,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -8681,7 +8681,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -8701,11 +8701,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -8725,7 +8725,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -8735,7 +8735,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -8755,7 +8755,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -8765,7 +8765,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -8781,11 +8781,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -8805,7 +8805,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -8930,13 +8930,13 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
}
```
-## 检索微调作业
+## 检索微调任务
**get** `/fine_tuning/jobs/{fine_tuning_job_id}`
获取有关微调作业的信息。
-[了解更多关于微调的信息](/docs/guides/model-optimization)
+[了解有关微调的更多信息](/docs/guides/model-optimization)
### 路径参数
@@ -8946,7 +8946,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `FineTuningJob object { id, created_at, error, 16 more }`
- 该 `fine_tuning.job` 对象表示一个已通过 API 创建的微调作业。
+ 该 `fine_tuning.job` 对象表示已通过 API 创建的微调作业。
- `id: string`
@@ -8954,11 +8954,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -8970,24 +8970,24 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -9008,8 +9008,8 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -9019,7 +9019,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -9029,19 +9029,19 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -9057,19 +9057,19 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -9083,35 +9083,35 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -9120,7 +9120,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -9134,11 +9134,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -9148,7 +9148,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -9168,7 +9168,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -9182,15 +9182,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -9198,7 +9198,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -9210,7 +9210,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -9220,11 +9220,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -9260,7 +9260,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -9270,7 +9270,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -9292,15 +9292,15 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -9322,7 +9322,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -9346,7 +9346,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -9360,7 +9360,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -9374,7 +9374,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -9389,7 +9389,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -9416,7 +9416,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -9430,7 +9430,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -9438,7 +9438,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -9471,7 +9471,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -9479,17 +9479,17 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -9511,50 +9511,50 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -9580,7 +9580,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -9594,7 +9594,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -9602,12 +9602,12 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -9626,7 +9626,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -9638,7 +9638,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -9658,11 +9658,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -9682,7 +9682,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -9692,7 +9692,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -9712,7 +9712,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -9722,7 +9722,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -9738,11 +9738,11 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -9762,7 +9762,7 @@ curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -9908,13 +9908,13 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
}
```
-## 领域类型
+## 域类型
### 微调任务
- `FineTuningJob object { id, created_at, error, 16 more }`
- 该 `fine_tuning.job` 对象表示一个已通过 API 创建的微调作业。
+ 该 `fine_tuning.job` 对象表示已通过 API 创建的微调作业。
- `id: string`
@@ -9922,11 +9922,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `error: object { code, message, param } or null`
- 对于已失败的微调作业 `failed`,此处将包含有关失败原因的更多信息。
+ 对于已 `failed`,的微调作业,这将包含有关失败原因的更多信息。
- `code: string`
@@ -9938,24 +9938,24 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `param: string or null`
- 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败与特定参数无关,此字段将为 null。
+ 无效的参数,通常为 `training_file` 或 `validation_file`。如果失败并非由特定参数导致,该字段将为 null。
- `fine_tuned_model: string or null`
- 正在创建的微调模型的名称。如果微调作业仍在运行,此值将为 null。
+ 正在创建的微调模型的名称。如果微调作业仍在运行,该值为 null。
- `finished_at: number or null`
- 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,此值将为 null。
+ 微调作业完成时的 Unix 时间戳(以秒为单位)。如果微调作业仍在运行,该值为 null。
- `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。
+ 用于微调作业的超参数。仅在运行 `supervised` 作业时返回此值。
- `batch_size: optional "auto" or number or null`
- 每个批次中的示例数量。较大的批次大小意味着模型参数
- 更新的频率较低,但方差较小。
+ 每个批次中的样本数量。更大的批次大小意味着模型参数
+ 更新频率更低,但方差更小。
- `"auto"`
@@ -9976,8 +9976,8 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指完整遍历训练数据集
- 一次。
+ 训练模型的轮次(epoch)数。一个 epoch 表示对训练数据集进行
+ 一次完整的遍历。
- `"auto"`
@@ -9987,7 +9987,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `model: string`
- 正在进行微调的基础模型。
+ 正在被微调的基模型。
- `object: "fine_tuning.job"`
@@ -9997,19 +9997,19 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `organization_id: string`
- 拥有此微调作业的组织。
+ 拥有该微调作业的组织。
- `result_files: array of string`
- 微调作业的编译结果文件 ID。你可以通过以下方式检索结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 该微调作业的编译结果文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `seed: number`
- 微调作业使用的种子。
+ 微调作业所使用的随机种子。
- `status: "validating_files" or "queued" or "running" or 3 more`
- 微调作业的当前状态,可以是 `validating_files`, `queued`, `running`, `succeeded`, `failed`,或 `cancelled`.
+ 微调作业的当前状态,可能为 `validating_files`, `queued`, `running`, `succeeded`, `failed`,之一,或 `cancelled`.
- `"validating_files"`
@@ -10025,19 +10025,19 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `trained_tokens: number or null`
- 此微调作业处理的可计费令牌总数。如果微调作业仍在运行,该值将为 null。
+ 此微调作业处理的可计费 token 总数。如果微调作业仍在运行,则该值为 null。
- `training_file: string`
- 用于训练的文件 ID。你可以通过以下方式检索训练数据: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于训练的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `validation_file: string or null`
- 用于验证的文件 ID。你可以通过以下方式检索验证结果: [文件 API](/docs/api-reference/files/retrieve-contents).
+ 用于验证的文件 ID。可通过 [Files API](/docs/api-reference/files/retrieve-contents).
- `estimated_finish: optional number or null`
- 微调作业预计完成的 Unix 时间戳(秒)。如果微调作业未在运行,该值将为 null。
+ 微调作业预计完成时间的 Unix 时间戳(以秒为单位)。如果微调作业未运行,则该值为 null。
- `integrations: optional array of FineTuningJobWandbIntegrationObject or null`
@@ -10051,35 +10051,35 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
- `metadata: optional Metadata or null`
- 可附加到对象上的 16 对键值对。这可以
- 用于以结构化格式存储关于对象的额外信息,
- 并通过 API 或仪表盘查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。
+ 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串,
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `method: optional object { type, dpo, reinforcement, supervised }`
@@ -10088,7 +10088,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `type: "supervised" or "dpo" or "reinforcement"`
- 方法的类型。可以是 `supervised`, `dpo`,或 `reinforcement`.
+ 方法的类型。值为 `supervised`, `dpo`,之一,或 `reinforcement`.
- `"supervised"`
@@ -10102,11 +10102,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -10116,7 +10116,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -10136,7 +10136,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -10150,15 +10150,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -10166,7 +10166,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -10178,7 +10178,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -10188,11 +10188,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -10228,7 +10228,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -10238,7 +10238,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -10260,15 +10260,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -10290,7 +10290,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -10314,7 +10314,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -10328,7 +10328,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -10342,7 +10342,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -10357,7 +10357,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -10384,7 +10384,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -10398,7 +10398,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -10406,7 +10406,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -10439,7 +10439,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -10447,17 +10447,17 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -10479,50 +10479,50 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -10548,7 +10548,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -10562,7 +10562,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -10570,12 +10570,12 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -10594,7 +10594,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -10606,7 +10606,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -10626,11 +10626,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -10650,7 +10650,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -10660,7 +10660,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -10680,7 +10680,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -10690,7 +10690,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -10706,11 +10706,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -10730,7 +10730,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -10742,7 +10742,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `FineTuningJobEvent object { id, created_at, level, 4 more }`
- 微调任务事件对象
+ 微调作业事件对象
- `id: string`
@@ -10750,7 +10750,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `created_at: number`
- 创建微调作业时的 Unix 时间戳(以秒为单位)。
+ 微调作业创建时的 Unix 时间戳(以秒为单位)。
- `level: "info" or "warn" or "error"`
@@ -10774,43 +10774,43 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `data: optional unknown`
- 与该事件关联的数据。
+ 与事件关联的数据。
- `type: optional "message" or "metrics"`
- 事件类型。
+ 事件的类型。
- `"message"`
- `"metrics"`
-### 微调任务 Wandb 集成
+### 微调作业 Wandb 集成
- `FineTuningJobWandbIntegration object { project, entity, name, tags }`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
-### 微调任务 Wandb 集成对象
+### 微调作业 Wandb 集成对象
- `FineTuningJobWandbIntegrationObject object { type, wandb }`
@@ -10822,26 +10822,26 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `wandb: FineTuningJobWandbIntegration`
- 与 Weights and Biases 集成的设置。此负载指定了将
- 指标发送到的项目。可选地,你可以为运行设置显式显示名称,添加标签
- 到运行中,并设置要与运行关联的默认实体(团队、用户名等)。
+ 与 Weights and Biases 集成的设置。此负载指定了指标将发送到的项目。可选地,你可以为运行设置显式显示名称、添加标签
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
+ 到你的运行中,并设置与运行关联的默认实体(团队、用户名等)。
- `project: string`
- 新运行将创建于的项目名称。
+ 将在其中创建新运行的项目名称。
- `entity: optional string or null`
- 用于运行的实体。这允许你设置与运行关联的 WandB 用户的团队或用户名,
- 如果未设置,则使用已注册的 WandB API 密钥的默认实体。
+ 运行所使用的实体。这允许你设置希望与运行关联的 WandB 用户的团队或用户名。如未设置,
+ 将使用已注册 WandB API 密钥的默认实体。
- `name: optional string or null`
- 为运行设置的显示名称。如果未设置,我们将使用作业 ID 作为名称。
+ 为运行设置的显示名称。如未设置,将使用作业 ID 作为名称。
- `tags: optional array of string`
- 要附加到新创建的运行的标签列表。这些标签直接传递给 WandB。部分
+ 要附加到新创建运行的标签列表。这些标签会直接传递给 WandB。某些
默认标签由 OpenAI 生成:"openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}".
# 检查点
@@ -10850,7 +10850,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
**get** `/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints`
-列出微调作业的检查点。
+列出某个微调任务的检查点。
### 路径参数
@@ -10860,11 +10860,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `after: optional string`
- 上一次分页请求的最后一个检查点 ID 的标识符。
+ 上一次分页请求中最后一个 checkpoint ID 的标识符。
- `limit: optional number`
- 要检索的检查点数量。
+ 要检索的 checkpoint 数量。
### 返回值
@@ -10872,23 +10872,23 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `id: string`
- 检查点标识符,可在 API 端点中引用。
+ Checkpoint 标识符,可在 API 端点中引用。
- `created_at: number`
- 创建检查点时的 Unix 时间戳(秒)。
+ Checkpoint 创建时的 Unix 时间戳(以秒为单位)。
- `fine_tuned_model_checkpoint: string`
- 所创建的微调检查点模型的名称。
+ 所创建微调 checkpoint 模型的名称。
- `fine_tuning_job_id: string`
- 创建此检查点所依据的微调作业的名称。
+ 创建此 checkpoint 的微调任务的名称。
- `metrics: object { full_valid_loss, full_valid_mean_token_accuracy, step, 4 more }`
- 微调作业期间在步骤编号处的指标。
+ 微调任务中指定步数处的指标。
- `full_valid_loss: optional number`
@@ -10912,7 +10912,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \
- `step_number: number`
- 创建检查点时所处的步骤编号。
+ 创建 checkpoint 时所处的步数。
- `has_more: boolean`
@@ -11005,33 +11005,33 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
}
```
-## 领域类型
+## 域类型
### 微调作业检查点
- `FineTuningJobCheckpoint object { id, created_at, fine_tuned_model_checkpoint, 4 more }`
- 该 `fine_tuning.job.checkpoint` 对象表示微调作业中可随时使用的模型检查点。
+ 该 `fine_tuning.job.checkpoint` object 表示一个可用于微调任务的模型检查点。
- `id: string`
- 检查点标识符,可在 API 端点中引用。
+ Checkpoint 标识符,可在 API 端点中引用。
- `created_at: number`
- 创建检查点时的 Unix 时间戳(秒)。
+ Checkpoint 创建时的 Unix 时间戳(以秒为单位)。
- `fine_tuned_model_checkpoint: string`
- 所创建的微调检查点模型的名称。
+ 所创建微调 checkpoint 模型的名称。
- `fine_tuning_job_id: string`
- 创建此检查点所依据的微调作业的名称。
+ 创建此 checkpoint 的微调任务的名称。
- `metrics: object { full_valid_loss, full_valid_mean_token_accuracy, step, 4 more }`
- 微调作业期间在步骤编号处的指标。
+ 微调任务中指定步数处的指标。
- `full_valid_loss: optional number`
@@ -11055,21 +11055,21 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `step_number: number`
- 创建检查点时所处的步骤编号。
+ 创建 checkpoint 时所处的步数。
# 方法
-## 领域类型
+## 域类型
-### DPO 超参数
+### Dpo 超参数
- `DpoHyperparameters object { batch_size, beta, learning_rate_multiplier, n_epochs }`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -11079,7 +11079,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -11099,7 +11099,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -11107,7 +11107,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `number`
-### DPO 方法
+### Dpo 方法
- `DpoMethod object { hyperparameters }`
@@ -11115,11 +11115,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `hyperparameters: optional DpoHyperparameters`
- 用于 DPO 微调作业的超参数。
+ 用于 DPO 微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -11129,7 +11129,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `beta: optional "auto" or number`
- DPO 方法的 beta 值。较高的 beta 值会增加策略模型和参考模型之间惩罚的权重。
+ DPO 方法的 beta 值。较高的 beta 值会增大策略模型与参考模型之间惩罚项的权重。
- `"auto"`
@@ -11149,7 +11149,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -11157,15 +11157,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `number`
-### 强化学习超参数
+### 强化超参数
- `ReinforcementHyperparameters object { batch_size, compute_multiplier, eval_interval, 4 more }`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -11185,7 +11185,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -11195,7 +11195,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -11215,7 +11215,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -11225,7 +11225,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -11235,7 +11235,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `"high"`
-### 强化学习方法
+### 强化方法
- `ReinforcementMethod object { grader, hyperparameters }`
@@ -11243,15 +11243,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `grader: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 用于微调作业的评分器。
+ 用于微调任务的评分器。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `input: string`
- 输入文本。这可能包括模板字符串。
+ 输入文本。可以包含模板字符串。
- `name: string`
@@ -11259,7 +11259,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `operation: "eq" or "ne" or "like" or "ilike"`
- 要执行的字符串检查操作。以下之一 `eq`, `ne`, `like`,或 `ilike`.
+ 要执行的字符串检查操作。可选值为 `eq`, `ne`, `like`,之一,或 `ilike`.
- `"eq"`
@@ -11271,7 +11271,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `reference: string`
- 参考文本。这可能包括模板字符串。
+ 参考文本。可以包含模板字符串。
- `type: "string_check"`
@@ -11281,11 +11281,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `evaluation_metric: "cosine" or "fuzzy_match" or "bleu" or 8 more`
- 要使用的评估指标。以下之一 `cosine`, `fuzzy_match`, `bleu`,
+ 要使用的评估指标。可选值为 `cosine`, `fuzzy_match`, `bleu`,
`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`,
或 `rouge_l`.
@@ -11321,7 +11321,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `reference: string`
- 用作评分参考的文本。
+ 与之对比的参考文本。
- `type: "text_similarity"`
@@ -11331,7 +11331,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `name: string`
@@ -11353,15 +11353,15 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `input: array of object { content, role, type }`
- 由评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可能包括模板字符串。
+ 评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块,并且可以包含模板字符串。
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -11383,7 +11383,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可重用提示前缀的精确结束位置。断点继承请求的 `prompt_cache_options.ttl`;TTL;边界不会四舍五入到令牌块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -11407,7 +11407,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -11421,7 +11421,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -11435,7 +11435,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `format: "mp3" or "wav"`
- 音频数据的格式。目前支持的格式为 `mp3` 和
+ 音频数据的格式。当前支持的格式包括 `mp3` 和
`wav`.
- `"mp3"`
@@ -11450,7 +11450,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `TextInput = string`
@@ -11477,7 +11477,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -11491,7 +11491,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -11499,7 +11499,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -11532,7 +11532,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `range: optional array of number`
- 评分的范围。默认值为 `[0, 1]`.
+ 分数的取值范围。默认为 `[0, 1]`.
- `sampling_params: optional object { max_completions_tokens, reasoning_effort, seed, 2 more }`
@@ -11540,17 +11540,17 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `max_completions_tokens: optional number or null`
- 评分模型在其响应中可生成的最大令牌数。
+ 评分模型在其响应中可生成的最大 token 数。
- `reasoning_effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入。目前支持的
- 值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入可以加快响应速度并减少响应中用于推理的令牌
- 数量。并非所有推理模型都支持每个
+ 限制推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`.
+ 降低推理投入程度可以让响应更快,并使用更少的 token
+ 用于响应中的推理。并非所有推理模型都支持每个
值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解各模型的支持情况。
+ 了解特定模型的支持情况。
- `"none"`
@@ -11572,50 +11572,50 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `temperature: optional number or null`
- 较高的温度会增加输出中的随机性。
+ 较高的温度会增大输出的随机性。
- `top_p: optional number or null`
- 用于核采样的温度替代方案;1.0 包含所有令牌。
+ 用于核采样的温度替代参数;1.0 包含所有 token。
- `MultiGrader object { calculate_output, graders, name, type }`
- MultiGrader 对象结合多个评分器的输出来生成单个分数。
+ MultiGrader 对象组合多个评分器的输出以生成单个分数。
- `calculate_output: string`
- 用于根据评分器结果计算输出的公式。
+ 根据评分器结果计算输出的公式。
- `graders: StringCheckGrader or TextSimilarityGrader or PythonGrader or 2 more`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `StringCheckGrader object { input, name, operation, 2 more }`
- 一个 StringCheckGrader 对象,它使用指定的操作在输入和参考之间执行字符串比较。
+ 一个 StringCheckGrader 对象,使用指定操作在输入与参考之间执行字符串比较。
- `TextSimilarityGrader object { evaluation_metric, input, name, 2 more }`
- 一个 TextSimilarityGrader 对象,它根据相似度指标对文本进行评分。
+ 一个 TextSimilarityGrader 对象,基于相似度指标对文本进行评分。
- `PythonGrader object { name, source, type, image_tag }`
- 一个 PythonGrader 对象,它会对输入运行一个 python 脚本。
+ 一个 PythonGrader 对象,用于在输入上运行 python 脚本。
- `ScoreModelGrader object { input, model, name, 3 more }`
- 一个 ScoreModelGrader 对象,它使用一个模型为输入分配分数。
+ 一个 ScoreModelGrader 对象,使用模型为输入打分。
- `LabelModelGrader object { input, labels, model, 3 more }`
- 一个 LabelModelGrader 对象,它使用模型为每个项目分配标签
+ 使用模型为每个项目分配标签的 LabelModelGrader 对象
在评估中。
- `input: array of object { content, role, type }`
- `content: string or ResponseInputText or object { text, type } or 3 more`
- 模型的输入 - 可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项目或项目数组。
+ 模型的输入——可以包含模板字符串。支持文本、输出文本、输入图像和输入音频,可以是单个项,也可以是项的数组。
- `TextInput = string`
@@ -11641,7 +11641,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `InputImage object { image_url, type, detail }`
- 用于 EvalItem 内容数组中的图像输入块。
+ 在 EvalItem 内容数组中使用的图像输入块。
- `image_url: string`
@@ -11655,7 +11655,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `detail: optional string`
- 发送给模型的图像的细节级别。以下之一: `high`, `low`,或 `auto`. 默认为 `auto`.
+ 发送给模型的图像细节级别。取值为 `high`, `low`,之一,或 `auto`。之一。默认为 `auto`.
- `ResponseInputAudio object { input_audio, type }`
@@ -11663,12 +11663,12 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `GraderInputs = array of string or ResponseInputText or object { text, type } or 2 more`
- 输入列表,每一项可以是输入文本、输出文本、输入
+ 输入列表,其中每一项可以是输入文本、输出文本、输入
图像或输入音频对象。
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。值为 `user`, `assistant`, `system`,或
+ 消息输入的角色。取以下值之一 `user`, `assistant`, `system`,之一,或
`developer`.
- `"user"`
@@ -11687,7 +11687,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `labels: array of string`
- 要分配给评估中每个项目的标签。
+ 要为评估中的每个数据项分配的标签。
- `model: string`
@@ -11699,7 +11699,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `passing_labels: array of string`
- 表示通过结果的标签。必须是标签的子集。
+ 表示通过结果的标签。必须是 labels 的子集。
- `type: "label_model"`
@@ -11719,11 +11719,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `hyperparameters: optional ReinforcementHyperparameters`
- 用于强化微调作业的超参数。
+ 用于强化微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -11743,7 +11743,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `eval_interval: optional "auto" or number`
- 评估运行之间的训练步数。
+ 两次评估运行之间的训练步数。
- `"auto"`
@@ -11753,7 +11753,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `eval_samples: optional "auto" or number`
- 每个训练步生成的评估样本数量。
+ 每个训练步生成的评估样本数。
- `"auto"`
@@ -11773,7 +11773,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -11783,7 +11783,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `reasoning_effort: optional "default" or "low" or "medium" or "high"`
- 推理努力程度。
+ 推理努力级别。
- `"default"`
@@ -11797,11 +11797,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `SupervisedHyperparameters object { batch_size, learning_rate_multiplier, n_epochs }`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -11821,7 +11821,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
@@ -11837,11 +11837,11 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `hyperparameters: optional SupervisedHyperparameters`
- 用于微调作业的超参数。
+ 用于微调任务的超参数。
- `batch_size: optional "auto" or number`
- 每批中的示例数量。较大的批次大小意味着模型参数更新的频率较低,但方差较小。
+ 每个批次中的样本数量。较大的批量大小意味着模型参数更新频率更低,但方差也更低。
- `"auto"`
@@ -11861,7 +11861,7 @@ curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \
- `n_epochs: optional "auto" or number`
- 训练模型的轮数。一个 epoch 指的是对训练数据集的一次完整循环。
+ 训练模型的 epoch 数。epoch 指完整遍历一次训练数据集。
- `"auto"`
diff --git a/docs/zh/api/reference/resources/models.md b/docs/zh/api/reference/resources/models.md
index 5fbb969..0074297 100644
--- a/docs/zh/api/reference/resources/models.md
+++ b/docs/zh/api/reference/resources/models.md
@@ -1,12 +1,12 @@
# 模型
-> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾附加 `.md` 获取文档页面的 Markdown 版本。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。如需获取文档页面的 Markdown 版本,可在页面 URL 末尾追加 `.md` 。
## 删除微调模型
**delete** `/models/{model}`
-删除一个微调模型。你必须在组织中拥有 Owner 角色才能删除模型。
+删除已微调的模型。你必须在组织中拥有 Owner 角色才能删除模型。
### 路径参数
@@ -160,7 +160,7 @@ curl https://api.openai.com/v1/models \
**get** `/models/{model}`
-检索模型实例,提供有关该模型的基本信息,例如所有者和权限设置。
+检索模型实例,提供关于该模型的基本信息,例如所有者和权限设置。
### 路径参数
@@ -170,7 +170,7 @@ curl https://api.openai.com/v1/models \
- `Model object { id, created, object, 2 more }`
- 描述可与 API 配合使用的 OpenAI 模型服务。
+ 描述可与 API 一起使用的 OpenAI 模型服务。
- `id: string`
@@ -216,7 +216,7 @@ curl https://api.openai.com/v1/models/$MODEL \
### 示例
```http
-curl https://api.openai.com/v1/models/VAR_chat_model_id \
+curl https://api.openai.com/v1/models/gpt-5.6-sol \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
@@ -224,7 +224,7 @@ curl https://api.openai.com/v1/models/VAR_chat_model_id \
```json
{
- "id": "VAR_chat_model_id",
+ "id": "gpt-5.6-sol",
"object": "model",
"created": 1686935002,
"owned_by": "openai",
@@ -234,11 +234,11 @@ curl https://api.openai.com/v1/models/VAR_chat_model_id \
## 域类型
-### Model
+### 模型
- `Model object { id, created, object, 2 more }`
- 描述可与 API 配合使用的 OpenAI 模型服务。
+ 描述可与 API 一起使用的 OpenAI 模型服务。
- `id: string`
diff --git a/docs/zh/api/reference/resources/models/methods/retrieve.md b/docs/zh/api/reference/resources/models/methods/retrieve.md
index 7bec9df..78f1971 100644
--- a/docs/zh/api/reference/resources/models/methods/retrieve.md
+++ b/docs/zh/api/reference/resources/models/methods/retrieve.md
@@ -1,10 +1,10 @@
-> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。通过在页面 URL 末尾追加 `.md` 可获取文档页面的 Markdown 版本。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾添加 `.md` 即可获取对应文档页面的 Markdown 版本。
-## Retrieve model
+## 检索模型
**get** `/models/{model}`
-获取模型实例,并提供该模型的基本信息,例如所有者和权限配置。
+获取一个模型实例,并提供该模型的基本信息,例如所有者和权限设置。
### 路径参数
@@ -14,7 +14,7 @@
- `Model object { id, created, object, 2 more }`
- 描述可与 API 配合使用的 OpenAI 模型产品。
+ 描述可与 API 一起使用的 OpenAI 模型产品。
- `id: string`
@@ -60,7 +60,7 @@ curl https://api.openai.com/v1/models/$MODEL \
### 示例
```http
-curl https://api.openai.com/v1/models/VAR_chat_model_id \
+curl https://api.openai.com/v1/models/gpt-5.6-sol \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
@@ -68,7 +68,7 @@ curl https://api.openai.com/v1/models/VAR_chat_model_id \
```json
{
- "id": "VAR_chat_model_id",
+ "id": "gpt-5.6-sol",
"object": "model",
"created": 1686935002,
"owned_by": "openai",
diff --git a/docs/zh/api/reference/resources/responses.md b/docs/zh/api/reference/resources/responses.md
index c1462a2..bbae6c6 100644
--- a/docs/zh/api/reference/resources/responses.md
+++ b/docs/zh/api/reference/resources/responses.md
@@ -1,13 +1,13 @@
# Responses
-> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 来获取文档页面的 Markdown 版本。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。如需获取文档页面的 Markdown 版本,可在页面 URL 后追加 `.md` 。
## 取消响应
**post** `/responses/{response_id}/cancel`
-取消具有指定 ID 的模型响应。仅可取消通过
-该 `background` 参数创建的响应,且该参数需设置为 `true` 。
+取消具有给定 ID 的模型响应。仅可取消使用
+该 `background` 参数设置为 `true` 创建的响应。
[了解更多](/docs/guides/background).
### 路径参数
@@ -24,7 +24,7 @@
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -80,11 +80,11 @@
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -94,13 +94,13 @@
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -110,57 +110,57 @@
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -172,25 +172,25 @@
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -200,13 +200,13 @@
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -216,33 +216,33 @@
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -255,9 +255,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -265,24 +265,24 @@
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -292,8 +292,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -309,11 +309,11 @@
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -321,15 +321,15 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -337,11 +337,11 @@
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -351,19 +351,19 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -373,7 +373,7 @@
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -385,7 +385,7 @@
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -393,11 +393,11 @@
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -415,7 +415,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -451,15 +451,15 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -471,8 +471,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -488,9 +488,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -498,7 +498,7 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -507,7 +507,7 @@
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -526,20 +526,20 @@
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -558,7 +558,7 @@
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -575,7 +575,7 @@
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -595,8 +595,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -612,15 +612,15 @@
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -634,25 +634,25 @@
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -660,7 +660,7 @@
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -674,11 +674,11 @@
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -697,7 +697,7 @@
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -707,11 +707,11 @@
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -739,7 +739,7 @@
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -771,15 +771,15 @@
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -807,24 +807,24 @@
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -848,26 +848,26 @@
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -875,17 +875,17 @@
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -901,7 +901,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -911,8 +911,8 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -920,12 +920,12 @@
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -957,7 +957,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -971,7 +971,7 @@
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -985,11 +985,11 @@
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -1001,7 +1001,7 @@
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -1016,7 +1016,7 @@
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -1058,8 +1058,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1073,7 +1073,7 @@
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -1081,61 +1081,61 @@
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -1145,13 +1145,13 @@
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -1165,23 +1165,23 @@
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -1193,11 +1193,11 @@
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -1225,15 +1225,15 @@
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1249,7 +1249,7 @@
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -1287,11 +1287,11 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -1317,11 +1317,11 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -1329,7 +1329,7 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -1339,19 +1339,19 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -1360,9 +1360,9 @@
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -1404,11 +1404,11 @@
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -1422,7 +1422,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -1430,19 +1430,19 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -1450,25 +1450,25 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -1490,18 +1490,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1509,22 +1509,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -1538,34 +1538,34 @@
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -1583,36 +1583,36 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -1644,56 +1644,56 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -1701,26 +1701,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -1729,7 +1729,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -1739,7 +1739,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1769,33 +1769,33 @@
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -1811,7 +1811,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -1821,13 +1821,13 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -1837,11 +1837,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1851,7 +1851,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -1859,22 +1859,22 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -1883,7 +1883,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -1898,7 +1898,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -1910,7 +1910,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -1921,7 +1921,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -1938,13 +1938,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -1988,13 +1988,13 @@
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2018,7 +2018,7 @@
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -2034,7 +2034,7 @@
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -2048,7 +2048,7 @@
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -2056,13 +2056,13 @@
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -2094,13 +2094,13 @@
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -2110,7 +2110,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -2118,7 +2118,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -2132,7 +2132,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -2144,7 +2144,7 @@
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -2154,7 +2154,7 @@
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -2162,7 +2162,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -2184,7 +2184,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -2208,23 +2208,23 @@
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -2232,7 +2232,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -2246,7 +2246,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -2258,17 +2258,17 @@
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -2278,7 +2278,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -2290,11 +2290,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -2308,7 +2308,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -2318,37 +2318,37 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -2362,7 +2362,7 @@
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -2396,21 +2396,21 @@
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -2436,11 +2436,11 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -2448,7 +2448,7 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -2458,15 +2458,15 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -2474,7 +2474,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -2482,19 +2482,19 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -2502,25 +2502,25 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -2542,18 +2542,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -2561,22 +2561,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -2590,34 +2590,34 @@
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -2635,36 +2635,36 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -2696,56 +2696,56 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -2753,26 +2753,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -2781,7 +2781,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -2791,7 +2791,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2815,7 +2815,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -2831,7 +2831,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -2841,13 +2841,13 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -2857,11 +2857,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -2871,7 +2871,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -2879,22 +2879,22 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -2903,7 +2903,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -2918,7 +2918,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -2930,7 +2930,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -2941,7 +2941,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -2958,13 +2958,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -3012,7 +3012,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -3020,7 +3020,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -3034,7 +3034,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -3054,7 +3054,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -3078,23 +3078,23 @@
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -3102,7 +3102,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -3116,7 +3116,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -3128,17 +3128,17 @@
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -3148,7 +3148,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -3160,11 +3160,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -3178,7 +3178,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -3188,37 +3188,37 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -3232,19 +3232,19 @@
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -3287,20 +3287,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -3310,7 +3310,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -3318,13 +3318,13 @@
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -3352,7 +3352,7 @@
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -3366,7 +3366,7 @@
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -3375,7 +3375,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -3387,27 +3387,27 @@
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -3421,7 +3421,7 @@
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -3443,29 +3443,29 @@
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -3479,7 +3479,7 @@
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -3489,7 +3489,7 @@
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -3497,13 +3497,13 @@
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -3517,11 +3517,11 @@
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -3529,7 +3529,7 @@
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -3537,13 +3537,13 @@
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3579,7 +3579,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -3589,7 +3589,7 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -3597,7 +3597,7 @@
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -3605,45 +3605,45 @@
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3671,7 +3671,7 @@
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -3685,11 +3685,11 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -3701,11 +3701,11 @@
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -3719,7 +3719,7 @@
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -3733,11 +3733,11 @@
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -3747,7 +3747,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -3755,13 +3755,13 @@
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3793,11 +3793,11 @@
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -3805,13 +3805,13 @@
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3839,11 +3839,11 @@
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -3867,7 +3867,7 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -3875,21 +3875,21 @@
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -3901,39 +3901,39 @@
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -3945,11 +3945,11 @@
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -3957,18 +3957,18 @@
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -4004,7 +4004,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -4018,7 +4018,7 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -4039,11 +4039,11 @@
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -4057,7 +4057,7 @@
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4097,7 +4097,7 @@
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -4107,7 +4107,7 @@
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4131,7 +4131,7 @@
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -4139,7 +4139,7 @@
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -4153,11 +4153,11 @@
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -4177,11 +4177,11 @@
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -4193,15 +4193,15 @@
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -4209,24 +4209,24 @@
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -4441,7 +4441,7 @@
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -4449,20 +4449,20 @@
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -4471,7 +4471,7 @@
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -4490,20 +4490,20 @@
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -4522,7 +4522,7 @@
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -4539,7 +4539,7 @@
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -4581,8 +4581,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4607,15 +4607,15 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -4623,8 +4623,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4640,7 +4640,7 @@
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4668,20 +4668,20 @@
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -4689,12 +4689,12 @@
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -4726,7 +4726,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -4740,7 +4740,7 @@
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -4754,11 +4754,11 @@
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -4770,7 +4770,7 @@
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -4785,7 +4785,7 @@
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -4805,8 +4805,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4822,12 +4822,12 @@
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -4837,16 +4837,16 @@
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -4858,13 +4858,13 @@
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -4881,13 +4881,13 @@
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -4928,20 +4928,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4965,11 +4965,11 @@
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -4981,15 +4981,15 @@
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -4997,7 +4997,7 @@
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -5025,7 +5025,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -5035,13 +5035,13 @@
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -5063,7 +5063,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -5073,15 +5073,15 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -5107,11 +5107,11 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -5119,7 +5119,7 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -5129,15 +5129,15 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -5145,7 +5145,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -5153,19 +5153,19 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -5173,25 +5173,25 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -5213,18 +5213,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -5232,22 +5232,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -5261,34 +5261,34 @@
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -5306,36 +5306,36 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -5367,56 +5367,56 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -5424,26 +5424,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -5452,7 +5452,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -5462,7 +5462,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -5486,7 +5486,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -5502,7 +5502,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -5512,13 +5512,13 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -5528,11 +5528,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5542,7 +5542,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -5550,22 +5550,22 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -5574,7 +5574,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -5589,7 +5589,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -5601,7 +5601,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -5612,7 +5612,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -5629,13 +5629,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -5683,7 +5683,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -5691,7 +5691,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -5705,7 +5705,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -5725,7 +5725,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -5749,23 +5749,23 @@
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -5773,7 +5773,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -5787,7 +5787,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -5799,17 +5799,17 @@
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -5819,7 +5819,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -5831,11 +5831,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -5849,7 +5849,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -5859,37 +5859,37 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -5903,23 +5903,23 @@
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -5939,15 +5939,15 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -5973,11 +5973,11 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -5985,7 +5985,7 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -5995,15 +5995,15 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -6011,7 +6011,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -6019,19 +6019,19 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -6039,25 +6039,25 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -6079,18 +6079,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -6098,22 +6098,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -6127,34 +6127,34 @@
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -6172,36 +6172,36 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -6233,56 +6233,56 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -6290,26 +6290,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -6318,7 +6318,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -6328,7 +6328,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -6352,7 +6352,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -6368,7 +6368,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -6378,13 +6378,13 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -6394,11 +6394,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -6408,7 +6408,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -6416,22 +6416,22 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -6440,7 +6440,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -6455,7 +6455,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -6467,7 +6467,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -6478,7 +6478,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -6495,13 +6495,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -6549,7 +6549,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -6557,7 +6557,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -6571,7 +6571,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -6591,7 +6591,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -6615,23 +6615,23 @@
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -6639,7 +6639,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -6653,7 +6653,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -6665,17 +6665,17 @@
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -6685,7 +6685,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -6697,11 +6697,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -6715,7 +6715,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -6725,37 +6725,37 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -6769,13 +6769,13 @@
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -6783,17 +6783,17 @@
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -6821,7 +6821,7 @@
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -6835,7 +6835,7 @@
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -6844,7 +6844,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -6856,27 +6856,27 @@
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -6890,7 +6890,7 @@
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -6912,29 +6912,29 @@
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -6948,7 +6948,7 @@
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -6958,7 +6958,7 @@
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -6966,13 +6966,13 @@
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -6982,25 +6982,25 @@
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -7034,7 +7034,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -7044,7 +7044,7 @@
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -7078,7 +7078,7 @@
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -7090,25 +7090,25 @@
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -7116,7 +7116,7 @@
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -7130,11 +7130,11 @@
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -7170,7 +7170,7 @@
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -7178,11 +7178,11 @@
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -7198,11 +7198,11 @@
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -7212,7 +7212,7 @@
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -7230,7 +7230,7 @@
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -7240,7 +7240,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -7248,7 +7248,7 @@
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -7278,19 +7278,19 @@
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -7298,7 +7298,7 @@
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -7324,7 +7324,7 @@
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -7340,11 +7340,11 @@
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -7352,18 +7352,18 @@
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -7371,7 +7371,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -7385,7 +7385,7 @@
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -7409,7 +7409,7 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -7417,21 +7417,21 @@
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -7443,39 +7443,39 @@
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -7491,7 +7491,7 @@
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -7501,7 +7501,7 @@
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -7525,7 +7525,7 @@
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -7552,11 +7552,11 @@
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -7564,8 +7564,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -7605,7 +7605,7 @@
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -7613,20 +7613,20 @@
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -7641,14 +7641,14 @@
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -7718,7 +7718,7 @@
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -7788,31 +7788,31 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -7838,11 +7838,11 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -7850,7 +7850,7 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -7860,15 +7860,15 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -7876,7 +7876,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -7884,19 +7884,19 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -7904,25 +7904,25 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -7944,18 +7944,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -7963,22 +7963,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -7992,34 +7992,34 @@
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -8037,36 +8037,36 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -8098,56 +8098,56 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -8155,26 +8155,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -8183,7 +8183,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -8193,7 +8193,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -8217,7 +8217,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -8233,7 +8233,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -8243,13 +8243,13 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -8259,11 +8259,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -8273,7 +8273,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -8281,22 +8281,22 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -8305,7 +8305,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -8320,7 +8320,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -8332,7 +8332,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -8343,7 +8343,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -8360,13 +8360,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -8414,7 +8414,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8422,7 +8422,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -8436,7 +8436,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -8456,7 +8456,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -8480,23 +8480,23 @@
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8504,7 +8504,7 @@
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -8518,7 +8518,7 @@
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -8530,17 +8530,17 @@
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -8550,7 +8550,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -8562,11 +8562,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -8580,7 +8580,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -8590,37 +8590,37 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -8634,26 +8634,26 @@
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -8661,19 +8661,19 @@
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -8681,11 +8681,11 @@
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -8693,25 +8693,25 @@
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -8723,13 +8723,13 @@
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -8737,11 +8737,11 @@
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -8749,25 +8749,25 @@
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -8779,26 +8779,26 @@
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -8806,19 +8806,19 @@
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -8830,11 +8830,11 @@
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -8852,18 +8852,18 @@
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -8871,19 +8871,17 @@
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -8894,13 +8892,13 @@
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -8918,11 +8916,11 @@
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -8932,17 +8930,17 @@
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -8950,11 +8948,11 @@
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -8964,21 +8962,21 @@
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -8996,8 +8994,8 @@
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -9013,31 +9011,31 @@
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -9047,13 +9045,13 @@
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -9069,22 +9067,22 @@
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -9094,9 +9092,9 @@
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -9107,10 +9105,10 @@
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -9118,8 +9116,8 @@
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -9128,8 +9126,8 @@
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -9137,7 +9135,7 @@
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -9146,7 +9144,7 @@
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -9154,25 +9152,25 @@
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
### 示例
@@ -9182,7 +9180,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID/cancel \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -9199,7 +9197,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID/cancel \
"metadata": {
"foo": "string"
},
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"object": "response",
"output": [
{
@@ -9363,7 +9361,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -9377,7 +9375,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-4o-2024-08-06",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -9420,19 +9418,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
**post** `/responses/compact`
-压缩一段对话。返回一个已压缩的响应对象。
+压缩一段对话。返回一个压缩后的响应对象。
-了解在哪些场景下以及如何在 [对话状态指南](/docs/guides/conversation-state#managing-the-context-window)。中压缩长对话。有关兼容 ZDR 的压缩详情,请参阅 [压缩(高级)](/docs/guides/conversation-state#compaction-advanced).
+了解在对话状态指南中何时以及如何压缩长时间运行的对话 [对话状态指南](/docs/guides/conversation-state#managing-the-context-window)。有关兼容 ZDR 的压缩细节,请参阅 [压缩(进阶)](/docs/guides/conversation-state#compaction-advanced).
-### 正文参数
+### 请求体参数
- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string or null`
- 用于生成响应的模型 ID,例如 `gpt-5` 或 `o3`. OpenAI 提供多种不同能力、性能特征和价格水平的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`. OpenAI 提供一系列具有不同能力、性能特征和价格点的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
- `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`
- 用于生成响应的模型 ID,例如 `gpt-5` 或 `o3`. OpenAI 提供多种不同能力、性能特征和价格水平的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`. OpenAI 提供一系列具有不同能力、性能特征和价格点的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
- `"gpt-5.6-sol"`
@@ -9646,65 +9644,65 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `string`
- 发送给模型的文本输入,等同于带有 `user` 角色的文本输入。
+ 发送给模型的文本输入,相当于使用 `user` 角色的文本输入。
- `array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 由一个或多个输入项组成的列表,发送给模型,包含不同的内容类型。
+ 包含一个或多个输入条目的列表,用于模型,包含不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -9716,25 +9714,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -9744,13 +9742,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -9760,33 +9758,33 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -9799,9 +9797,9 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -9809,24 +9807,24 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -9836,8 +9834,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -9853,11 +9851,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -9865,15 +9863,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -9881,11 +9879,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -9895,19 +9893,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -9917,7 +9915,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -9929,7 +9927,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -9937,11 +9935,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -9959,7 +9957,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -9995,15 +9993,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -10015,8 +10013,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -10032,9 +10030,9 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -10042,7 +10040,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -10051,7 +10049,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -10070,20 +10068,20 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -10102,7 +10100,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -10119,7 +10117,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -10139,8 +10137,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10156,15 +10154,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -10178,25 +10176,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -10204,7 +10202,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -10218,11 +10216,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -10241,7 +10239,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -10251,11 +10249,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -10283,7 +10281,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -10315,15 +10313,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -10351,24 +10349,24 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -10392,26 +10390,26 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -10419,17 +10417,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -10445,7 +10443,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -10455,8 +10453,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -10464,12 +10462,12 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -10501,7 +10499,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -10515,7 +10513,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -10529,11 +10527,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -10545,7 +10543,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -10560,7 +10558,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -10602,8 +10600,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10617,7 +10615,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -10625,61 +10623,61 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -10689,13 +10687,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -10709,23 +10707,23 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -10737,11 +10735,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -10769,15 +10767,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10793,7 +10791,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -10831,11 +10829,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -10861,11 +10859,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -10873,7 +10871,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -10883,19 +10881,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -10904,9 +10902,9 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -10948,11 +10946,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -10966,7 +10964,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -10974,19 +10972,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -10994,25 +10992,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -11034,18 +11032,18 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -11053,22 +11051,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -11082,34 +11080,34 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -11127,36 +11125,36 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -11188,56 +11186,56 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -11245,26 +11243,26 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -11273,7 +11271,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -11283,7 +11281,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -11313,33 +11311,33 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -11355,7 +11353,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -11365,13 +11363,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -11381,11 +11379,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -11395,7 +11393,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -11403,22 +11401,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -11427,7 +11425,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -11442,7 +11440,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -11454,7 +11452,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -11465,7 +11463,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -11482,13 +11480,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -11532,13 +11530,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -11562,7 +11560,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -11578,7 +11576,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -11592,7 +11590,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -11600,13 +11598,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -11638,13 +11636,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -11654,7 +11652,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -11662,7 +11660,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -11676,7 +11674,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -11688,7 +11686,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -11698,7 +11696,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -11706,7 +11704,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -11728,7 +11726,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -11752,23 +11750,23 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -11776,7 +11774,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -11790,7 +11788,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -11802,17 +11800,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -11822,7 +11820,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -11834,11 +11832,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -11852,7 +11850,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -11862,37 +11860,37 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -11906,7 +11904,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -11940,21 +11938,21 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -11980,11 +11978,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -11992,7 +11990,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -12002,15 +12000,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -12018,7 +12016,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -12026,19 +12024,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -12046,25 +12044,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -12086,18 +12084,18 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -12105,22 +12103,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -12134,34 +12132,34 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -12179,36 +12177,36 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -12240,56 +12238,56 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -12297,26 +12295,26 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -12325,7 +12323,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -12335,7 +12333,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -12359,7 +12357,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -12375,7 +12373,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -12385,13 +12383,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -12401,11 +12399,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -12415,7 +12413,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -12423,22 +12421,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -12447,7 +12445,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -12462,7 +12460,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -12474,7 +12472,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -12485,7 +12483,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -12502,13 +12500,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -12556,7 +12554,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -12564,7 +12562,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -12578,7 +12576,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -12598,7 +12596,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -12622,23 +12620,23 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -12646,7 +12644,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -12660,7 +12658,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -12672,17 +12670,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -12692,7 +12690,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -12704,11 +12702,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -12722,7 +12720,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -12732,37 +12730,37 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -12776,19 +12774,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -12831,20 +12829,20 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -12854,7 +12852,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -12862,13 +12860,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -12896,7 +12894,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -12910,7 +12908,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -12919,7 +12917,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -12931,27 +12929,27 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -12965,7 +12963,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -12987,29 +12985,29 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -13023,7 +13021,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -13033,7 +13031,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -13041,13 +13039,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -13061,11 +13059,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -13073,7 +13071,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -13081,13 +13079,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -13123,7 +13121,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -13133,7 +13131,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -13141,7 +13139,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -13149,45 +13147,45 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -13215,7 +13213,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -13229,11 +13227,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -13245,11 +13243,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -13263,7 +13261,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -13277,11 +13275,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -13291,7 +13289,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -13299,13 +13297,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -13337,11 +13335,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -13349,13 +13347,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -13383,11 +13381,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -13411,7 +13409,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -13419,21 +13417,21 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -13445,39 +13443,39 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -13489,11 +13487,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -13501,18 +13499,18 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -13548,7 +13546,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -13562,7 +13560,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -13583,11 +13581,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -13601,7 +13599,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -13641,7 +13639,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -13651,7 +13649,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -13675,7 +13673,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -13683,7 +13681,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -13697,11 +13695,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -13721,11 +13719,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -13737,15 +13735,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -13753,30 +13751,30 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `instructions: optional string or null`
插入到模型上下文中的系统(或开发者)消息。
- 与 `previous_response_id`,一起使用时,上一次响应中的指令不会延续到下一次响应。这便于在新响应中替换系统(或开发者)消息。
+ 与 `previous_response_id`,配合使用时,上一次响应中的指令不会延续到下一次响应。这样可以方便地在新响应中替换系统(或开发者)消息。
- `previous_response_id: optional string or null`
- 上一次模型响应的唯一 ID。使用它可以创建多轮对话。了解更多关于 [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 上一次模型响应的唯一 ID。使用此 ID 可以创建多轮对话。详细了解 [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt_cache_key: optional string or null`
- 用于从提示缓存读取或写入的键。
+ 在读取或写入提示缓存时使用的密钥。
- `prompt_cache_options: optional object { mode, ttl } or null`
- 提示缓存选项。受支持于 `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"`
@@ -13784,13 +13782,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ttl: optional "30m"`
- 应用于该请求写入的每个隐式和显式缓存断点的最小生命周期。默认值为 `30m`,这是当前唯一支持的值。后端可能将缓存条目保留更长时间。
+ 应用于该请求写入的每个隐式和显式缓存断点的最短生命周期。默认为 `30m`,目前这是唯一受支持的值。后端可能会将缓存条目保留更长时间。
- `"30m"`
- `prompt_cache_retention: optional "in_memory" or "24h" or null`
- 保留由此请求创建的提示词缓存条目的时长。
+ 由该请求创建的提示缓存条目的保留时长。
- `"in_memory"`
@@ -13798,8 +13796,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `service_tier: optional "auto" or "default" or "fast" or 2 more or null`
- 指定用于处理该请求的处理类型。 - 如果设置为 'auto',则该请求将使用在项目设置中配置的服务层级进行处理。除非另有配置,否则该项目将使用 'default'。 - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。 - 若要选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` ,请在你的请求中进行设置。 - 当未设置时,默认行为为 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 指定用于处理该请求的处理类型。 - 如果设置为 'auto',则请求将使用在项目设置中配置的服务层级进行处理。除非另有配置,否则项目将使用 'default'。 - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - 要选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` ,请在你的请求中进行设置。 - 当未设置时,默认行为为 'auto'。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -13817,11 +13815,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: string`
- 已压缩响应的唯一标识符。
+ 压缩响应的唯一标识符。
- `created_at: number`
- 已压缩对话创建时的 Unix 时间戳(以秒为单位)。
+ 压缩对话创建时的 Unix 时间戳(以秒为单位)。
- `object: "response.compaction"`
@@ -13831,11 +13829,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output: array of Message or object { id, call_id, code, 2 more } or object { id, call_id, result, 2 more } or 25 more`
- 已压缩的输出项列表。
+ 压缩后的输出项列表。
- `Message object { id, content, role, 3 more }`
- 发送给模型或来自模型的消息。
+ 发给模型或来自模型的消息。
- `id: string`
@@ -13847,39 +13845,39 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -13887,11 +13885,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -13901,19 +13899,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -13923,7 +13921,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -13935,7 +13933,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -13943,11 +13941,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -13965,7 +13963,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -14039,25 +14037,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -14069,39 +14067,39 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ComputerScreenshotContent object { detail, file_id, image_url, 2 more }`
- 计算机的截图。
+ 计算机的屏幕截图。
- `detail: ImageDetail`
- 将发送给模型的截图图像的细节级别。取值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的屏幕截图图像的细节级别。取值为 `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: string or null`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: string or null`
@@ -14109,17 +14107,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机屏幕截图,此属性始终设置为 `computer_screenshot`.
- `"computer_screenshot"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -14129,13 +14127,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -14145,33 +14143,33 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "unknown" or "user" or "assistant" or 5 more`
- 消息的角色。取值之一 `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`,或 `tool`.
+ 消息的角色。可选值为 `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`.
- `"unknown"`
@@ -14191,7 +14189,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -14207,7 +14205,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`)。对于类似 `gpt-5.3-codex` 及更高版本等模型,在发送后续请求时,请在所有助手消息上保留并重新发送 phase,删除它可能会导致性能下降。不用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`)。对于 `gpt-5.3-codex` 及更高模型,在发送后续请求时,请在所有助手消息上保留并重新发送 phase 字段——删除它可能会降低性能。用户消息不使用该字段。
- `"commentary"`
@@ -14229,11 +14227,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -14245,15 +14243,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -14261,7 +14259,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -14276,7 +14274,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -14318,8 +14316,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -14351,7 +14349,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -14361,13 +14359,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -14389,7 +14387,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -14399,15 +14397,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -14433,11 +14431,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -14445,7 +14443,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -14455,19 +14453,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -14476,9 +14474,9 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -14520,11 +14518,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -14538,7 +14536,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -14546,19 +14544,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -14566,25 +14564,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -14606,18 +14604,18 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -14625,22 +14623,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -14654,34 +14652,34 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -14699,36 +14697,36 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -14760,56 +14758,56 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -14817,26 +14815,26 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -14845,7 +14843,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -14855,7 +14853,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -14885,33 +14883,33 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -14927,7 +14925,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -14937,13 +14935,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -14953,11 +14951,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -14967,7 +14965,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -14975,22 +14973,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -14999,7 +14997,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -15014,7 +15012,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -15026,7 +15024,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -15037,7 +15035,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -15054,13 +15052,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -15104,13 +15102,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -15134,7 +15132,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -15150,7 +15148,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -15164,7 +15162,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -15172,13 +15170,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -15210,13 +15208,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -15226,7 +15224,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -15234,7 +15232,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -15248,7 +15246,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -15260,7 +15258,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -15270,7 +15268,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -15278,7 +15276,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -15300,7 +15298,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -15324,23 +15322,23 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -15348,7 +15346,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -15362,7 +15360,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -15374,17 +15372,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -15394,7 +15392,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -15406,11 +15404,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -15424,7 +15422,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -15434,37 +15432,37 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -15478,23 +15476,23 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -15514,15 +15512,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -15548,11 +15546,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -15560,7 +15558,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -15570,15 +15568,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -15586,7 +15584,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -15594,19 +15592,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -15614,25 +15612,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -15654,18 +15652,18 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -15673,22 +15671,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -15702,34 +15700,34 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -15747,36 +15745,36 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -15808,56 +15806,56 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -15865,26 +15863,26 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -15893,7 +15891,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -15903,7 +15901,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -15927,7 +15925,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -15943,7 +15941,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -15953,13 +15951,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -15969,11 +15967,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -15983,7 +15981,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -15991,22 +15989,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -16015,7 +16013,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -16030,7 +16028,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -16042,7 +16040,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -16053,7 +16051,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -16070,13 +16068,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -16124,7 +16122,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -16132,7 +16130,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -16146,7 +16144,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -16166,7 +16164,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -16190,23 +16188,23 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -16214,7 +16212,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -16228,7 +16226,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -16240,17 +16238,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -16260,7 +16258,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -16272,11 +16270,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -16290,7 +16288,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -16300,37 +16298,37 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -16344,7 +16342,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
@@ -16363,15 +16361,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -16390,7 +16388,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -16418,16 +16416,16 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -16437,7 +16435,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -16446,7 +16444,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -16465,20 +16463,20 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -16497,7 +16495,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -16505,8 +16503,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -16514,12 +16512,12 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -16551,7 +16549,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -16565,7 +16563,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -16579,11 +16577,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -16595,7 +16593,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -16625,7 +16623,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -16640,7 +16638,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -16660,8 +16658,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -16677,15 +16675,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -16699,25 +16697,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -16725,7 +16723,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -16739,11 +16737,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -16762,7 +16760,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -16772,11 +16770,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -16804,7 +16802,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -16836,15 +16834,15 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -16872,24 +16870,24 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -16919,22 +16917,22 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -16942,8 +16940,8 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -16955,13 +16953,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -16978,13 +16976,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -17025,20 +17023,20 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -17048,7 +17046,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -17056,17 +17054,17 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `CodeInterpreterCall object { id, code, container_id, 3 more }`
@@ -17078,7 +17076,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -17087,7 +17085,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -17099,27 +17097,27 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -17133,7 +17131,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -17155,29 +17153,29 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -17191,7 +17189,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -17201,7 +17199,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -17209,13 +17207,13 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -17225,25 +17223,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -17277,7 +17275,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -17287,7 +17285,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -17321,7 +17319,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -17333,25 +17331,25 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -17359,7 +17357,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -17373,11 +17371,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -17413,7 +17411,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -17421,11 +17419,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -17441,11 +17439,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -17455,7 +17453,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -17473,7 +17471,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -17483,7 +17481,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -17491,7 +17489,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -17521,19 +17519,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -17541,7 +17539,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -17567,7 +17565,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -17575,7 +17573,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -17599,7 +17597,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -17607,21 +17605,21 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -17633,39 +17631,39 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -17677,11 +17675,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -17689,18 +17687,18 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -17736,7 +17734,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -17762,7 +17760,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -17772,7 +17770,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -17796,11 +17794,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -17821,11 +17819,11 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -17839,7 +17837,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -17867,7 +17865,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `usage: ResponseUsage`
- 压缩过程阶段的 token 统计,包括缓存 token、推理 token 和总 token。
+ 压缩过程的令牌统计,包括缓存、推理和总令牌。
- `input_tokens: number`
@@ -17875,7 +17873,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -17884,7 +17882,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -17892,19 +17890,19 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
### 示例
@@ -17918,7 +17916,7 @@ curl https://api.openai.com/v1/responses/compact \
}'
```
-#### Response
+#### 响应
```json
{
@@ -17966,7 +17964,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.1-codex-max",
+ "model": "gpt-5.6-sol",
"input": [
{
"role": "user",
@@ -17990,7 +17988,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
}'
```
-#### Response
+#### 响应
```json
{
@@ -18031,65 +18029,65 @@ curl -X POST https://api.openai.com/v1/responses/compact \
}
```
-## Create a model response
+## 创建模型响应
**post** `/responses`
创建模型响应。提供 [文本](/docs/guides/text) 或
[图像](/docs/guides/images) 输入以生成 [文本](/docs/guides/text)
或 [JSON](/docs/guides/structured-outputs) 输出。让模型调用
-你自己的 [自定义代码](/docs/guides/function-calling) 或使用内置
+你自己的 [自定义代码](/docs/guides/function-calling) 或使用内置的
[工具](/docs/guides/tools) 例如 [网页搜索](/docs/guides/tools-web-search)
或 [文件搜索](/docs/guides/tools-file-search) 以使用你自己的数据
作为模型响应的输入。
-### 正文参数
+### 请求体参数
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `context_management: optional array of object { type, compact_threshold } or null`
- 本次请求的上下文管理配置。
+ 此请求的上下文管理配置。
- `type: string`
- 上下文管理条目的类型。目前仅支持 'compaction'。
+ 上下文管理条目类型。目前仅支持 'compaction'。
- `compact_threshold: optional number or null`
- 触发该条目压缩的 token 阈值。
+ 应触发此条目压缩的 token 阈值。
- `conversation: optional string or ResponseConversationParam or null`
- 本次响应所属的会话。该会话中的条目会作为前缀拼接到 `input_items` 本次响应请求的前面。
- 本次响应完成后,本次响应中的输入条目和输出条目会自动添加到此会话中。
+ 此响应所属的对话。该对话中的条目会被添加到 `input_items` 此响应请求之前。
+ 此响应的输入条目和输出条目会在该响应完成后自动添加到此对话中。
- `ConversationID = string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
- `ResponseConversationParam object { id }`
- 本次响应所属的会话。
+ 此响应所属的对话。
- `id: string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
- `include: optional array of ResponseIncludable or null`
指定要在模型响应中包含的其他输出数据。目前支持的值包括:
- - `web_search_call.action.sources`: 包含 网页搜索 工具调用的来源。
- - `code_interpreter_call.outputs`: 在代码解释器工具调用条目中包含 Python 代码执行的输出。
- - `computer_call_output.output.image_url`: 包含来自 computer call 输出的图片 URL。
- - `file_search_call.results`: 包含 文件搜索 工具调用的搜索结果。
- - `message.input_image.image_url`: 包含来自输入消息的图片 URL。
- - `message.output_text.logprobs`: 在助手消息中包含 logprobs。
- - `reasoning.encrypted_content`: 在推理条目输出中包含加密版本的推理 token。这使得在无状态地使用 Responses API 时(例如当 `store` 参数被设置为 `false`,时,或当组织已加入零数据保留计划时),推理条目可以用于多轮对话。
+ - `web_search_call.action.sources`:包含 网页搜索 工具调用的来源。
+ - `code_interpreter_call.outputs`:在代码解释器工具调用条目中包含 Python 代码执行的输出。
+ - `computer_call_output.output.image_url`:包含来自计算机调用输出的图片 URL。
+ - `file_search_call.results`:包含 文件搜索 工具调用的搜索结果。
+ - `message.input_image.image_url`:包含来自输入消息的图片 URL。
+ - `message.output_text.logprobs`:在助手消息中包含 logprobs。
+ - `reasoning.encrypted_content`:在推理条目的输出中包含加密版本的推理 token。这使得在使用 Responses API 以无状态方式处理多轮对话时能够使用推理条目(例如 `store` 参数设置为 `false`,时,或组织已加入零数据留存计划时)。
- `"file_search_call.results"`
@@ -18111,9 +18109,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
提供给模型的文本、图片或文件输入,用于生成响应。
- 了解更多:
+ 了解详情:
- - [Text inputs and outputs](/docs/guides/text)
+ - [文本输入与输出](/docs/guides/text)
- [图像输入](/docs/guides/images)
- [文件输入](/docs/guides/pdf-files)
- [会话状态](/docs/guides/conversation-state)
@@ -18121,7 +18119,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `TextInput = string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`user` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -18131,57 +18129,57 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -18193,25 +18191,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -18221,13 +18219,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -18237,33 +18235,33 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -18276,9 +18274,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -18286,24 +18284,24 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -18313,8 +18311,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -18330,11 +18328,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -18342,15 +18340,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -18358,11 +18356,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -18372,19 +18370,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -18394,7 +18392,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -18406,7 +18404,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -18414,11 +18412,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -18436,7 +18434,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -18472,15 +18470,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -18492,8 +18490,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -18509,9 +18507,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -18519,7 +18517,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -18528,7 +18526,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -18547,20 +18545,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -18579,7 +18577,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -18596,7 +18594,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -18616,8 +18614,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -18633,15 +18631,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -18655,25 +18653,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -18681,7 +18679,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -18695,11 +18693,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -18718,7 +18716,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -18728,11 +18726,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -18760,7 +18758,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -18792,15 +18790,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -18828,24 +18826,24 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -18869,26 +18867,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -18896,17 +18894,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -18922,7 +18920,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -18932,8 +18930,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -18941,12 +18939,12 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -18978,7 +18976,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -18992,7 +18990,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -19006,11 +19004,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -19022,7 +19020,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -19037,7 +19035,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -19079,8 +19077,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -19094,7 +19092,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -19102,61 +19100,61 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -19166,13 +19164,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -19186,23 +19184,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -19214,11 +19212,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -19246,15 +19244,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -19270,7 +19268,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -19308,11 +19306,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -19338,11 +19336,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -19350,7 +19348,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -19360,19 +19358,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -19381,9 +19379,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -19425,11 +19423,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -19443,7 +19441,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -19451,19 +19449,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -19471,25 +19469,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -19511,18 +19509,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -19530,22 +19528,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -19559,34 +19557,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -19604,36 +19602,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -19665,56 +19663,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -19722,26 +19720,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -19750,7 +19748,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -19760,7 +19758,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -19790,33 +19788,33 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -19832,7 +19830,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -19842,13 +19840,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -19858,11 +19856,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -19872,7 +19870,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -19880,22 +19878,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -19904,7 +19902,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -19919,7 +19917,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -19931,7 +19929,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -19942,7 +19940,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -19959,13 +19957,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -20009,13 +20007,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -20039,7 +20037,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -20055,7 +20053,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -20069,7 +20067,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -20077,13 +20075,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -20115,13 +20113,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -20131,7 +20129,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -20139,7 +20137,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -20153,7 +20151,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -20165,7 +20163,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -20175,7 +20173,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -20183,7 +20181,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -20205,7 +20203,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -20229,23 +20227,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -20253,7 +20251,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -20267,7 +20265,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -20279,17 +20277,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -20299,7 +20297,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -20311,11 +20309,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -20329,7 +20327,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -20339,37 +20337,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -20383,7 +20381,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -20417,21 +20415,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -20457,11 +20455,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -20469,7 +20467,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -20479,15 +20477,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -20495,7 +20493,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -20503,19 +20501,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -20523,25 +20521,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -20563,18 +20561,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -20582,22 +20580,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -20611,34 +20609,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -20656,36 +20654,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -20717,56 +20715,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -20774,26 +20772,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -20802,7 +20800,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -20812,7 +20810,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -20836,7 +20834,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -20852,7 +20850,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -20862,13 +20860,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -20878,11 +20876,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -20892,7 +20890,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -20900,22 +20898,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -20924,7 +20922,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -20939,7 +20937,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -20951,7 +20949,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -20962,7 +20960,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -20979,13 +20977,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -21033,7 +21031,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -21041,7 +21039,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -21055,7 +21053,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -21075,7 +21073,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -21099,23 +21097,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -21123,7 +21121,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -21137,7 +21135,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -21149,17 +21147,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -21169,7 +21167,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -21181,11 +21179,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -21199,7 +21197,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -21209,37 +21207,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -21253,19 +21251,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -21308,20 +21306,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -21331,7 +21329,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -21339,13 +21337,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -21373,7 +21371,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -21387,7 +21385,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -21396,7 +21394,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -21408,27 +21406,27 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -21442,7 +21440,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -21464,29 +21462,29 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -21500,7 +21498,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -21510,7 +21508,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -21518,13 +21516,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -21538,11 +21536,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -21550,7 +21548,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -21558,13 +21556,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -21600,7 +21598,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -21610,7 +21608,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -21618,7 +21616,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -21626,45 +21624,45 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -21692,7 +21690,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -21706,11 +21704,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -21722,11 +21720,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -21740,7 +21738,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -21754,11 +21752,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -21768,7 +21766,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -21776,13 +21774,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -21814,11 +21812,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -21826,13 +21824,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -21860,11 +21858,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -21888,7 +21886,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -21896,21 +21894,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -21922,39 +21920,39 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -21966,11 +21964,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -21978,18 +21976,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -22025,7 +22023,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -22039,7 +22037,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -22060,11 +22058,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -22078,7 +22076,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -22118,7 +22116,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -22128,7 +22126,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -22152,7 +22150,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -22160,7 +22158,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -22174,11 +22172,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -22198,11 +22196,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -22214,15 +22212,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -22230,7 +22228,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
@@ -22238,32 +22236,32 @@ curl -X POST https://api.openai.com/v1/responses/compact \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `metadata: optional Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: optional ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -22482,15 +22480,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `model: string`
- 用于审核补全的审核模型,例如 'omni-moderation-latest'。
+ 用于受审核补全的审核模型,例如 'omni-moderation-latest'。
- `policy: optional object { input, output } or null`
- 应用于已审核响应输入和输出的策略。
+ 应用于受审核响应输入和输出的策略。
- `input: optional object { mode } or null`
- 响应输入的审核策略。
+ 用于响应输入的审核策略。
- `mode: "score" or "block"`
@@ -22500,7 +22498,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: optional object { mode } or null`
- 响应输出的审核策略。
+ 用于响应输出的审核策略。
- `mode: "score" or "block"`
@@ -22514,14 +22512,14 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -22529,19 +22527,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -22553,15 +22551,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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"`
@@ -22569,24 +22567,24 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -22594,19 +22592,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -22617,13 +22613,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -22641,11 +22637,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -22655,17 +22651,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -22673,11 +22669,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -22687,21 +22683,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -22724,57 +22720,57 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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).
- 请参阅下方 [流式传输部分](/docs/api-reference/responses-streaming)
+ 如果设置为 true,模型响应数据将流式传输到客户端
+ ,使用 [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+ 参见下方 [流式传输部分](/docs/api-reference/responses-streaming)
了解更多信息。
- `stream_options: optional object { include_obfuscation } or null`
- 流式响应选项。仅在设置 stream: true 时设置此参数。 `stream: true`.
+ 用于流式响应选项。仅当你设置了 `stream: true`.
- `include_obfuscation: optional boolean`
- 如果为 true,将启用流混淆。流混淆会向流式 delta 事件上的 obfuscation 字段添加
- 随机字符,以 `obfuscation` 帮助防止某些浏览器在响应完成前被截断。
+ 为 true 时,将启用流混淆。流混淆会向流式增量事件上的
+ 字段添加 `obfuscation` 随机字符
将载荷大小归一化,作为对某些侧信道攻击的缓解措施。
- 这些混淆字段默认会包含在内,但会给数据流带来少量
- 开销。如果你的应用程序与 OpenAI API 之间的网络链路可信,你可以设置 `include_obfuscation` 设为
- 为 false 以优化带宽。
- 为 false 以优化带宽。
+ 默认会包含这些混淆字段,但会为数据流带来少量
+ 开销。你可以将 `include_obfuscation` 设置为
+ 设为 false 以优化带宽,前提是你信任应用与
+ OpenAI API 之间的网络链路。
- `temperature: optional number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -22784,13 +22780,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -22806,22 +22802,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -22831,9 +22827,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -22844,15 +22840,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `tool_choice: optional ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -22867,14 +22863,14 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -22944,7 +22940,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -23014,31 +23010,31 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -23064,11 +23060,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -23076,7 +23072,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -23086,15 +23082,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -23102,7 +23098,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -23110,19 +23106,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -23130,25 +23126,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -23170,18 +23166,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -23189,22 +23185,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -23218,34 +23214,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -23263,36 +23259,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -23324,56 +23320,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -23381,26 +23377,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -23409,7 +23405,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -23419,7 +23415,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -23443,7 +23439,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -23459,7 +23455,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -23469,13 +23465,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -23485,11 +23481,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -23499,7 +23495,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -23507,22 +23503,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -23531,7 +23527,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -23546,7 +23542,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -23558,7 +23554,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -23569,7 +23565,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -23586,13 +23582,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -23640,7 +23636,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -23648,7 +23644,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -23662,7 +23658,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -23682,7 +23678,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -23706,23 +23702,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -23730,7 +23726,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -23744,7 +23740,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -23756,17 +23752,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -23776,7 +23772,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -23788,11 +23784,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -23806,7 +23802,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -23816,37 +23812,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -23860,19 +23856,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `top_p: optional number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `truncation: optional "auto" or "disabled" or null`
@@ -23880,8 +23876,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -23890,9 +23886,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
### 返回
@@ -23904,7 +23900,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -23960,11 +23956,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -23974,13 +23970,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -23990,57 +23986,57 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -24052,25 +24048,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -24080,13 +24076,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -24096,33 +24092,33 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -24135,9 +24131,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -24145,24 +24141,24 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -24172,8 +24168,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -24189,11 +24185,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -24201,15 +24197,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -24217,11 +24213,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -24231,19 +24227,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -24253,7 +24249,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -24265,7 +24261,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -24273,11 +24269,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -24295,7 +24291,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -24331,15 +24327,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -24351,8 +24347,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -24368,9 +24364,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -24378,7 +24374,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -24387,7 +24383,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -24406,20 +24402,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -24438,7 +24434,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -24455,7 +24451,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -24475,8 +24471,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -24492,15 +24488,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -24514,25 +24510,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -24540,7 +24536,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -24554,11 +24550,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -24577,7 +24573,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -24587,11 +24583,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -24619,7 +24615,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -24651,15 +24647,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -24687,24 +24683,24 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -24728,26 +24724,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -24755,17 +24751,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -24781,7 +24777,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -24791,8 +24787,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -24800,12 +24796,12 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -24837,7 +24833,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -24851,7 +24847,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -24865,11 +24861,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -24881,7 +24877,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -24896,7 +24892,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -24938,8 +24934,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -24953,7 +24949,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -24961,61 +24957,61 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -25025,13 +25021,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -25045,23 +25041,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -25073,11 +25069,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -25105,15 +25101,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -25129,7 +25125,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -25167,11 +25163,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -25197,11 +25193,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -25209,7 +25205,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -25219,19 +25215,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -25240,9 +25236,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -25284,11 +25280,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -25302,7 +25298,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -25310,19 +25306,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -25330,25 +25326,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -25370,18 +25366,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -25389,22 +25385,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -25418,34 +25414,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -25463,36 +25459,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -25524,56 +25520,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -25581,26 +25577,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -25609,7 +25605,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -25619,7 +25615,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -25649,33 +25645,33 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -25691,7 +25687,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -25701,13 +25697,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -25717,11 +25713,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -25731,7 +25727,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -25739,22 +25735,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -25763,7 +25759,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -25778,7 +25774,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -25790,7 +25786,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -25801,7 +25797,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -25818,13 +25814,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -25868,13 +25864,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -25898,7 +25894,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -25914,7 +25910,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -25928,7 +25924,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -25936,13 +25932,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -25974,13 +25970,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -25990,7 +25986,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -25998,7 +25994,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -26012,7 +26008,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -26024,7 +26020,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -26034,7 +26030,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -26042,7 +26038,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -26064,7 +26060,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -26088,23 +26084,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -26112,7 +26108,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -26126,7 +26122,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -26138,17 +26134,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -26158,7 +26154,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -26170,11 +26166,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -26188,7 +26184,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -26198,37 +26194,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -26242,7 +26238,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -26276,21 +26272,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -26316,11 +26312,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -26328,7 +26324,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -26338,15 +26334,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -26354,7 +26350,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -26362,19 +26358,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -26382,25 +26378,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -26422,18 +26418,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -26441,22 +26437,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -26470,34 +26466,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -26515,36 +26511,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -26576,56 +26572,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -26633,26 +26629,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -26661,7 +26657,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -26671,7 +26667,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -26695,7 +26691,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -26711,7 +26707,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -26721,13 +26717,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -26737,11 +26733,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -26751,7 +26747,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -26759,22 +26755,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -26783,7 +26779,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -26798,7 +26794,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -26810,7 +26806,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -26821,7 +26817,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -26838,13 +26834,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -26892,7 +26888,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -26900,7 +26896,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -26914,7 +26910,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -26934,7 +26930,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -26958,23 +26954,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -26982,7 +26978,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -26996,7 +26992,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -27008,17 +27004,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -27028,7 +27024,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -27040,11 +27036,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -27058,7 +27054,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -27068,37 +27064,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -27112,19 +27108,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -27167,20 +27163,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -27190,7 +27186,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -27198,13 +27194,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -27232,7 +27228,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -27246,7 +27242,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -27255,7 +27251,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -27267,27 +27263,27 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -27301,7 +27297,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -27323,29 +27319,29 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -27359,7 +27355,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -27369,7 +27365,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -27377,13 +27373,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -27397,11 +27393,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -27409,7 +27405,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -27417,13 +27413,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -27459,7 +27455,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -27469,7 +27465,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -27477,7 +27473,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -27485,45 +27481,45 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -27551,7 +27547,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -27565,11 +27561,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -27581,11 +27577,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -27599,7 +27595,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -27613,11 +27609,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -27627,7 +27623,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -27635,13 +27631,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -27673,11 +27669,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -27685,13 +27681,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -27719,11 +27715,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -27747,7 +27743,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -27755,21 +27751,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -27781,39 +27777,39 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -27825,11 +27821,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -27837,18 +27833,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -27884,7 +27880,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -27898,7 +27894,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -27919,11 +27915,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -27937,7 +27933,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -27977,7 +27973,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -27987,7 +27983,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -28011,7 +28007,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -28019,7 +28015,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -28033,11 +28029,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -28057,11 +28053,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -28073,15 +28069,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -28089,24 +28085,24 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -28321,7 +28317,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -28329,20 +28325,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -28351,7 +28347,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -28370,20 +28366,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -28402,7 +28398,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -28419,7 +28415,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -28461,8 +28457,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -28487,15 +28483,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -28503,8 +28499,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -28520,7 +28516,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -28548,20 +28544,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -28569,12 +28565,12 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -28606,7 +28602,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -28620,7 +28616,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -28634,11 +28630,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -28650,7 +28646,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -28665,7 +28661,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -28685,8 +28681,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -28702,12 +28698,12 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -28717,16 +28713,16 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -28738,13 +28734,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -28761,13 +28757,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -28808,20 +28804,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -28845,11 +28841,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -28861,15 +28857,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -28877,7 +28873,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -28905,7 +28901,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -28915,13 +28911,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -28943,7 +28939,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -28953,15 +28949,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -28987,11 +28983,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -28999,7 +28995,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -29009,15 +29005,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -29025,7 +29021,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -29033,19 +29029,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -29053,25 +29049,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -29093,18 +29089,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -29112,22 +29108,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -29141,34 +29137,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -29186,36 +29182,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -29247,56 +29243,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -29304,26 +29300,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -29332,7 +29328,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -29342,7 +29338,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -29366,7 +29362,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -29382,7 +29378,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -29392,13 +29388,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -29408,11 +29404,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -29422,7 +29418,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -29430,22 +29426,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -29454,7 +29450,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -29469,7 +29465,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -29481,7 +29477,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -29492,7 +29488,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -29509,13 +29505,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -29563,7 +29559,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -29571,7 +29567,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -29585,7 +29581,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -29605,7 +29601,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -29629,23 +29625,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -29653,7 +29649,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -29667,7 +29663,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -29679,17 +29675,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -29699,7 +29695,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -29711,11 +29707,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -29729,7 +29725,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -29739,37 +29735,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -29783,23 +29779,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -29819,15 +29815,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -29853,11 +29849,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -29865,7 +29861,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -29875,15 +29871,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -29891,7 +29887,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -29899,19 +29895,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -29919,25 +29915,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -29959,18 +29955,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -29978,22 +29974,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -30007,34 +30003,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -30052,36 +30048,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -30113,56 +30109,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -30170,26 +30166,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -30198,7 +30194,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -30208,7 +30204,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -30232,7 +30228,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -30248,7 +30244,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -30258,13 +30254,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -30274,11 +30270,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -30288,7 +30284,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -30296,22 +30292,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -30320,7 +30316,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -30335,7 +30331,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -30347,7 +30343,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -30358,7 +30354,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -30375,13 +30371,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -30429,7 +30425,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -30437,7 +30433,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -30451,7 +30447,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -30471,7 +30467,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -30495,23 +30491,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -30519,7 +30515,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -30533,7 +30529,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -30545,17 +30541,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -30565,7 +30561,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -30577,11 +30573,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -30595,7 +30591,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -30605,37 +30601,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -30649,13 +30645,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -30663,17 +30659,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -30701,7 +30697,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -30715,7 +30711,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -30724,7 +30720,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -30736,27 +30732,27 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -30770,7 +30766,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -30792,29 +30788,29 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -30828,7 +30824,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -30838,7 +30834,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -30846,13 +30842,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -30862,25 +30858,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -30914,7 +30910,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -30924,7 +30920,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -30958,7 +30954,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -30970,25 +30966,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -30996,7 +30992,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -31010,11 +31006,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -31050,7 +31046,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -31058,11 +31054,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -31078,11 +31074,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -31092,7 +31088,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -31110,7 +31106,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -31120,7 +31116,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -31128,7 +31124,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -31158,19 +31154,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -31178,7 +31174,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -31204,7 +31200,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -31220,11 +31216,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -31232,18 +31228,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -31251,7 +31247,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -31265,7 +31261,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -31289,7 +31285,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -31297,21 +31293,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -31323,39 +31319,39 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -31371,7 +31367,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -31381,7 +31377,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -31405,7 +31401,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -31432,11 +31428,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -31444,8 +31440,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -31485,7 +31481,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -31493,20 +31489,20 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -31521,14 +31517,14 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -31598,7 +31594,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -31668,31 +31664,31 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -31718,11 +31714,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -31730,7 +31726,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -31740,15 +31736,15 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -31756,7 +31752,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -31764,19 +31760,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -31784,25 +31780,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -31824,18 +31820,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -31843,22 +31839,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -31872,34 +31868,34 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -31917,36 +31913,36 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -31978,56 +31974,56 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -32035,26 +32031,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -32063,7 +32059,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -32073,7 +32069,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -32097,7 +32093,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -32113,7 +32109,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -32123,13 +32119,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -32139,11 +32135,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -32153,7 +32149,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -32161,22 +32157,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -32185,7 +32181,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -32200,7 +32196,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -32212,7 +32208,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -32223,7 +32219,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -32240,13 +32236,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -32294,7 +32290,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -32302,7 +32298,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -32316,7 +32312,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -32336,7 +32332,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -32360,23 +32356,23 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -32384,7 +32380,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -32398,7 +32394,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -32410,17 +32406,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -32430,7 +32426,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -32442,11 +32438,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -32460,7 +32456,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -32470,37 +32466,37 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -32514,26 +32510,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -32541,19 +32537,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -32561,11 +32557,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -32573,25 +32569,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -32603,13 +32599,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -32617,11 +32613,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -32629,25 +32625,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -32659,26 +32655,26 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -32686,19 +32682,19 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -32710,11 +32706,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -32732,18 +32728,18 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -32751,19 +32747,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -32774,13 +32768,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -32798,11 +32792,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -32812,17 +32806,17 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -32830,11 +32824,11 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -32844,21 +32838,21 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -32876,8 +32870,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -32893,31 +32887,31 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -32927,13 +32921,13 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -32949,22 +32943,22 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -32974,9 +32968,9 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -32987,10 +32981,10 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -32998,8 +32992,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -33008,8 +33002,8 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -33017,7 +33011,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -33026,7 +33020,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -33034,25 +33028,25 @@ curl -X POST https://api.openai.com/v1/responses/compact \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
### 示例
@@ -33061,7 +33055,7 @@ curl https://api.openai.com/v1/responses \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"prompt_cache_key": "prompt-cache-key-1234",
"safety_identifier": "safety-identifier-1234",
"temperature": 1,
@@ -33070,7 +33064,7 @@ curl https://api.openai.com/v1/responses \
}'
```
-#### Response
+#### 响应
```json
{
@@ -33087,7 +33081,7 @@ curl https://api.openai.com/v1/responses \
"metadata": {
"foo": "string"
},
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"object": "response",
"output": [
{
@@ -33250,7 +33244,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": [
{
"role": "user",
@@ -33267,7 +33261,7 @@ curl https://api.openai.com/v1/responses \
}'
```
-#### Response
+#### 响应
```json
{
@@ -33282,7 +33276,7 @@ curl https://api.openai.com/v1/responses \
"instructions": null,
"max_output_tokens": null,
"max_tool_calls": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"id": "msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86",
@@ -33342,7 +33336,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"tools": [{
"type": "file_search",
"vector_store_ids": ["vs_1234567890"],
@@ -33352,7 +33346,7 @@ curl https://api.openai.com/v1/responses \
}'
```
-#### Response
+#### 响应
```json
{
@@ -33365,7 +33359,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "file_search_call",
@@ -33493,7 +33487,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": "What is the weather like in Boston today?",
"tools": [
{
@@ -33520,7 +33514,7 @@ curl https://api.openai.com/v1/responses \
}'
```
-#### Response
+#### 响应
```json
{
@@ -33533,7 +33527,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "function_call",
@@ -33608,7 +33602,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": [
{
"role": "user",
@@ -33624,7 +33618,7 @@ curl https://api.openai.com/v1/responses \
}'
```
-#### Response
+#### 响应
```json
{
@@ -33637,7 +33631,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -33694,7 +33688,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "o3-mini",
+ "model": "gpt-5.6-sol",
"input": "How much wood would a woodchuck chuck?",
"reasoning": {
"effort": "high"
@@ -33702,7 +33696,7 @@ curl https://api.openai.com/v1/responses \
}'
```
-#### Response
+#### 响应
```json
{
@@ -33715,7 +33709,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "o1-2024-12-17",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -33772,21 +33766,21 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"instructions": "You are a helpful assistant.",
"input": "Hello!",
"stream": true
}'
```
-#### Response
+#### 响应
```json
event: response.created
-data: {"type":"response.created","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+data: {"type":"response.created","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.6-sol","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
event: response.in_progress
-data: {"type":"response.in_progress","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+data: {"type":"response.in_progress","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.6-sol","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
event: response.output_item.added
data: {"type":"response.output_item.added","output_index":0,"item":{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"in_progress","role":"assistant","content":[]}}
@@ -33809,7 +33803,7 @@ event: response.output_item.done
data: {"type":"response.output_item.done","output_index":0,"item":{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}}
event: response.completed
-data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}
+data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.6-sol","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}
```
### 文本输入
@@ -33819,12 +33813,12 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": "Tell me a three sentence bedtime story about a unicorn."
}'
```
-#### Response
+#### 响应
```json
{
@@ -33837,7 +33831,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -33894,13 +33888,13 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"tools": [{ "type": "web_search_preview" }],
"input": "What was a positive news story from today?"
}'
```
-#### Response
+#### 响应
```json
{
@@ -33913,7 +33907,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "web_search_call",
@@ -34029,7 +34023,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -34043,7 +34037,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
**get** `/responses/{response_id}`
-使用给定 ID 检索模型响应。
+使用给定的 ID 检索模型响应。
### 路径参数
@@ -34053,8 +34047,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `include: optional array of ResponseIncludable`
- 响应中要包含的附加字段。有关更多信息,请参阅上文 Response 创建中的 `include`
- 参数。
+ 要在响应中包含的其他字段。详见上方 `include`
+ 参数的 Response 创建部分以了解更多信息。
- `"file_search_call.results"`
@@ -34074,23 +34068,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `include_obfuscation: optional boolean`
- 如果为 true,将启用流混淆。流混淆会向流式 delta 事件上的 obfuscation 字段添加
- 随机字符,以 `obfuscation` 字段(位于流式增量事件上)
- 用于规范化负载大小,作为对某些侧信道
- 攻击的缓解措施。这些混淆字段默认包含在内,但添加一个
- small amount of overhead to the data stream. You can set
- `include_obfuscation` to false to optimize for bandwidth if you trust
- 你的应用程序与 OpenAI API 之间的网络链路。
+ 为 true 时,将启用流混淆。流混淆会向流式增量事件上的
+ 字段添加 `obfuscation` 流式增量事件上的字段
+ 用于规范化负载大小,作为对某些侧信道的缓解措施
+ 攻击。这些混淆字段默认包含在内,但会给数据流带来
+ 少量开销。如果你信任你的应用程序与 OpenAI API 之间的网络链路,可以将
+ `include_obfuscation` 设为 false 以优化带宽。
+ 设为 false 以优化带宽。
- `starting_after: optional number`
- 开始流式输出时所依据的后续事件的序列号。
+ 开始流式传输的目标事件之后的事件序列号。
- `stream: optional false`
- 如果设置为 true,模型响应数据将在生成时流式传输到客户端
- ,使用 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
- 请参阅下方 [流式传输部分](/docs/api-reference/responses-streaming)
+ 如果设置为 true,模型响应数据将流式传输到客户端
+ ,使用 [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+ 参见下方 [流式传输部分](/docs/api-reference/responses-streaming)
了解更多信息。
- `false`
@@ -34105,7 +34099,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -34161,11 +34155,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -34175,13 +34169,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -34191,57 +34185,57 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -34253,25 +34247,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -34281,13 +34275,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -34297,33 +34291,33 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -34336,9 +34330,9 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -34346,24 +34340,24 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -34373,8 +34367,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -34390,11 +34384,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -34402,15 +34396,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -34418,11 +34412,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -34432,19 +34426,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -34454,7 +34448,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -34466,7 +34460,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -34474,11 +34468,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -34496,7 +34490,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -34532,15 +34526,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -34552,8 +34546,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -34569,9 +34563,9 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -34579,7 +34573,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -34588,7 +34582,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -34607,20 +34601,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -34639,7 +34633,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -34656,7 +34650,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -34676,8 +34670,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -34693,15 +34687,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -34715,25 +34709,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -34741,7 +34735,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -34755,11 +34749,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -34778,7 +34772,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -34788,11 +34782,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -34820,7 +34814,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -34852,15 +34846,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -34888,24 +34882,24 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -34929,26 +34923,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -34956,17 +34950,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -34982,7 +34976,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -34992,8 +34986,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -35001,12 +34995,12 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -35038,7 +35032,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -35052,7 +35046,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -35066,11 +35060,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -35082,7 +35076,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -35097,7 +35091,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -35139,8 +35133,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -35154,7 +35148,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -35162,61 +35156,61 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -35226,13 +35220,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -35246,23 +35240,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -35274,11 +35268,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -35306,15 +35300,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -35330,7 +35324,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -35368,11 +35362,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -35398,11 +35392,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -35410,7 +35404,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -35420,19 +35414,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -35441,9 +35435,9 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -35485,11 +35479,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -35503,7 +35497,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -35511,19 +35505,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -35531,25 +35525,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -35571,18 +35565,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -35590,22 +35584,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -35619,34 +35613,34 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -35664,36 +35658,36 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -35725,56 +35719,56 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -35782,26 +35776,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -35810,7 +35804,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -35820,7 +35814,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -35850,33 +35844,33 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -35892,7 +35886,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -35902,13 +35896,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -35918,11 +35912,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -35932,7 +35926,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -35940,22 +35934,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -35964,7 +35958,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -35979,7 +35973,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -35991,7 +35985,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -36002,7 +35996,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -36019,13 +36013,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -36069,13 +36063,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -36099,7 +36093,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -36115,7 +36109,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -36129,7 +36123,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -36137,13 +36131,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -36175,13 +36169,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -36191,7 +36185,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -36199,7 +36193,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -36213,7 +36207,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -36225,7 +36219,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -36235,7 +36229,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -36243,7 +36237,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -36265,7 +36259,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -36289,23 +36283,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -36313,7 +36307,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -36327,7 +36321,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -36339,17 +36333,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -36359,7 +36353,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -36371,11 +36365,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -36389,7 +36383,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -36399,37 +36393,37 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -36443,7 +36437,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -36477,21 +36471,21 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -36517,11 +36511,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -36529,7 +36523,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -36539,15 +36533,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -36555,7 +36549,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -36563,19 +36557,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -36583,25 +36577,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -36623,18 +36617,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -36642,22 +36636,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -36671,34 +36665,34 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -36716,36 +36710,36 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -36777,56 +36771,56 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -36834,26 +36828,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -36862,7 +36856,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -36872,7 +36866,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -36896,7 +36890,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -36912,7 +36906,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -36922,13 +36916,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -36938,11 +36932,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -36952,7 +36946,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -36960,22 +36954,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -36984,7 +36978,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -36999,7 +36993,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -37011,7 +37005,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -37022,7 +37016,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -37039,13 +37033,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -37093,7 +37087,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -37101,7 +37095,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -37115,7 +37109,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -37135,7 +37129,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -37159,23 +37153,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -37183,7 +37177,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -37197,7 +37191,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -37209,17 +37203,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -37229,7 +37223,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -37241,11 +37235,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -37259,7 +37253,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -37269,37 +37263,37 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -37313,19 +37307,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -37368,20 +37362,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -37391,7 +37385,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -37399,13 +37393,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -37433,7 +37427,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -37447,7 +37441,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -37456,7 +37450,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -37468,27 +37462,27 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -37502,7 +37496,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -37524,29 +37518,29 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -37560,7 +37554,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -37570,7 +37564,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -37578,13 +37572,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -37598,11 +37592,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -37610,7 +37604,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -37618,13 +37612,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -37660,7 +37654,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -37670,7 +37664,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -37678,7 +37672,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -37686,45 +37680,45 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -37752,7 +37746,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -37766,11 +37760,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -37782,11 +37776,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -37800,7 +37794,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -37814,11 +37808,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -37828,7 +37822,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -37836,13 +37830,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -37874,11 +37868,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -37886,13 +37880,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -37920,11 +37914,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -37948,7 +37942,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -37956,21 +37950,21 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -37982,39 +37976,39 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -38026,11 +38020,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -38038,18 +38032,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -38085,7 +38079,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -38099,7 +38093,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -38120,11 +38114,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -38138,7 +38132,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -38178,7 +38172,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -38188,7 +38182,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -38212,7 +38206,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -38220,7 +38214,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -38234,11 +38228,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -38258,11 +38252,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -38274,15 +38268,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -38290,24 +38284,24 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -38522,7 +38516,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -38530,20 +38524,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -38552,7 +38546,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -38571,20 +38565,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -38603,7 +38597,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -38620,7 +38614,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -38662,8 +38656,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -38688,15 +38682,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -38704,8 +38698,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -38721,7 +38715,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -38749,20 +38743,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -38770,12 +38764,12 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -38807,7 +38801,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -38821,7 +38815,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -38835,11 +38829,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -38851,7 +38845,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -38866,7 +38860,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -38886,8 +38880,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -38903,12 +38897,12 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -38918,16 +38912,16 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -38939,13 +38933,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -38962,13 +38956,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -39009,20 +39003,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -39046,11 +39040,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -39062,15 +39056,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -39078,7 +39072,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -39106,7 +39100,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -39116,13 +39110,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -39144,7 +39138,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -39154,15 +39148,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -39188,11 +39182,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -39200,7 +39194,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -39210,15 +39204,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -39226,7 +39220,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -39234,19 +39228,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -39254,25 +39248,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -39294,18 +39288,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -39313,22 +39307,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -39342,34 +39336,34 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -39387,36 +39381,36 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -39448,56 +39442,56 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -39505,26 +39499,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -39533,7 +39527,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -39543,7 +39537,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -39567,7 +39561,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -39583,7 +39577,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -39593,13 +39587,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -39609,11 +39603,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -39623,7 +39617,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -39631,22 +39625,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -39655,7 +39649,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -39670,7 +39664,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -39682,7 +39676,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -39693,7 +39687,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -39710,13 +39704,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -39764,7 +39758,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -39772,7 +39766,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -39786,7 +39780,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -39806,7 +39800,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -39830,23 +39824,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -39854,7 +39848,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -39868,7 +39862,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -39880,17 +39874,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -39900,7 +39894,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -39912,11 +39906,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -39930,7 +39924,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -39940,37 +39934,37 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -39984,23 +39978,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -40020,15 +40014,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -40054,11 +40048,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -40066,7 +40060,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -40076,15 +40070,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -40092,7 +40086,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -40100,19 +40094,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -40120,25 +40114,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -40160,18 +40154,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -40179,22 +40173,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -40208,34 +40202,34 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -40253,36 +40247,36 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -40314,56 +40308,56 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -40371,26 +40365,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -40399,7 +40393,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -40409,7 +40403,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -40433,7 +40427,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -40449,7 +40443,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -40459,13 +40453,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -40475,11 +40469,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -40489,7 +40483,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -40497,22 +40491,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -40521,7 +40515,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -40536,7 +40530,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -40548,7 +40542,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -40559,7 +40553,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -40576,13 +40570,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -40630,7 +40624,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -40638,7 +40632,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -40652,7 +40646,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -40672,7 +40666,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -40696,23 +40690,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -40720,7 +40714,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -40734,7 +40728,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -40746,17 +40740,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -40766,7 +40760,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -40778,11 +40772,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -40796,7 +40790,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -40806,37 +40800,37 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -40850,13 +40844,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -40864,17 +40858,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -40902,7 +40896,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -40916,7 +40910,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -40925,7 +40919,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -40937,27 +40931,27 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -40971,7 +40965,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -40993,29 +40987,29 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -41029,7 +41023,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -41039,7 +41033,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -41047,13 +41041,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -41063,25 +41057,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -41115,7 +41109,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -41125,7 +41119,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -41159,7 +41153,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -41171,25 +41165,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -41197,7 +41191,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -41211,11 +41205,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -41251,7 +41245,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -41259,11 +41253,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -41279,11 +41273,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -41293,7 +41287,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -41311,7 +41305,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -41321,7 +41315,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -41329,7 +41323,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -41359,19 +41353,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -41379,7 +41373,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -41405,7 +41399,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -41421,11 +41415,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -41433,18 +41427,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -41452,7 +41446,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -41466,7 +41460,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -41490,7 +41484,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -41498,21 +41492,21 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -41524,39 +41518,39 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -41572,7 +41566,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -41582,7 +41576,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -41606,7 +41600,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -41633,11 +41627,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -41645,8 +41639,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -41686,7 +41680,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -41694,20 +41688,20 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -41722,14 +41716,14 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -41799,7 +41793,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -41869,31 +41863,31 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -41919,11 +41913,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -41931,7 +41925,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -41941,15 +41935,15 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -41957,7 +41951,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -41965,19 +41959,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -41985,25 +41979,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -42025,18 +42019,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -42044,22 +42038,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -42073,34 +42067,34 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -42118,36 +42112,36 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -42179,56 +42173,56 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -42236,26 +42230,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -42264,7 +42258,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -42274,7 +42268,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -42298,7 +42292,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -42314,7 +42308,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -42324,13 +42318,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -42340,11 +42334,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -42354,7 +42348,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -42362,22 +42356,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -42386,7 +42380,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -42401,7 +42395,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -42413,7 +42407,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -42424,7 +42418,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -42441,13 +42435,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -42495,7 +42489,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -42503,7 +42497,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -42517,7 +42511,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -42537,7 +42531,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -42561,23 +42555,23 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -42585,7 +42579,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -42599,7 +42593,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -42611,17 +42605,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -42631,7 +42625,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -42643,11 +42637,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -42661,7 +42655,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -42671,37 +42665,37 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -42715,26 +42709,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -42742,19 +42736,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -42762,11 +42756,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -42774,25 +42768,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -42804,13 +42798,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -42818,11 +42812,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -42830,25 +42824,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -42860,26 +42854,26 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -42887,19 +42881,19 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -42911,11 +42905,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -42933,18 +42927,18 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -42952,19 +42946,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -42975,13 +42967,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -42999,11 +42991,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -43013,17 +43005,17 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -43031,11 +43023,11 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -43045,21 +43037,21 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -43077,8 +43069,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -43094,31 +43086,31 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -43128,13 +43120,13 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -43150,22 +43142,22 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -43175,9 +43167,9 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -43188,10 +43180,10 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -43199,8 +43191,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -43209,8 +43201,8 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -43218,7 +43210,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -43227,7 +43219,7 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -43235,25 +43227,25 @@ curl -X DELETE https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
### 示例
@@ -43262,7 +43254,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -43279,7 +43271,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID \
"metadata": {
"foo": "string"
},
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"object": "response",
"output": [
{
@@ -43443,7 +43435,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -43456,7 +43448,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-4o-2024-08-06",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -43508,17 +43500,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
## Domain Types
-### 压缩后的响应
+### Compacted Response
- `CompactedResponse object { id, created_at, object, 2 more }`
- `id: string`
- 已压缩响应的唯一标识符。
+ 压缩响应的唯一标识符。
- `created_at: number`
- 已压缩对话创建时的 Unix 时间戳(以秒为单位)。
+ 压缩对话创建时的 Unix 时间戳(以秒为单位)。
- `object: "response.compaction"`
@@ -43528,11 +43520,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of Message or object { id, call_id, code, 2 more } or object { id, call_id, result, 2 more } or 25 more`
- 已压缩的输出项列表。
+ 压缩后的输出项列表。
- `Message object { id, content, role, 3 more }`
- 发送给模型或来自模型的消息。
+ 发给模型或来自模型的消息。
- `id: string`
@@ -43544,39 +43536,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -43584,11 +43576,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -43598,19 +43590,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -43620,7 +43612,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -43632,7 +43624,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -43640,11 +43632,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -43662,7 +43654,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -43736,25 +43728,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -43766,39 +43758,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ComputerScreenshotContent object { detail, file_id, image_url, 2 more }`
- 计算机的截图。
+ 计算机的屏幕截图。
- `detail: ImageDetail`
- 将发送给模型的截图图像的细节级别。取值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的屏幕截图图像的细节级别。取值为 `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: string or null`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: string or null`
@@ -43806,17 +43798,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机屏幕截图,此属性始终设置为 `computer_screenshot`.
- `"computer_screenshot"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -43826,13 +43818,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -43842,33 +43834,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "unknown" or "user" or "assistant" or 5 more`
- 消息的角色。取值之一 `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`,或 `tool`.
+ 消息的角色。可选值为 `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`.
- `"unknown"`
@@ -43888,7 +43880,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -43904,7 +43896,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`)。对于类似 `gpt-5.3-codex` 及更高版本等模型,在发送后续请求时,请在所有助手消息上保留并重新发送 phase,删除它可能会导致性能下降。不用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`)。对于 `gpt-5.3-codex` 及更高模型,在发送后续请求时,请在所有助手消息上保留并重新发送 phase 字段——删除它可能会降低性能。用户消息不使用该字段。
- `"commentary"`
@@ -43926,11 +43918,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -43942,15 +43934,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -43958,7 +43950,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -43973,7 +43965,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -44015,8 +44007,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -44048,7 +44040,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -44058,13 +44050,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -44086,7 +44078,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -44096,15 +44088,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -44130,11 +44122,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -44142,7 +44134,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -44152,19 +44144,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -44173,9 +44165,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -44217,11 +44209,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -44235,7 +44227,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -44243,19 +44235,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -44263,25 +44255,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -44303,18 +44295,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -44322,22 +44314,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -44351,34 +44343,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -44396,36 +44388,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -44457,56 +44449,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -44514,26 +44506,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -44542,7 +44534,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -44552,7 +44544,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -44582,33 +44574,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -44624,7 +44616,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -44634,13 +44626,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -44650,11 +44642,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -44664,7 +44656,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -44672,22 +44664,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -44696,7 +44688,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -44711,7 +44703,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -44723,7 +44715,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -44734,7 +44726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -44751,13 +44743,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -44801,13 +44793,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -44831,7 +44823,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -44847,7 +44839,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -44861,7 +44853,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -44869,13 +44861,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -44907,13 +44899,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -44923,7 +44915,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -44931,7 +44923,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -44945,7 +44937,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -44957,7 +44949,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -44967,7 +44959,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -44975,7 +44967,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -44997,7 +44989,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -45021,23 +45013,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -45045,7 +45037,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -45059,7 +45051,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -45071,17 +45063,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -45091,7 +45083,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -45103,11 +45095,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -45121,7 +45113,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -45131,37 +45123,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -45175,23 +45167,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -45211,15 +45203,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -45245,11 +45237,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -45257,7 +45249,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -45267,15 +45259,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -45283,7 +45275,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -45291,19 +45283,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -45311,25 +45303,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -45351,18 +45343,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -45370,22 +45362,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -45399,34 +45391,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -45444,36 +45436,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -45505,56 +45497,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -45562,26 +45554,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -45590,7 +45582,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -45600,7 +45592,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -45624,7 +45616,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -45640,7 +45632,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -45650,13 +45642,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -45666,11 +45658,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -45680,7 +45672,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -45688,22 +45680,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -45712,7 +45704,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -45727,7 +45719,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -45739,7 +45731,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -45750,7 +45742,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -45767,13 +45759,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -45821,7 +45813,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -45829,7 +45821,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -45843,7 +45835,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -45863,7 +45855,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -45887,23 +45879,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -45911,7 +45903,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -45925,7 +45917,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -45937,17 +45929,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -45957,7 +45949,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -45969,11 +45961,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -45987,7 +45979,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -45997,37 +45989,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -46041,7 +46033,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
@@ -46060,15 +46052,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -46087,7 +46079,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -46115,16 +46107,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -46134,7 +46126,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -46143,7 +46135,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -46162,20 +46154,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -46194,7 +46186,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -46202,8 +46194,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -46211,12 +46203,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -46248,7 +46240,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -46262,7 +46254,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -46276,11 +46268,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -46292,7 +46284,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -46322,7 +46314,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -46337,7 +46329,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -46357,8 +46349,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -46374,15 +46366,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -46396,25 +46388,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -46422,7 +46414,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -46436,11 +46428,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -46459,7 +46451,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -46469,11 +46461,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -46501,7 +46493,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -46533,15 +46525,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -46569,24 +46561,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -46616,22 +46608,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -46639,8 +46631,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -46652,13 +46644,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -46675,13 +46667,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -46722,20 +46714,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -46745,7 +46737,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -46753,17 +46745,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `CodeInterpreterCall object { id, code, container_id, 3 more }`
@@ -46775,7 +46767,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -46784,7 +46776,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -46796,27 +46788,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -46830,7 +46822,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -46852,29 +46844,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -46888,7 +46880,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -46898,7 +46890,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -46906,13 +46898,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -46922,25 +46914,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -46974,7 +46966,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -46984,7 +46976,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -47018,7 +47010,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -47030,25 +47022,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -47056,7 +47048,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -47070,11 +47062,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -47110,7 +47102,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -47118,11 +47110,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -47138,11 +47130,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -47152,7 +47144,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -47170,7 +47162,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -47180,7 +47172,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -47188,7 +47180,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -47218,19 +47210,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -47238,7 +47230,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -47264,7 +47256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -47272,7 +47264,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -47296,7 +47288,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -47304,21 +47296,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -47330,39 +47322,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -47374,11 +47366,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -47386,18 +47378,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -47433,7 +47425,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -47459,7 +47451,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -47469,7 +47461,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -47493,11 +47485,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -47518,11 +47510,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -47536,7 +47528,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -47564,7 +47556,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: ResponseUsage`
- 压缩过程阶段的 token 统计,包括缓存 token、推理 token 和总 token。
+ 压缩过程的令牌统计,包括缓存、推理和总令牌。
- `input_tokens: number`
@@ -47572,7 +47564,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -47581,7 +47573,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -47589,33 +47581,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
### Computer Action
- `ComputerAction = object { button, type, x, 2 more } or object { keys, type, x, y } or object { path, type, keys } or 6 more`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -47629,25 +47621,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -47655,7 +47647,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -47669,11 +47661,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -47692,7 +47684,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -47702,11 +47694,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -47734,7 +47726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -47766,15 +47758,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -47804,16 +47796,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerActionList = array of ComputerAction`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -47827,25 +47819,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -47853,7 +47845,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -47867,11 +47859,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -47890,7 +47882,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -47900,11 +47892,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -47932,7 +47924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -47964,15 +47956,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -48004,13 +47996,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -48040,33 +48032,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -48082,7 +48074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -48096,7 +48088,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -48104,13 +48096,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -48126,29 +48118,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
### Container Network Policy Disabled
@@ -48166,15 +48158,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
### Container Reference
@@ -48182,7 +48174,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -48194,57 +48186,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -48256,25 +48248,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -48284,13 +48276,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -48300,33 +48292,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -48339,9 +48331,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -48349,7 +48341,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
@@ -48379,7 +48371,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -48387,13 +48379,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -48407,7 +48399,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `InlineSkillSource object { data, media_type, type }`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -48415,13 +48407,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -48449,7 +48441,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
### Local Skill
@@ -48465,7 +48457,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
### Mcp Tool Call Error
@@ -48499,7 +48491,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"http_error"`
-### Response
+### 响应
- `Response object { id, created_at, error, 32 more }`
@@ -48509,7 +48501,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -48565,11 +48557,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -48579,13 +48571,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -48595,57 +48587,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -48657,25 +48649,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -48685,13 +48677,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -48701,33 +48693,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -48740,9 +48732,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -48750,24 +48742,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -48777,8 +48769,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -48794,11 +48786,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -48806,15 +48798,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -48822,11 +48814,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -48836,19 +48828,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -48858,7 +48850,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -48870,7 +48862,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -48878,11 +48870,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -48900,7 +48892,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -48936,15 +48928,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -48956,8 +48948,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -48973,9 +48965,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -48983,7 +48975,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -48992,7 +48984,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -49011,20 +49003,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -49043,7 +49035,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -49060,7 +49052,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -49080,8 +49072,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -49097,15 +49089,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -49119,25 +49111,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -49145,7 +49137,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -49159,11 +49151,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -49182,7 +49174,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -49192,11 +49184,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -49224,7 +49216,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -49256,15 +49248,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -49292,24 +49284,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -49333,26 +49325,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -49360,17 +49352,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -49386,7 +49378,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -49396,8 +49388,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -49405,12 +49397,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -49442,7 +49434,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -49456,7 +49448,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -49470,11 +49462,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -49486,7 +49478,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -49501,7 +49493,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -49543,8 +49535,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -49558,7 +49550,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -49566,61 +49558,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -49630,13 +49622,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -49650,23 +49642,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -49678,11 +49670,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -49710,15 +49702,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -49734,7 +49726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -49772,11 +49764,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -49802,11 +49794,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -49814,7 +49806,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -49824,19 +49816,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -49845,9 +49837,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -49889,11 +49881,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -49907,7 +49899,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -49915,19 +49907,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -49935,25 +49927,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -49975,18 +49967,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -49994,22 +49986,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -50023,34 +50015,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -50068,36 +50060,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -50129,56 +50121,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -50186,26 +50178,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -50214,7 +50206,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -50224,7 +50216,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -50254,33 +50246,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -50296,7 +50288,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -50306,13 +50298,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -50322,11 +50314,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -50336,7 +50328,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -50344,22 +50336,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -50368,7 +50360,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -50383,7 +50375,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -50395,7 +50387,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -50406,7 +50398,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -50423,13 +50415,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -50473,13 +50465,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -50503,7 +50495,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -50519,7 +50511,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -50533,7 +50525,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -50541,13 +50533,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -50579,13 +50571,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -50595,7 +50587,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -50603,7 +50595,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -50617,7 +50609,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -50629,7 +50621,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -50639,7 +50631,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -50647,7 +50639,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -50669,7 +50661,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -50693,23 +50685,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -50717,7 +50709,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -50731,7 +50723,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -50743,17 +50735,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -50763,7 +50755,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -50775,11 +50767,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -50793,7 +50785,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -50803,37 +50795,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -50847,7 +50839,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -50881,21 +50873,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -50921,11 +50913,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -50933,7 +50925,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -50943,15 +50935,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -50959,7 +50951,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -50967,19 +50959,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -50987,25 +50979,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -51027,18 +51019,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -51046,22 +51038,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -51075,34 +51067,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -51120,36 +51112,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -51181,56 +51173,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -51238,26 +51230,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -51266,7 +51258,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -51276,7 +51268,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -51300,7 +51292,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -51316,7 +51308,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -51326,13 +51318,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -51342,11 +51334,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -51356,7 +51348,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -51364,22 +51356,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -51388,7 +51380,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -51403,7 +51395,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -51415,7 +51407,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -51426,7 +51418,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -51443,13 +51435,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -51497,7 +51489,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -51505,7 +51497,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -51519,7 +51511,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -51539,7 +51531,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -51563,23 +51555,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -51587,7 +51579,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -51601,7 +51593,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -51613,17 +51605,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -51633,7 +51625,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -51645,11 +51637,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -51663,7 +51655,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -51673,37 +51665,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -51717,19 +51709,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -51772,20 +51764,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -51795,7 +51787,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -51803,13 +51795,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -51837,7 +51829,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -51851,7 +51843,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -51860,7 +51852,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -51872,27 +51864,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -51906,7 +51898,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -51928,29 +51920,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -51964,7 +51956,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -51974,7 +51966,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -51982,13 +51974,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -52002,11 +51994,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -52014,7 +52006,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -52022,13 +52014,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -52064,7 +52056,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -52074,7 +52066,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -52082,7 +52074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -52090,45 +52082,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -52156,7 +52148,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -52170,11 +52162,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -52186,11 +52178,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -52204,7 +52196,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -52218,11 +52210,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -52232,7 +52224,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -52240,13 +52232,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -52278,11 +52270,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -52290,13 +52282,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -52324,11 +52316,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -52352,7 +52344,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -52360,21 +52352,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -52386,39 +52378,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -52430,11 +52422,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -52442,18 +52434,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -52489,7 +52481,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -52503,7 +52495,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -52524,11 +52516,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -52542,7 +52534,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -52582,7 +52574,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -52592,7 +52584,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -52616,7 +52608,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -52624,7 +52616,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -52638,11 +52630,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -52662,11 +52654,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -52678,15 +52670,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -52694,24 +52686,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -52926,7 +52918,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -52934,20 +52926,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -52956,7 +52948,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -52975,20 +52967,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -53007,7 +52999,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -53024,7 +53016,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -53066,8 +53058,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -53092,15 +53084,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -53108,8 +53100,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -53125,7 +53117,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -53153,20 +53145,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -53174,12 +53166,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -53211,7 +53203,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -53225,7 +53217,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -53239,11 +53231,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -53255,7 +53247,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -53270,7 +53262,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -53290,8 +53282,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -53307,12 +53299,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -53322,16 +53314,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -53343,13 +53335,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -53366,13 +53358,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -53413,20 +53405,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -53450,11 +53442,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -53466,15 +53458,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -53482,7 +53474,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -53510,7 +53502,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -53520,13 +53512,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -53548,7 +53540,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -53558,15 +53550,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -53592,11 +53584,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -53604,7 +53596,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -53614,15 +53606,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -53630,7 +53622,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -53638,19 +53630,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -53658,25 +53650,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -53698,18 +53690,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -53717,22 +53709,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -53746,34 +53738,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -53791,36 +53783,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -53852,56 +53844,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -53909,26 +53901,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -53937,7 +53929,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -53947,7 +53939,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -53971,7 +53963,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -53987,7 +53979,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -53997,13 +53989,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -54013,11 +54005,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -54027,7 +54019,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -54035,22 +54027,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -54059,7 +54051,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -54074,7 +54066,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -54086,7 +54078,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -54097,7 +54089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -54114,13 +54106,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -54168,7 +54160,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -54176,7 +54168,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -54190,7 +54182,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -54210,7 +54202,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -54234,23 +54226,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -54258,7 +54250,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -54272,7 +54264,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -54284,17 +54276,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -54304,7 +54296,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -54316,11 +54308,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -54334,7 +54326,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -54344,37 +54336,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -54388,23 +54380,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -54424,15 +54416,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -54458,11 +54450,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -54470,7 +54462,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -54480,15 +54472,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -54496,7 +54488,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -54504,19 +54496,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -54524,25 +54516,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -54564,18 +54556,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -54583,22 +54575,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -54612,34 +54604,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -54657,36 +54649,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -54718,56 +54710,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -54775,26 +54767,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -54803,7 +54795,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -54813,7 +54805,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -54837,7 +54829,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -54853,7 +54845,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -54863,13 +54855,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -54879,11 +54871,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -54893,7 +54885,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -54901,22 +54893,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -54925,7 +54917,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -54940,7 +54932,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -54952,7 +54944,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -54963,7 +54955,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -54980,13 +54972,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -55034,7 +55026,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -55042,7 +55034,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -55056,7 +55048,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -55076,7 +55068,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -55100,23 +55092,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -55124,7 +55116,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -55138,7 +55130,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -55150,17 +55142,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -55170,7 +55162,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -55182,11 +55174,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -55200,7 +55192,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -55210,37 +55202,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -55254,13 +55246,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -55268,17 +55260,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -55306,7 +55298,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -55320,7 +55312,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -55329,7 +55321,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -55341,27 +55333,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -55375,7 +55367,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -55397,29 +55389,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -55433,7 +55425,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -55443,7 +55435,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -55451,13 +55443,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -55467,25 +55459,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -55519,7 +55511,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -55529,7 +55521,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -55563,7 +55555,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -55575,25 +55567,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -55601,7 +55593,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -55615,11 +55607,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -55655,7 +55647,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -55663,11 +55655,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -55683,11 +55675,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -55697,7 +55689,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -55715,7 +55707,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -55725,7 +55717,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -55733,7 +55725,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -55763,19 +55755,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -55783,7 +55775,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -55809,7 +55801,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -55825,11 +55817,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -55837,18 +55829,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -55856,7 +55848,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -55870,7 +55862,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -55894,7 +55886,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -55902,21 +55894,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -55928,39 +55920,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -55976,7 +55968,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -55986,7 +55978,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -56010,7 +56002,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -56037,11 +56029,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -56049,8 +56041,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -56090,7 +56082,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -56098,20 +56090,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -56126,14 +56118,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -56203,7 +56195,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -56273,31 +56265,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -56323,11 +56315,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -56335,7 +56327,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -56345,15 +56337,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -56361,7 +56353,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -56369,19 +56361,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -56389,25 +56381,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -56429,18 +56421,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -56448,22 +56440,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -56477,34 +56469,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -56522,36 +56514,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -56583,56 +56575,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -56640,26 +56632,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -56668,7 +56660,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -56678,7 +56670,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -56702,7 +56694,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -56718,7 +56710,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -56728,13 +56720,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -56744,11 +56736,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -56758,7 +56750,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -56766,22 +56758,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -56790,7 +56782,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -56805,7 +56797,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -56817,7 +56809,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -56828,7 +56820,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -56845,13 +56837,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -56899,7 +56891,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -56907,7 +56899,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -56921,7 +56913,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -56941,7 +56933,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -56965,23 +56957,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -56989,7 +56981,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -57003,7 +56995,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -57015,17 +57007,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -57035,7 +57027,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -57047,11 +57039,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -57065,7 +57057,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -57075,37 +57067,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -57119,26 +57111,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -57146,19 +57138,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -57166,11 +57158,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -57178,25 +57170,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -57208,13 +57200,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -57222,11 +57214,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -57234,25 +57226,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -57264,26 +57256,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -57291,19 +57283,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -57315,11 +57307,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -57337,18 +57329,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -57356,19 +57348,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -57379,13 +57369,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -57403,11 +57393,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -57417,17 +57407,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -57435,11 +57425,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -57449,21 +57439,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -57481,8 +57471,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -57498,31 +57488,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -57532,13 +57522,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -57554,22 +57544,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -57579,9 +57569,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -57592,10 +57582,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -57603,8 +57593,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -57613,8 +57603,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -57622,7 +57612,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -57631,7 +57621,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -57639,31 +57629,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
### Response Audio Delta Event
- `ResponseAudioDeltaEvent object { delta, sequence_number, type }`
- 当存在部分音频响应时发出。
+ 当出现部分音频响应时发出。
- `delta: string`
@@ -57671,7 +57661,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该流式响应分块对应的序列号。
+ 该流式响应片段的序列号。
- `type: "response.audio.delta"`
@@ -57679,7 +57669,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.audio.delta"`
-### Response Audio Done Event
+### Response Audio Done 事件
- `ResponseAudioDoneEvent object { sequence_number, type }`
@@ -57687,7 +57677,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 增量数据的序列号。
+ 增量事件的序列号。
- `type: "response.audio.done"`
@@ -57707,7 +57697,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.audio.transcript.delta"`
@@ -57719,11 +57709,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseAudioTranscriptDoneEvent object { sequence_number, type }`
- 在整个音频转录完成时发出。
+ 当完整音频转写完成时发出。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.audio.transcript.done"`
@@ -57731,27 +57721,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.audio.transcript.done"`
-### Response Code Interpreter 调用代码增量事件
+### Response Code Interpreter Call Code Delta 事件
- `ResponseCodeInterpreterCallCodeDeltaEvent object { delta, item_id, output_index, 2 more }`
- 当代码解释器流式输出部分代码片段时触发。
+ 当代码解释器流式传输出部分代码片段时发出。
- `delta: string`
- 由代码解释器流式输出的部分代码片段。
+ 代码解释器正在流式传输的部分代码片段。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中正在流式输出代码的输出项的索引。
+ 响应中正在流式传输代码的输出条目的索引。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call_code.delta"`
@@ -57759,27 +57749,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.code_interpreter_call_code.delta"`
-### Response 代码解释器调用 代码完成事件
+### 响应代码解释器调用完成事件
- `ResponseCodeInterpreterCallCodeDoneEvent object { code, item_id, output_index, 2 more }`
- 当代码片段由代码解释器完成时发出。
+ 当代码解释器最终确定代码片段时发出。
- `code: string`
- 代码解释器输出的最终代码片段。
+ 由代码解释器输出的最终代码片段。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中已最终确定代码的输出项的索引。
+ 响应中输出项的索引,该输出项的代码已最终确定。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call_code.done"`
@@ -57795,7 +57785,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
@@ -57803,7 +57793,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call.completed"`
@@ -57811,23 +57801,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.code_interpreter_call.completed"`
-### Response 代码解释器调用进行中事件
+### Response Code Interpreter Call In Progress 事件
- `ResponseCodeInterpreterCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 当一次代码解释器调用正在进行时触发。
+ 当代码解释器调用正在进行时发出。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中正在进行代码解释器调用的输出项的索引。
+ 响应中正在执行代码解释器调用的输出项的索引。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call.in_progress"`
@@ -57835,23 +57825,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.code_interpreter_call.in_progress"`
-### Response Code Interpreter 调用解释事件
+### Response 代码解释器调用解释事件
- `ResponseCodeInterpreterCallInterpretingEvent object { item_id, output_index, sequence_number, type }`
- 在代码解释器正在积极解释代码片段时发出。
+ 当代码解释器正在主动解释代码片段时发出。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中输出项的索引,表示代码解释器正在为其解释代码。
+ 响应中代码解释器正在解释代码的输出项索引。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call.interpreting"`
@@ -57859,7 +57849,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.code_interpreter_call.interpreting"`
-### Response Completed 事件
+### Response Completed Event
- `ResponseCompletedEvent object { response, sequence_number, type }`
@@ -57875,7 +57865,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -57931,11 +57921,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -57945,13 +57935,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -57961,57 +57951,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -58023,25 +58013,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -58051,13 +58041,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -58067,33 +58057,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -58106,9 +58096,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -58116,24 +58106,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -58143,8 +58133,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -58160,11 +58150,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -58172,15 +58162,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -58188,11 +58178,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -58202,19 +58192,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -58224,7 +58214,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -58236,7 +58226,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -58244,11 +58234,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -58266,7 +58256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -58302,15 +58292,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -58322,8 +58312,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -58339,9 +58329,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -58349,7 +58339,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -58358,7 +58348,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -58377,20 +58367,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -58409,7 +58399,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -58426,7 +58416,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -58446,8 +58436,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -58463,15 +58453,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -58485,25 +58475,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -58511,7 +58501,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -58525,11 +58515,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -58548,7 +58538,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -58558,11 +58548,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -58590,7 +58580,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -58622,15 +58612,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -58658,24 +58648,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -58699,26 +58689,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -58726,17 +58716,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -58752,7 +58742,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -58762,8 +58752,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -58771,12 +58761,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -58808,7 +58798,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -58822,7 +58812,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -58836,11 +58826,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -58852,7 +58842,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -58867,7 +58857,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -58909,8 +58899,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -58924,7 +58914,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -58932,61 +58922,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -58996,13 +58986,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -59016,23 +59006,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -59044,11 +59034,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -59076,15 +59066,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -59100,7 +59090,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -59138,11 +59128,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -59168,11 +59158,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -59180,7 +59170,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -59190,19 +59180,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -59211,9 +59201,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -59255,11 +59245,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -59273,7 +59263,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -59281,19 +59271,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -59301,25 +59291,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -59341,18 +59331,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -59360,22 +59350,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -59389,34 +59379,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -59434,36 +59424,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -59495,56 +59485,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -59552,26 +59542,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -59580,7 +59570,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -59590,7 +59580,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -59620,33 +59610,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -59662,7 +59652,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -59672,13 +59662,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -59688,11 +59678,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -59702,7 +59692,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -59710,22 +59700,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -59734,7 +59724,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -59749,7 +59739,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -59761,7 +59751,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -59772,7 +59762,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -59789,13 +59779,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -59839,13 +59829,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -59869,7 +59859,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -59885,7 +59875,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -59899,7 +59889,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -59907,13 +59897,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -59945,13 +59935,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -59961,7 +59951,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -59969,7 +59959,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -59983,7 +59973,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -59995,7 +59985,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -60005,7 +59995,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -60013,7 +60003,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -60035,7 +60025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -60059,23 +60049,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -60083,7 +60073,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -60097,7 +60087,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -60109,17 +60099,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -60129,7 +60119,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -60141,11 +60131,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -60159,7 +60149,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -60169,37 +60159,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -60213,7 +60203,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -60247,21 +60237,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -60287,11 +60277,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -60299,7 +60289,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -60309,15 +60299,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -60325,7 +60315,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -60333,19 +60323,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -60353,25 +60343,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -60393,18 +60383,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -60412,22 +60402,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -60441,34 +60431,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -60486,36 +60476,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -60547,56 +60537,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -60604,26 +60594,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -60632,7 +60622,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -60642,7 +60632,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -60666,7 +60656,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -60682,7 +60672,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -60692,13 +60682,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -60708,11 +60698,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -60722,7 +60712,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -60730,22 +60720,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -60754,7 +60744,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -60769,7 +60759,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -60781,7 +60771,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -60792,7 +60782,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -60809,13 +60799,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -60863,7 +60853,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -60871,7 +60861,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -60885,7 +60875,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -60905,7 +60895,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -60929,23 +60919,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -60953,7 +60943,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -60967,7 +60957,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -60979,17 +60969,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -60999,7 +60989,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -61011,11 +61001,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -61029,7 +61019,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -61039,37 +61029,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -61083,19 +61073,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -61138,20 +61128,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -61161,7 +61151,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -61169,13 +61159,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -61203,7 +61193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -61217,7 +61207,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -61226,7 +61216,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -61238,27 +61228,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -61272,7 +61262,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -61294,29 +61284,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -61330,7 +61320,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -61340,7 +61330,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -61348,13 +61338,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -61368,11 +61358,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -61380,7 +61370,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -61388,13 +61378,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -61430,7 +61420,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -61440,7 +61430,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -61448,7 +61438,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -61456,45 +61446,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -61522,7 +61512,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -61536,11 +61526,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -61552,11 +61542,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -61570,7 +61560,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -61584,11 +61574,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -61598,7 +61588,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -61606,13 +61596,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -61644,11 +61634,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -61656,13 +61646,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -61690,11 +61680,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -61718,7 +61708,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -61726,21 +61716,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -61752,39 +61742,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -61796,11 +61786,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -61808,18 +61798,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -61855,7 +61845,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -61869,7 +61859,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -61890,11 +61880,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -61908,7 +61898,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -61948,7 +61938,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -61958,7 +61948,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -61982,7 +61972,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -61990,7 +61980,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -62004,11 +61994,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -62028,11 +62018,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -62044,15 +62034,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -62060,24 +62050,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -62292,7 +62282,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -62300,20 +62290,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -62322,7 +62312,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -62341,20 +62331,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -62373,7 +62363,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -62390,7 +62380,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -62432,8 +62422,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -62458,15 +62448,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -62474,8 +62464,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -62491,7 +62481,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -62519,20 +62509,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -62540,12 +62530,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -62577,7 +62567,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -62591,7 +62581,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -62605,11 +62595,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -62621,7 +62611,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -62636,7 +62626,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -62656,8 +62646,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -62673,12 +62663,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -62688,16 +62678,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -62709,13 +62699,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -62732,13 +62722,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -62779,20 +62769,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -62816,11 +62806,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -62832,15 +62822,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -62848,7 +62838,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -62876,7 +62866,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -62886,13 +62876,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -62914,7 +62904,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -62924,15 +62914,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -62958,11 +62948,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -62970,7 +62960,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -62980,15 +62970,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -62996,7 +62986,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -63004,19 +62994,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -63024,25 +63014,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -63064,18 +63054,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -63083,22 +63073,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -63112,34 +63102,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -63157,36 +63147,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -63218,56 +63208,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -63275,26 +63265,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -63303,7 +63293,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -63313,7 +63303,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -63337,7 +63327,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -63353,7 +63343,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -63363,13 +63353,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -63379,11 +63369,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -63393,7 +63383,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -63401,22 +63391,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -63425,7 +63415,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -63440,7 +63430,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -63452,7 +63442,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -63463,7 +63453,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -63480,13 +63470,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -63534,7 +63524,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -63542,7 +63532,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -63556,7 +63546,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -63576,7 +63566,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -63600,23 +63590,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -63624,7 +63614,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -63638,7 +63628,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -63650,17 +63640,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -63670,7 +63660,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -63682,11 +63672,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -63700,7 +63690,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -63710,37 +63700,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -63754,23 +63744,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -63790,15 +63780,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -63824,11 +63814,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -63836,7 +63826,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -63846,15 +63836,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -63862,7 +63852,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -63870,19 +63860,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -63890,25 +63880,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -63930,18 +63920,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -63949,22 +63939,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -63978,34 +63968,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -64023,36 +64013,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -64084,56 +64074,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -64141,26 +64131,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -64169,7 +64159,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -64179,7 +64169,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -64203,7 +64193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -64219,7 +64209,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -64229,13 +64219,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -64245,11 +64235,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -64259,7 +64249,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -64267,22 +64257,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -64291,7 +64281,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -64306,7 +64296,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -64318,7 +64308,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -64329,7 +64319,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -64346,13 +64336,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -64400,7 +64390,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -64408,7 +64398,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -64422,7 +64412,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -64442,7 +64432,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -64466,23 +64456,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -64490,7 +64480,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -64504,7 +64494,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -64516,17 +64506,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -64536,7 +64526,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -64548,11 +64538,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -64566,7 +64556,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -64576,37 +64566,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -64620,13 +64610,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -64634,17 +64624,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -64672,7 +64662,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -64686,7 +64676,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -64695,7 +64685,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -64707,27 +64697,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -64741,7 +64731,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -64763,29 +64753,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -64799,7 +64789,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -64809,7 +64799,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -64817,13 +64807,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -64833,25 +64823,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -64885,7 +64875,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -64895,7 +64885,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -64929,7 +64919,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -64941,25 +64931,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -64967,7 +64957,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -64981,11 +64971,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -65021,7 +65011,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -65029,11 +65019,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -65049,11 +65039,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -65063,7 +65053,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -65081,7 +65071,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -65091,7 +65081,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -65099,7 +65089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -65129,19 +65119,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -65149,7 +65139,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -65175,7 +65165,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -65191,11 +65181,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -65203,18 +65193,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -65222,7 +65212,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -65236,7 +65226,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -65260,7 +65250,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -65268,21 +65258,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -65294,39 +65284,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -65342,7 +65332,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -65352,7 +65342,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -65376,7 +65366,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -65403,11 +65393,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -65415,8 +65405,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -65456,7 +65446,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -65464,20 +65454,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -65492,14 +65482,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -65569,7 +65559,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -65639,31 +65629,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -65689,11 +65679,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -65701,7 +65691,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -65711,15 +65701,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -65727,7 +65717,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -65735,19 +65725,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -65755,25 +65745,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -65795,18 +65785,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -65814,22 +65804,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -65843,34 +65833,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -65888,36 +65878,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -65949,56 +65939,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -66006,26 +65996,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -66034,7 +66024,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -66044,7 +66034,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -66068,7 +66058,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -66084,7 +66074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -66094,13 +66084,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -66110,11 +66100,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -66124,7 +66114,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -66132,22 +66122,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -66156,7 +66146,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -66171,7 +66161,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -66183,7 +66173,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -66194,7 +66184,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -66211,13 +66201,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -66265,7 +66255,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -66273,7 +66263,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -66287,7 +66277,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -66307,7 +66297,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -66331,23 +66321,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -66355,7 +66345,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -66369,7 +66359,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -66381,17 +66371,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -66401,7 +66391,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -66413,11 +66403,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -66431,7 +66421,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -66441,37 +66431,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -66485,26 +66475,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -66512,19 +66502,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -66532,11 +66522,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -66544,25 +66534,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -66574,13 +66564,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -66588,11 +66578,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -66600,25 +66590,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -66630,26 +66620,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -66657,19 +66647,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -66681,11 +66671,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -66703,18 +66693,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -66722,19 +66712,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -66745,13 +66733,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -66769,11 +66757,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -66783,17 +66771,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -66801,11 +66789,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -66815,21 +66803,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -66847,8 +66835,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -66864,31 +66852,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -66898,13 +66886,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -66920,22 +66908,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -66945,9 +66933,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -66958,10 +66946,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -66969,8 +66957,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -66979,8 +66967,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -66988,7 +66976,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -66997,7 +66985,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -67005,25 +66993,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
@@ -67035,22 +67023,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.completed"`
-### Response 电脑工具调用输出截图
+### Response 计算机工具调用输出截图
- `ResponseComputerToolCallOutputScreenshot object { type, file_id, image_url }`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -67074,39 +67062,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseContent = ResponseInputText or ResponseInputImage or ResponseInputFile or 3 more`
- 多模态输入和输出内容。
+ 多模态输入与输出内容。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -67118,25 +67106,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -67146,13 +67134,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -67162,41 +67150,41 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -67204,11 +67192,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -67218,19 +67206,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -67240,7 +67228,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -67252,7 +67240,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -67260,11 +67248,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -67282,7 +67270,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -67318,15 +67306,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -67344,39 +67332,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"reasoning_text"`
-### Response 内容部分已添加事件
+### Response Content Part Added 事件
- `ResponseContentPartAddedEvent object { content_index, item_id, output_index, 3 more }`
- 当新增内容片段时发出。
+ 在新增内容部分时触发。
- `content_index: number`
- 被添加内容片段的索引。
+ 被新增内容部分的索引。
- `item_id: string`
- 内容片段被添加到的输出项的 ID。
+ 内容部分所添加到的输出项的 ID。
- `output_index: number`
- 内容片段被添加到的输出项的索引。
+ 内容部分所添加到的输出项的索引。
- `part: ResponseOutputText or ResponseOutputRefusal or object { text, type }`
- 被添加的内容片段。
+ 被新增的内容部分。
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -67384,11 +67372,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -67398,19 +67386,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -67420,7 +67408,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -67432,7 +67420,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -67440,11 +67428,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -67462,7 +67450,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -67498,15 +67486,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -67526,7 +67514,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.content_part.added"`
@@ -67534,39 +67522,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.content_part.added"`
-### 响应内容分块完成事件
+### 响应内容片段完成事件
- `ResponseContentPartDoneEvent object { content_index, item_id, output_index, 3 more }`
- 在内容片段完成时发出。
+ 当某个内容部分完成时触发。
- `content_index: number`
- 已完成的内容片段的索引。
+ 已完成的内容部分的索引。
- `item_id: string`
- 内容片段被添加到的输出项的 ID。
+ 内容部分所添加到的输出项的 ID。
- `output_index: number`
- 内容片段被添加到的输出项的索引。
+ 内容部分所添加到的输出项的索引。
- `part: ResponseOutputText or ResponseOutputRefusal or object { text, type }`
- 已完成的内容片段。
+ 已完成的内容部分。
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -67574,11 +67562,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -67588,19 +67576,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -67610,7 +67598,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -67622,7 +67610,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -67630,11 +67618,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -67652,7 +67640,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -67688,15 +67676,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -67716,7 +67704,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.content_part.done"`
@@ -67724,21 +67712,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.content_part.done"`
-### Response Conversation 参数
+### Response 对话参数
- `ResponseConversationParam object { id }`
- 本次响应所属的会话。
+ 此响应所属的对话。
- `id: string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
-### Response Created 事件
+### Response 创建事件
- `ResponseCreatedEvent object { response, sequence_number, type }`
- 在响应被创建时发出的事件。
+ 在创建响应时发出的事件。
- `response: Response`
@@ -67750,7 +67738,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -67806,11 +67794,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -67820,13 +67808,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -67836,57 +67824,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -67898,25 +67886,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -67926,13 +67914,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -67942,33 +67930,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -67981,9 +67969,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -67991,24 +67979,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -68018,8 +68006,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -68035,11 +68023,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -68047,15 +68035,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -68063,11 +68051,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -68077,19 +68065,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -68099,7 +68087,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -68111,7 +68099,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -68119,11 +68107,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -68141,7 +68129,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -68177,15 +68165,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -68197,8 +68185,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -68214,9 +68202,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -68224,7 +68212,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -68233,7 +68221,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -68252,20 +68240,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -68284,7 +68272,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -68301,7 +68289,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -68321,8 +68309,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -68338,15 +68326,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -68360,25 +68348,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -68386,7 +68374,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -68400,11 +68388,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -68423,7 +68411,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -68433,11 +68421,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -68465,7 +68453,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -68497,15 +68485,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -68533,24 +68521,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -68574,26 +68562,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -68601,17 +68589,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -68627,7 +68615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -68637,8 +68625,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -68646,12 +68634,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -68683,7 +68671,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -68697,7 +68685,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -68711,11 +68699,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -68727,7 +68715,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -68742,7 +68730,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -68784,8 +68772,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -68799,7 +68787,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -68807,61 +68795,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -68871,13 +68859,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -68891,23 +68879,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -68919,11 +68907,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -68951,15 +68939,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -68975,7 +68963,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -69013,11 +69001,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -69043,11 +69031,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -69055,7 +69043,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -69065,19 +69053,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -69086,9 +69074,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -69130,11 +69118,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -69148,7 +69136,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -69156,19 +69144,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -69176,25 +69164,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -69216,18 +69204,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -69235,22 +69223,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -69264,34 +69252,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -69309,36 +69297,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -69370,56 +69358,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -69427,26 +69415,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -69455,7 +69443,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -69465,7 +69453,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -69495,33 +69483,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -69537,7 +69525,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -69547,13 +69535,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -69563,11 +69551,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -69577,7 +69565,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -69585,22 +69573,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -69609,7 +69597,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -69624,7 +69612,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -69636,7 +69624,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -69647,7 +69635,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -69664,13 +69652,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -69714,13 +69702,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -69744,7 +69732,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -69760,7 +69748,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -69774,7 +69762,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -69782,13 +69770,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -69820,13 +69808,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -69836,7 +69824,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -69844,7 +69832,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -69858,7 +69846,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -69870,7 +69858,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -69880,7 +69868,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -69888,7 +69876,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -69910,7 +69898,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -69934,23 +69922,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -69958,7 +69946,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -69972,7 +69960,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -69984,17 +69972,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -70004,7 +69992,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -70016,11 +70004,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -70034,7 +70022,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -70044,37 +70032,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -70088,7 +70076,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -70122,21 +70110,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -70162,11 +70150,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -70174,7 +70162,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -70184,15 +70172,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -70200,7 +70188,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -70208,19 +70196,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -70228,25 +70216,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -70268,18 +70256,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -70287,22 +70275,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -70316,34 +70304,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -70361,36 +70349,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -70422,56 +70410,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -70479,26 +70467,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -70507,7 +70495,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -70517,7 +70505,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -70541,7 +70529,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -70557,7 +70545,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -70567,13 +70555,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -70583,11 +70571,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -70597,7 +70585,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -70605,22 +70593,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -70629,7 +70617,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -70644,7 +70632,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -70656,7 +70644,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -70667,7 +70655,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -70684,13 +70672,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -70738,7 +70726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -70746,7 +70734,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -70760,7 +70748,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -70780,7 +70768,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -70804,23 +70792,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -70828,7 +70816,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -70842,7 +70830,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -70854,17 +70842,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -70874,7 +70862,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -70886,11 +70874,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -70904,7 +70892,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -70914,37 +70902,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -70958,19 +70946,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -71013,20 +71001,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -71036,7 +71024,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -71044,13 +71032,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -71078,7 +71066,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -71092,7 +71080,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -71101,7 +71089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -71113,27 +71101,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -71147,7 +71135,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -71169,29 +71157,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -71205,7 +71193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -71215,7 +71203,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -71223,13 +71211,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -71243,11 +71231,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -71255,7 +71243,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -71263,13 +71251,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -71305,7 +71293,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -71315,7 +71303,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -71323,7 +71311,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -71331,45 +71319,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -71397,7 +71385,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -71411,11 +71399,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -71427,11 +71415,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -71445,7 +71433,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -71459,11 +71447,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -71473,7 +71461,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -71481,13 +71469,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -71519,11 +71507,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -71531,13 +71519,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -71565,11 +71553,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -71593,7 +71581,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -71601,21 +71589,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -71627,39 +71615,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -71671,11 +71659,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -71683,18 +71671,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -71730,7 +71718,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -71744,7 +71732,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -71765,11 +71753,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -71783,7 +71771,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -71823,7 +71811,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -71833,7 +71821,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -71857,7 +71845,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -71865,7 +71853,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -71879,11 +71867,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -71903,11 +71891,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -71919,15 +71907,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -71935,24 +71923,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -72167,7 +72155,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -72175,20 +72163,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -72197,7 +72185,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -72216,20 +72204,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -72248,7 +72236,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -72265,7 +72253,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -72307,8 +72295,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -72333,15 +72321,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -72349,8 +72337,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -72366,7 +72354,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -72394,20 +72382,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -72415,12 +72403,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -72452,7 +72440,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -72466,7 +72454,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -72480,11 +72468,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -72496,7 +72484,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -72511,7 +72499,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -72531,8 +72519,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -72548,12 +72536,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -72563,16 +72551,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -72584,13 +72572,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -72607,13 +72595,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -72654,20 +72642,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -72691,11 +72679,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -72707,15 +72695,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -72723,7 +72711,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -72751,7 +72739,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -72761,13 +72749,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -72789,7 +72777,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -72799,15 +72787,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -72833,11 +72821,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -72845,7 +72833,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -72855,15 +72843,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -72871,7 +72859,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -72879,19 +72867,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -72899,25 +72887,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -72939,18 +72927,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -72958,22 +72946,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -72987,34 +72975,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -73032,36 +73020,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -73093,56 +73081,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -73150,26 +73138,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -73178,7 +73166,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -73188,7 +73176,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -73212,7 +73200,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -73228,7 +73216,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -73238,13 +73226,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -73254,11 +73242,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -73268,7 +73256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -73276,22 +73264,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -73300,7 +73288,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -73315,7 +73303,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -73327,7 +73315,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -73338,7 +73326,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -73355,13 +73343,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -73409,7 +73397,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -73417,7 +73405,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -73431,7 +73419,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -73451,7 +73439,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -73475,23 +73463,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -73499,7 +73487,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -73513,7 +73501,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -73525,17 +73513,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -73545,7 +73533,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -73557,11 +73545,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -73575,7 +73563,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -73585,37 +73573,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -73629,23 +73617,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -73665,15 +73653,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -73699,11 +73687,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -73711,7 +73699,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -73721,15 +73709,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -73737,7 +73725,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -73745,19 +73733,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -73765,25 +73753,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -73805,18 +73793,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -73824,22 +73812,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -73853,34 +73841,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -73898,36 +73886,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -73959,56 +73947,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -74016,26 +74004,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -74044,7 +74032,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -74054,7 +74042,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -74078,7 +74066,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -74094,7 +74082,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -74104,13 +74092,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -74120,11 +74108,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -74134,7 +74122,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -74142,22 +74130,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -74166,7 +74154,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -74181,7 +74169,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -74193,7 +74181,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -74204,7 +74192,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -74221,13 +74209,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -74275,7 +74263,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -74283,7 +74271,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -74297,7 +74285,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -74317,7 +74305,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -74341,23 +74329,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -74365,7 +74353,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -74379,7 +74367,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -74391,17 +74379,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -74411,7 +74399,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -74423,11 +74411,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -74441,7 +74429,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -74451,37 +74439,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -74495,13 +74483,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -74509,17 +74497,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -74547,7 +74535,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -74561,7 +74549,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -74570,7 +74558,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -74582,27 +74570,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -74616,7 +74604,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -74638,29 +74626,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -74674,7 +74662,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -74684,7 +74672,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -74692,13 +74680,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -74708,25 +74696,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -74760,7 +74748,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -74770,7 +74758,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -74804,7 +74792,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -74816,25 +74804,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -74842,7 +74830,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -74856,11 +74844,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -74896,7 +74884,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -74904,11 +74892,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -74924,11 +74912,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -74938,7 +74926,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -74956,7 +74944,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -74966,7 +74954,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -74974,7 +74962,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -75004,19 +74992,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -75024,7 +75012,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -75050,7 +75038,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -75066,11 +75054,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -75078,18 +75066,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -75097,7 +75085,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -75111,7 +75099,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -75135,7 +75123,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -75143,21 +75131,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -75169,39 +75157,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -75217,7 +75205,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -75227,7 +75215,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -75251,7 +75239,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -75278,11 +75266,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -75290,8 +75278,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -75331,7 +75319,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -75339,20 +75327,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -75367,14 +75355,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -75444,7 +75432,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -75514,31 +75502,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -75564,11 +75552,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -75576,7 +75564,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -75586,15 +75574,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -75602,7 +75590,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -75610,19 +75598,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -75630,25 +75618,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -75670,18 +75658,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -75689,22 +75677,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -75718,34 +75706,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -75763,36 +75751,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -75824,56 +75812,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -75881,26 +75869,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -75909,7 +75897,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -75919,7 +75907,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -75943,7 +75931,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -75959,7 +75947,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -75969,13 +75957,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -75985,11 +75973,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -75999,7 +75987,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -76007,22 +75995,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -76031,7 +76019,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -76046,7 +76034,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -76058,7 +76046,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -76069,7 +76057,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -76086,13 +76074,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -76140,7 +76128,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -76148,7 +76136,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -76162,7 +76150,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -76182,7 +76170,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -76206,23 +76194,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -76230,7 +76218,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -76244,7 +76232,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -76256,17 +76244,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -76276,7 +76264,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -76288,11 +76276,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -76306,7 +76294,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -76316,37 +76304,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -76360,26 +76348,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -76387,19 +76375,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -76407,11 +76395,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -76419,25 +76407,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -76449,13 +76437,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -76463,11 +76451,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -76475,25 +76463,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -76505,26 +76493,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -76532,19 +76520,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -76556,11 +76544,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -76578,18 +76566,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -76597,19 +76585,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -76620,13 +76606,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -76644,11 +76630,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -76658,17 +76644,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -76676,11 +76662,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -76690,21 +76676,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -76722,8 +76708,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -76739,31 +76725,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -76773,13 +76759,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -76795,22 +76781,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -76820,9 +76806,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -76833,10 +76819,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -76844,8 +76830,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -76854,8 +76840,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -76863,7 +76849,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -76872,7 +76858,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -76880,25 +76866,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
@@ -76914,7 +76900,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCustomToolCallInputDeltaEvent object { delta, item_id, output_index, 2 more }`
- 表示对自定义工具调用的输入的增量(部分更新)的事件。
+ 表示自定义工具调用的输入增量(部分更新)的事件。
- `delta: string`
@@ -76922,15 +76908,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 与此事件关联的 API 条目的唯一标识符。
+ 与此事件关联的 API 项的唯一标识符。
- `output_index: number`
- 此增量所应用的输出的索引。
+ 此增量所应用的输出索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.custom_tool_call_input.delta"`
@@ -76950,7 +76936,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 与此事件关联的 API 条目的唯一标识符。
+ 与此事件关联的 API 项的唯一标识符。
- `output_index: number`
@@ -76958,7 +76944,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.custom_tool_call_input.done"`
@@ -77024,7 +77010,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseErrorEvent object { code, message, param, 2 more }`
- 在发生错误时发出。
+ 发生错误时触发。
- `code: string or null`
@@ -77040,7 +77026,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "error"`
@@ -77048,15 +77034,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"error"`
-### 响应失败事件
+### Response 失败事件
- `ResponseFailedEvent object { response, sequence_number, type }`
- 在响应失败时发出的事件。
+ 当 response 失败时发出的事件。
- `response: Response`
- 失败的响应。
+ 失败的 response。
- `id: string`
@@ -77064,7 +77050,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -77120,11 +77106,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -77134,13 +77120,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -77150,57 +77136,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -77212,25 +77198,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -77240,13 +77226,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -77256,33 +77242,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -77295,9 +77281,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -77305,24 +77291,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -77332,8 +77318,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -77349,11 +77335,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -77361,15 +77347,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -77377,11 +77363,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -77391,19 +77377,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -77413,7 +77399,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -77425,7 +77411,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -77433,11 +77419,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -77455,7 +77441,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -77491,15 +77477,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -77511,8 +77497,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -77528,9 +77514,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -77538,7 +77524,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -77547,7 +77533,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -77566,20 +77552,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -77598,7 +77584,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -77615,7 +77601,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -77635,8 +77621,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -77652,15 +77638,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -77674,25 +77660,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -77700,7 +77686,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -77714,11 +77700,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -77737,7 +77723,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -77747,11 +77733,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -77779,7 +77765,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -77811,15 +77797,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -77847,24 +77833,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -77888,26 +77874,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -77915,17 +77901,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -77941,7 +77927,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -77951,8 +77937,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -77960,12 +77946,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -77997,7 +77983,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -78011,7 +77997,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -78025,11 +78011,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -78041,7 +78027,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -78056,7 +78042,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -78098,8 +78084,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -78113,7 +78099,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -78121,61 +78107,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -78185,13 +78171,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -78205,23 +78191,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -78233,11 +78219,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -78265,15 +78251,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -78289,7 +78275,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -78327,11 +78313,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -78357,11 +78343,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -78369,7 +78355,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -78379,19 +78365,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -78400,9 +78386,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -78444,11 +78430,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -78462,7 +78448,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -78470,19 +78456,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -78490,25 +78476,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -78530,18 +78516,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -78549,22 +78535,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -78578,34 +78564,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -78623,36 +78609,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -78684,56 +78670,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -78741,26 +78727,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -78769,7 +78755,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -78779,7 +78765,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -78809,33 +78795,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -78851,7 +78837,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -78861,13 +78847,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -78877,11 +78863,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -78891,7 +78877,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -78899,22 +78885,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -78923,7 +78909,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -78938,7 +78924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -78950,7 +78936,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -78961,7 +78947,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -78978,13 +78964,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -79028,13 +79014,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -79058,7 +79044,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -79074,7 +79060,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -79088,7 +79074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -79096,13 +79082,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -79134,13 +79120,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -79150,7 +79136,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -79158,7 +79144,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -79172,7 +79158,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -79184,7 +79170,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -79194,7 +79180,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -79202,7 +79188,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -79224,7 +79210,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -79248,23 +79234,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -79272,7 +79258,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -79286,7 +79272,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -79298,17 +79284,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -79318,7 +79304,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -79330,11 +79316,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -79348,7 +79334,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -79358,37 +79344,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -79402,7 +79388,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -79436,21 +79422,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -79476,11 +79462,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -79488,7 +79474,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -79498,15 +79484,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -79514,7 +79500,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -79522,19 +79508,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -79542,25 +79528,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -79582,18 +79568,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -79601,22 +79587,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -79630,34 +79616,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -79675,36 +79661,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -79736,56 +79722,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -79793,26 +79779,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -79821,7 +79807,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -79831,7 +79817,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -79855,7 +79841,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -79871,7 +79857,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -79881,13 +79867,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -79897,11 +79883,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -79911,7 +79897,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -79919,22 +79905,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -79943,7 +79929,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -79958,7 +79944,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -79970,7 +79956,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -79981,7 +79967,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -79998,13 +79984,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -80052,7 +80038,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -80060,7 +80046,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -80074,7 +80060,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -80094,7 +80080,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -80118,23 +80104,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -80142,7 +80128,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -80156,7 +80142,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -80168,17 +80154,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -80188,7 +80174,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -80200,11 +80186,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -80218,7 +80204,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -80228,37 +80214,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -80272,19 +80258,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -80327,20 +80313,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -80350,7 +80336,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -80358,13 +80344,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -80392,7 +80378,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -80406,7 +80392,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -80415,7 +80401,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -80427,27 +80413,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -80461,7 +80447,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -80483,29 +80469,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -80519,7 +80505,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -80529,7 +80515,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -80537,13 +80523,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -80557,11 +80543,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -80569,7 +80555,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -80577,13 +80563,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -80619,7 +80605,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -80629,7 +80615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -80637,7 +80623,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -80645,45 +80631,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -80711,7 +80697,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -80725,11 +80711,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -80741,11 +80727,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -80759,7 +80745,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -80773,11 +80759,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -80787,7 +80773,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -80795,13 +80781,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -80833,11 +80819,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -80845,13 +80831,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -80879,11 +80865,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -80907,7 +80893,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -80915,21 +80901,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -80941,39 +80927,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -80985,11 +80971,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -80997,18 +80983,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -81044,7 +81030,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -81058,7 +81044,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -81079,11 +81065,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -81097,7 +81083,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -81137,7 +81123,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -81147,7 +81133,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -81171,7 +81157,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -81179,7 +81165,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -81193,11 +81179,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -81217,11 +81203,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -81233,15 +81219,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -81249,24 +81235,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -81481,7 +81467,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -81489,20 +81475,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -81511,7 +81497,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -81530,20 +81516,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -81562,7 +81548,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -81579,7 +81565,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -81621,8 +81607,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -81647,15 +81633,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -81663,8 +81649,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -81680,7 +81666,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -81708,20 +81694,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -81729,12 +81715,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -81766,7 +81752,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -81780,7 +81766,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -81794,11 +81780,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -81810,7 +81796,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -81825,7 +81811,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -81845,8 +81831,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -81862,12 +81848,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -81877,16 +81863,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -81898,13 +81884,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -81921,13 +81907,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -81968,20 +81954,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -82005,11 +81991,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -82021,15 +82007,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -82037,7 +82023,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -82065,7 +82051,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -82075,13 +82061,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -82103,7 +82089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -82113,15 +82099,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -82147,11 +82133,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -82159,7 +82145,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -82169,15 +82155,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -82185,7 +82171,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -82193,19 +82179,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -82213,25 +82199,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -82253,18 +82239,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -82272,22 +82258,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -82301,34 +82287,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -82346,36 +82332,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -82407,56 +82393,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -82464,26 +82450,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -82492,7 +82478,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -82502,7 +82488,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -82526,7 +82512,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -82542,7 +82528,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -82552,13 +82538,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -82568,11 +82554,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -82582,7 +82568,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -82590,22 +82576,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -82614,7 +82600,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -82629,7 +82615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -82641,7 +82627,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -82652,7 +82638,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -82669,13 +82655,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -82723,7 +82709,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -82731,7 +82717,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -82745,7 +82731,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -82765,7 +82751,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -82789,23 +82775,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -82813,7 +82799,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -82827,7 +82813,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -82839,17 +82825,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -82859,7 +82845,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -82871,11 +82857,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -82889,7 +82875,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -82899,37 +82885,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -82943,23 +82929,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -82979,15 +82965,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -83013,11 +82999,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -83025,7 +83011,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -83035,15 +83021,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -83051,7 +83037,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -83059,19 +83045,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -83079,25 +83065,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -83119,18 +83105,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -83138,22 +83124,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -83167,34 +83153,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -83212,36 +83198,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -83273,56 +83259,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -83330,26 +83316,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -83358,7 +83344,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -83368,7 +83354,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -83392,7 +83378,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -83408,7 +83394,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -83418,13 +83404,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -83434,11 +83420,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -83448,7 +83434,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -83456,22 +83442,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -83480,7 +83466,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -83495,7 +83481,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -83507,7 +83493,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -83518,7 +83504,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -83535,13 +83521,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -83589,7 +83575,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -83597,7 +83583,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -83611,7 +83597,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -83631,7 +83617,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -83655,23 +83641,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -83679,7 +83665,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -83693,7 +83679,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -83705,17 +83691,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -83725,7 +83711,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -83737,11 +83723,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -83755,7 +83741,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -83765,37 +83751,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -83809,13 +83795,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -83823,17 +83809,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -83861,7 +83847,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -83875,7 +83861,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -83884,7 +83870,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -83896,27 +83882,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -83930,7 +83916,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -83952,29 +83938,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -83988,7 +83974,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -83998,7 +83984,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -84006,13 +83992,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -84022,25 +84008,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -84074,7 +84060,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -84084,7 +84070,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -84118,7 +84104,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -84130,25 +84116,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -84156,7 +84142,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -84170,11 +84156,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -84210,7 +84196,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -84218,11 +84204,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -84238,11 +84224,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -84252,7 +84238,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -84270,7 +84256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -84280,7 +84266,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -84288,7 +84274,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -84318,19 +84304,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -84338,7 +84324,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -84364,7 +84350,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -84380,11 +84366,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -84392,18 +84378,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -84411,7 +84397,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -84425,7 +84411,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -84449,7 +84435,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -84457,21 +84443,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -84483,39 +84469,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -84531,7 +84517,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -84541,7 +84527,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -84565,7 +84551,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -84592,11 +84578,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -84604,8 +84590,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -84645,7 +84631,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -84653,20 +84639,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -84681,14 +84667,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -84758,7 +84744,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -84828,31 +84814,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -84878,11 +84864,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -84890,7 +84876,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -84900,15 +84886,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -84916,7 +84902,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -84924,19 +84910,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -84944,25 +84930,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -84984,18 +84970,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -85003,22 +84989,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -85032,34 +85018,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -85077,36 +85063,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -85138,56 +85124,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -85195,26 +85181,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -85223,7 +85209,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -85233,7 +85219,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -85257,7 +85243,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -85273,7 +85259,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -85283,13 +85269,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -85299,11 +85285,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -85313,7 +85299,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -85321,22 +85307,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -85345,7 +85331,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -85360,7 +85346,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -85372,7 +85358,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -85383,7 +85369,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -85400,13 +85386,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -85454,7 +85440,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -85462,7 +85448,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -85476,7 +85462,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -85496,7 +85482,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -85520,23 +85506,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -85544,7 +85530,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -85558,7 +85544,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -85570,17 +85556,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -85590,7 +85576,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -85602,11 +85588,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -85620,7 +85606,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -85630,37 +85616,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -85674,26 +85660,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -85701,19 +85687,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -85721,11 +85707,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -85733,25 +85719,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -85763,13 +85749,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -85777,11 +85763,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -85789,25 +85775,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -85819,26 +85805,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -85846,19 +85832,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -85870,11 +85856,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -85892,18 +85878,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -85911,19 +85897,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -85934,13 +85918,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -85958,11 +85942,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -85972,17 +85956,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -85990,11 +85974,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -86004,21 +85988,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -86036,8 +86020,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -86053,31 +86037,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -86087,13 +86071,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -86109,22 +86093,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -86134,9 +86118,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -86147,10 +86131,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -86158,8 +86142,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -86168,8 +86152,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -86177,7 +86161,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -86186,7 +86170,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -86194,29 +86178,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.failed"`
@@ -86224,11 +86208,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.failed"`
-### Response 文件搜索调用完成事件
+### Response File Search Call Completed Event
- `ResponseFileSearchCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在文件搜索调用完成时发出(已找到结果)。
+ 在文件搜索调用完成(找到结果)时发出。
- `item_id: string`
@@ -86240,7 +86224,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.file_search_call.completed"`
@@ -86248,7 +86232,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.file_search_call.completed"`
-### Response File Search Call In Progress Event
+### 响应中的文件搜索调用进行中事件
- `ResponseFileSearchCallInProgressEvent object { item_id, output_index, sequence_number, type }`
@@ -86264,7 +86248,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.file_search_call.in_progress"`
@@ -86272,11 +86256,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.file_search_call.in_progress"`
-### Response 文件搜索调用 搜索事件
+### Response File Search Call Searching Event
- `ResponseFileSearchCallSearchingEvent object { item_id, output_index, sequence_number, type }`
- 在文件搜索正在执行搜索时发出。
+ 在文件搜索正在执行检索时发出。
- `item_id: string`
@@ -86288,7 +86272,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.file_search_call.searching"`
@@ -86300,23 +86284,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextConfig = ResponseFormatText or ResponseFormatTextJSONSchemaConfig or ResponseFormatJSONObject`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -86326,13 +86310,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -86348,22 +86332,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -86375,13 +86359,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -86397,37 +86381,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
### Response Function Call Arguments Delta Event
- `ResponseFunctionCallArgumentsDeltaEvent object { delta, item_id, output_index, 2 more }`
- 在出现部分函数调用参数的增量时触发。
+ 当存在部分函数调用参数的增量时发出。
- `delta: string`
- 新增的函数调用参数增量。
+ 添加的函数调用参数增量。
- `item_id: string`
- 函数调用参数增量所添加到的输出项的 ID。
+ 添加函数调用参数增量的输出项的 ID。
- `output_index: number`
- 函数调用参数增量所添加到的输出项的索引。
+ 添加函数调用参数增量的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.function_call_arguments.delta"`
@@ -86435,23 +86419,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.function_call_arguments.delta"`
-### Response 函数调用参数完成事件
+### Response Function Call Arguments Done Event
- `ResponseFunctionCallArgumentsDoneEvent object { arguments, item_id, name, 3 more }`
- 在函数调用参数最终确定时发出。
+ 在函数调用参数被最终确定时发出。
- `arguments: string`
- 函数调用的参数。
+ 函数调用参数。
- `item_id: string`
- 项目的 ID。
+ 该项的 ID。
- `name: string`
- 被调用的函数名称。
+ 被调用的函数的名称。
- `output_index: number`
@@ -86459,17 +86443,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.function_call_arguments.done"`
- `"response.function_call_arguments.done"`
-### Response Function Shell Call Output Content
+### Response Function Shell Call 输出内容
- `ResponseFunctionShellCallOutputContent object { outcome, stderr, stdout }`
- 捕获了 shell 工具调用输出中一部分的标准输出和标准错误。
+ 捕获 shell 工具调用输出中部分的 stdout 和 stderr。
- `outcome: object { type } or object { exit_code, type }`
@@ -86477,41 +86461,41 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
-### 响应图像生成调用完成事件
+### Response Image Gen Call Completed 事件
- `ResponseImageGenCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在图像生成工具调用已完成且最终图像可用时发出。
+ 当一个图像生成工具调用已完成且最终图像可用时发出。
- `item_id: string`
@@ -86523,7 +86507,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.image_generation_call.completed"`
@@ -86531,11 +86515,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.image_generation_call.completed"`
-### Response Image Gen Call Generating Event
+### Response 图像生成调用正在生成事件
- `ResponseImageGenCallGeneratingEvent object { item_id, output_index, sequence_number, type }`
- 当图像生成工具调用正在主动生成图像时发出(中间状态)。
+ 当图像生成工具调用正在主动生成图像时触发(中间状态)。
- `item_id: string`
@@ -86555,11 +86539,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.image_generation_call.generating"`
-### Response Image Gen Call In Progress Event
+### 响应图像生成调用进行中事件
- `ResponseImageGenCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 在图像生成工具调用进行中时发出。
+ 当图像生成工具调用进行中时发出。
- `item_id: string`
@@ -86583,7 +86567,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 7 more }`
- 在图像生成流式传输过程中,当有部分图像可用时发出。
+ 在图像生成流式传输过程中,当有部分图像可用时触发。
- `item_id: string`
@@ -86595,11 +86579,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_image_b64: string`
- Base64 编码的部分图像数据,适合直接渲染为图像。
+ Base64 编码的部分图像数据,可用于渲染为图像。
- `partial_image_index: number`
- 部分图像的基于 0 的索引(后端使用基于 1 的索引,但此处为面向用户的基于 0 的索引)。
+ 部分图像的从 0 开始的索引(后端使用从 1 开始的索引,但此处为面向用户的从 0 开始)。
- `sequence_number: number`
@@ -86627,7 +86611,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
所使用的图像尺寸。
-### 进行中的响应事件
+### 进行中响应事件
- `ResponseInProgressEvent object { response, sequence_number, type }`
@@ -86643,7 +86627,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -86699,11 +86683,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -86713,13 +86697,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -86729,57 +86713,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -86791,25 +86775,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -86819,13 +86803,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -86835,33 +86819,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -86874,9 +86858,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -86884,24 +86868,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -86911,8 +86895,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -86928,11 +86912,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -86940,15 +86924,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -86956,11 +86940,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -86970,19 +86954,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -86992,7 +86976,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -87004,7 +86988,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -87012,11 +86996,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -87034,7 +87018,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -87070,15 +87054,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -87090,8 +87074,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -87107,9 +87091,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -87117,7 +87101,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -87126,7 +87110,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -87145,20 +87129,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -87177,7 +87161,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -87194,7 +87178,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -87214,8 +87198,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -87231,15 +87215,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -87253,25 +87237,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -87279,7 +87263,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -87293,11 +87277,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -87316,7 +87300,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -87326,11 +87310,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -87358,7 +87342,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -87390,15 +87374,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -87426,24 +87410,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -87467,26 +87451,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -87494,17 +87478,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -87520,7 +87504,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -87530,8 +87514,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -87539,12 +87523,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -87576,7 +87560,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -87590,7 +87574,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -87604,11 +87588,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -87620,7 +87604,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -87635,7 +87619,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -87677,8 +87661,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -87692,7 +87676,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -87700,61 +87684,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -87764,13 +87748,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -87784,23 +87768,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -87812,11 +87796,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -87844,15 +87828,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -87868,7 +87852,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -87906,11 +87890,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -87936,11 +87920,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -87948,7 +87932,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -87958,19 +87942,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -87979,9 +87963,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -88023,11 +88007,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -88041,7 +88025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -88049,19 +88033,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -88069,25 +88053,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -88109,18 +88093,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -88128,22 +88112,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -88157,34 +88141,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -88202,36 +88186,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -88263,56 +88247,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -88320,26 +88304,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -88348,7 +88332,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -88358,7 +88342,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -88388,33 +88372,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -88430,7 +88414,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -88440,13 +88424,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -88456,11 +88440,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -88470,7 +88454,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -88478,22 +88462,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -88502,7 +88486,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -88517,7 +88501,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -88529,7 +88513,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -88540,7 +88524,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -88557,13 +88541,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -88607,13 +88591,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -88637,7 +88621,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -88653,7 +88637,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -88667,7 +88651,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -88675,13 +88659,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -88713,13 +88697,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -88729,7 +88713,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -88737,7 +88721,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -88751,7 +88735,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -88763,7 +88747,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -88773,7 +88757,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -88781,7 +88765,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -88803,7 +88787,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -88827,23 +88811,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -88851,7 +88835,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -88865,7 +88849,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -88877,17 +88861,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -88897,7 +88881,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -88909,11 +88893,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -88927,7 +88911,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -88937,37 +88921,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -88981,7 +88965,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -89015,21 +88999,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -89055,11 +89039,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -89067,7 +89051,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -89077,15 +89061,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -89093,7 +89077,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -89101,19 +89085,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -89121,25 +89105,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -89161,18 +89145,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -89180,22 +89164,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -89209,34 +89193,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -89254,36 +89238,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -89315,56 +89299,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -89372,26 +89356,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -89400,7 +89384,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -89410,7 +89394,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -89434,7 +89418,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -89450,7 +89434,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -89460,13 +89444,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -89476,11 +89460,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -89490,7 +89474,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -89498,22 +89482,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -89522,7 +89506,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -89537,7 +89521,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -89549,7 +89533,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -89560,7 +89544,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -89577,13 +89561,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -89631,7 +89615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -89639,7 +89623,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -89653,7 +89637,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -89673,7 +89657,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -89697,23 +89681,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -89721,7 +89705,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -89735,7 +89719,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -89747,17 +89731,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -89767,7 +89751,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -89779,11 +89763,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -89797,7 +89781,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -89807,37 +89791,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -89851,19 +89835,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -89906,20 +89890,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -89929,7 +89913,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -89937,13 +89921,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -89971,7 +89955,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -89985,7 +89969,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -89994,7 +89978,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -90006,27 +89990,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -90040,7 +90024,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -90062,29 +90046,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -90098,7 +90082,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -90108,7 +90092,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -90116,13 +90100,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -90136,11 +90120,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -90148,7 +90132,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -90156,13 +90140,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -90198,7 +90182,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -90208,7 +90192,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -90216,7 +90200,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -90224,45 +90208,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -90290,7 +90274,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -90304,11 +90288,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -90320,11 +90304,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -90338,7 +90322,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -90352,11 +90336,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -90366,7 +90350,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -90374,13 +90358,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -90412,11 +90396,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -90424,13 +90408,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -90458,11 +90442,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -90486,7 +90470,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -90494,21 +90478,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -90520,39 +90504,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -90564,11 +90548,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -90576,18 +90560,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -90623,7 +90607,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -90637,7 +90621,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -90658,11 +90642,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -90676,7 +90660,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -90716,7 +90700,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -90726,7 +90710,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -90750,7 +90734,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -90758,7 +90742,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -90772,11 +90756,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -90796,11 +90780,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -90812,15 +90796,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -90828,24 +90812,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -91060,7 +91044,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -91068,20 +91052,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -91090,7 +91074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -91109,20 +91093,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -91141,7 +91125,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -91158,7 +91142,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -91200,8 +91184,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -91226,15 +91210,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -91242,8 +91226,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -91259,7 +91243,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -91287,20 +91271,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -91308,12 +91292,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -91345,7 +91329,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -91359,7 +91343,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -91373,11 +91357,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -91389,7 +91373,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -91404,7 +91388,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -91424,8 +91408,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -91441,12 +91425,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -91456,16 +91440,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -91477,13 +91461,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -91500,13 +91484,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -91547,20 +91531,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -91584,11 +91568,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -91600,15 +91584,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -91616,7 +91600,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -91644,7 +91628,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -91654,13 +91638,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -91682,7 +91666,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -91692,15 +91676,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -91726,11 +91710,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -91738,7 +91722,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -91748,15 +91732,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -91764,7 +91748,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -91772,19 +91756,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -91792,25 +91776,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -91832,18 +91816,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -91851,22 +91835,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -91880,34 +91864,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -91925,36 +91909,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -91986,56 +91970,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -92043,26 +92027,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -92071,7 +92055,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -92081,7 +92065,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -92105,7 +92089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -92121,7 +92105,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -92131,13 +92115,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -92147,11 +92131,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -92161,7 +92145,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -92169,22 +92153,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -92193,7 +92177,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -92208,7 +92192,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -92220,7 +92204,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -92231,7 +92215,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -92248,13 +92232,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -92302,7 +92286,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -92310,7 +92294,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -92324,7 +92308,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -92344,7 +92328,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -92368,23 +92352,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -92392,7 +92376,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -92406,7 +92390,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -92418,17 +92402,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -92438,7 +92422,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -92450,11 +92434,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -92468,7 +92452,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -92478,37 +92462,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -92522,23 +92506,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -92558,15 +92542,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -92592,11 +92576,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -92604,7 +92588,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -92614,15 +92598,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -92630,7 +92614,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -92638,19 +92622,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -92658,25 +92642,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -92698,18 +92682,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -92717,22 +92701,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -92746,34 +92730,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -92791,36 +92775,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -92852,56 +92836,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -92909,26 +92893,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -92937,7 +92921,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -92947,7 +92931,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -92971,7 +92955,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -92987,7 +92971,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -92997,13 +92981,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -93013,11 +92997,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -93027,7 +93011,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -93035,22 +93019,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -93059,7 +93043,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -93074,7 +93058,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -93086,7 +93070,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -93097,7 +93081,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -93114,13 +93098,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -93168,7 +93152,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -93176,7 +93160,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -93190,7 +93174,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -93210,7 +93194,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -93234,23 +93218,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -93258,7 +93242,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -93272,7 +93256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -93284,17 +93268,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -93304,7 +93288,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -93316,11 +93300,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -93334,7 +93318,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -93344,37 +93328,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -93388,13 +93372,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -93402,17 +93386,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -93440,7 +93424,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -93454,7 +93438,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -93463,7 +93447,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -93475,27 +93459,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -93509,7 +93493,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -93531,29 +93515,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -93567,7 +93551,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -93577,7 +93561,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -93585,13 +93569,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -93601,25 +93585,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -93653,7 +93637,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -93663,7 +93647,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -93697,7 +93681,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -93709,25 +93693,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -93735,7 +93719,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -93749,11 +93733,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -93789,7 +93773,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -93797,11 +93781,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -93817,11 +93801,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -93831,7 +93815,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -93849,7 +93833,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -93859,7 +93843,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -93867,7 +93851,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -93897,19 +93881,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -93917,7 +93901,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -93943,7 +93927,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -93959,11 +93943,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -93971,18 +93955,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -93990,7 +93974,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -94004,7 +93988,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -94028,7 +94012,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -94036,21 +94020,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -94062,39 +94046,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -94110,7 +94094,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -94120,7 +94104,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -94144,7 +94128,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -94171,11 +94155,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -94183,8 +94167,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -94224,7 +94208,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -94232,20 +94216,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -94260,14 +94244,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -94337,7 +94321,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -94407,31 +94391,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -94457,11 +94441,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -94469,7 +94453,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -94479,15 +94463,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -94495,7 +94479,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -94503,19 +94487,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -94523,25 +94507,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -94563,18 +94547,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -94582,22 +94566,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -94611,34 +94595,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -94656,36 +94640,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -94717,56 +94701,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -94774,26 +94758,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -94802,7 +94786,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -94812,7 +94796,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -94836,7 +94820,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -94852,7 +94836,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -94862,13 +94846,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -94878,11 +94862,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -94892,7 +94876,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -94900,22 +94884,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -94924,7 +94908,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -94939,7 +94923,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -94951,7 +94935,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -94962,7 +94946,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -94979,13 +94963,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -95033,7 +95017,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -95041,7 +95025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -95055,7 +95039,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -95075,7 +95059,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -95099,23 +95083,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -95123,7 +95107,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -95137,7 +95121,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -95149,17 +95133,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -95169,7 +95153,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -95181,11 +95165,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -95199,7 +95183,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -95209,37 +95193,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -95253,26 +95237,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -95280,19 +95264,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -95300,11 +95284,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -95312,25 +95296,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -95342,13 +95326,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -95356,11 +95340,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -95368,25 +95352,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -95398,26 +95382,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -95425,19 +95409,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -95449,11 +95433,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -95471,18 +95455,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -95490,19 +95474,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -95513,13 +95495,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -95537,11 +95519,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -95551,17 +95533,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -95569,11 +95551,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -95583,21 +95565,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -95615,8 +95597,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -95632,31 +95614,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -95666,13 +95648,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -95688,22 +95670,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -95713,9 +95695,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -95726,10 +95708,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -95737,8 +95719,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -95747,8 +95729,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -95756,7 +95738,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -95765,7 +95747,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -95773,29 +95755,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.in_progress"`
@@ -95809,14 +95791,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
指定要在模型响应中包含的其他输出数据。目前支持的值包括:
- - `web_search_call.results`:包含 网页搜索 工具调用的搜索结果。
- - `web_search_call.action.sources`: 包含 网页搜索 工具调用的来源。
- - `code_interpreter_call.outputs`: 在代码解释器工具调用条目中包含 Python 代码执行的输出。
- - `computer_call_output.output.image_url`: 包含来自 computer call 输出的图片 URL。
- - `file_search_call.results`: 包含 文件搜索 工具调用的搜索结果。
- - `message.input_image.image_url`: 包含来自输入消息的图片 URL。
- - `message.output_text.logprobs`: 在助手消息中包含 logprobs。
- - `reasoning.encrypted_content`: 在推理条目输出中包含加密版本的推理 token。这使得在无状态地使用 Responses API 时(例如当 `store` 参数被设置为 `false`,时,或当组织已加入零数据保留计划时),推理条目可以用于多轮对话。
+ - `web_search_call.results`: 包含 网页搜索 工具调用的搜索结果。
+ - `web_search_call.action.sources`:包含 网页搜索 工具调用的来源。
+ - `code_interpreter_call.outputs`:在代码解释器工具调用条目中包含 Python 代码执行的输出。
+ - `computer_call_output.output.image_url`:包含来自计算机调用输出的图片 URL。
+ - `file_search_call.results`:包含 文件搜索 工具调用的搜索结果。
+ - `message.input_image.image_url`:包含来自输入消息的图片 URL。
+ - `message.output_text.logprobs`:在助手消息中包含 logprobs。
+ - `reasoning.encrypted_content`:在推理条目的输出中包含加密版本的推理 token。这使得在使用 Responses API 以无状态方式处理多轮对话时能够使用推理条目(例如 `store` 参数设置为 `false`,时,或组织已加入零数据留存计划时)。
- `"file_search_call.results"`
@@ -95834,15 +95816,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"message.output_text.logprobs"`
-### Response Incomplete 事件
+### Response Incomplete Event
- `ResponseIncompleteEvent object { response, sequence_number, type }`
- 当响应以未完成状态结束时发出的事件。
+ 当响应以不完整状态结束时发出的事件。
- `response: Response`
- 未完成的响应。
+ 不完整的响应。
- `id: string`
@@ -95850,7 +95832,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -95906,11 +95888,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -95920,13 +95902,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -95936,57 +95918,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -95998,25 +95980,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -96026,13 +96008,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -96042,33 +96024,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -96081,9 +96063,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -96091,24 +96073,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -96118,8 +96100,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -96135,11 +96117,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -96147,15 +96129,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -96163,11 +96145,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -96177,19 +96159,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -96199,7 +96181,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -96211,7 +96193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -96219,11 +96201,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -96241,7 +96223,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -96277,15 +96259,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -96297,8 +96279,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -96314,9 +96296,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -96324,7 +96306,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -96333,7 +96315,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -96352,20 +96334,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -96384,7 +96366,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -96401,7 +96383,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -96421,8 +96403,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -96438,15 +96420,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -96460,25 +96442,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -96486,7 +96468,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -96500,11 +96482,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -96523,7 +96505,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -96533,11 +96515,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -96565,7 +96547,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -96597,15 +96579,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -96633,24 +96615,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -96674,26 +96656,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -96701,17 +96683,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -96727,7 +96709,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -96737,8 +96719,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -96746,12 +96728,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -96783,7 +96765,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -96797,7 +96779,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -96811,11 +96793,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -96827,7 +96809,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -96842,7 +96824,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -96884,8 +96866,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -96899,7 +96881,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -96907,61 +96889,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -96971,13 +96953,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -96991,23 +96973,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -97019,11 +97001,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -97051,15 +97033,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -97075,7 +97057,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -97113,11 +97095,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -97143,11 +97125,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -97155,7 +97137,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -97165,19 +97147,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -97186,9 +97168,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -97230,11 +97212,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -97248,7 +97230,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -97256,19 +97238,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -97276,25 +97258,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -97316,18 +97298,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -97335,22 +97317,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -97364,34 +97346,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -97409,36 +97391,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -97470,56 +97452,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -97527,26 +97509,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -97555,7 +97537,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -97565,7 +97547,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -97595,33 +97577,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -97637,7 +97619,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -97647,13 +97629,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -97663,11 +97645,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -97677,7 +97659,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -97685,22 +97667,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -97709,7 +97691,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -97724,7 +97706,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -97736,7 +97718,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -97747,7 +97729,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -97764,13 +97746,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -97814,13 +97796,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -97844,7 +97826,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -97860,7 +97842,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -97874,7 +97856,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -97882,13 +97864,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -97920,13 +97902,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -97936,7 +97918,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -97944,7 +97926,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -97958,7 +97940,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -97970,7 +97952,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -97980,7 +97962,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -97988,7 +97970,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -98010,7 +97992,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -98034,23 +98016,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -98058,7 +98040,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -98072,7 +98054,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -98084,17 +98066,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -98104,7 +98086,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -98116,11 +98098,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -98134,7 +98116,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -98144,37 +98126,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -98188,7 +98170,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -98222,21 +98204,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -98262,11 +98244,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -98274,7 +98256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -98284,15 +98266,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -98300,7 +98282,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -98308,19 +98290,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -98328,25 +98310,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -98368,18 +98350,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -98387,22 +98369,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -98416,34 +98398,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -98461,36 +98443,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -98522,56 +98504,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -98579,26 +98561,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -98607,7 +98589,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -98617,7 +98599,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -98641,7 +98623,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -98657,7 +98639,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -98667,13 +98649,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -98683,11 +98665,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -98697,7 +98679,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -98705,22 +98687,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -98729,7 +98711,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -98744,7 +98726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -98756,7 +98738,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -98767,7 +98749,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -98784,13 +98766,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -98838,7 +98820,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -98846,7 +98828,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -98860,7 +98842,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -98880,7 +98862,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -98904,23 +98886,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -98928,7 +98910,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -98942,7 +98924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -98954,17 +98936,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -98974,7 +98956,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -98986,11 +98968,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -99004,7 +98986,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -99014,37 +98996,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -99058,19 +99040,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -99113,20 +99095,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -99136,7 +99118,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -99144,13 +99126,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -99178,7 +99160,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -99192,7 +99174,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -99201,7 +99183,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -99213,27 +99195,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -99247,7 +99229,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -99269,29 +99251,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -99305,7 +99287,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -99315,7 +99297,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -99323,13 +99305,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -99343,11 +99325,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -99355,7 +99337,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -99363,13 +99345,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -99405,7 +99387,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -99415,7 +99397,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -99423,7 +99405,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -99431,45 +99413,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -99497,7 +99479,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -99511,11 +99493,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -99527,11 +99509,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -99545,7 +99527,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -99559,11 +99541,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -99573,7 +99555,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -99581,13 +99563,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -99619,11 +99601,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -99631,13 +99613,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -99665,11 +99647,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -99693,7 +99675,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -99701,21 +99683,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -99727,39 +99709,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -99771,11 +99753,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -99783,18 +99765,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -99830,7 +99812,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -99844,7 +99826,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -99865,11 +99847,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -99883,7 +99865,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -99923,7 +99905,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -99933,7 +99915,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -99957,7 +99939,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -99965,7 +99947,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -99979,11 +99961,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -100003,11 +99985,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -100019,15 +100001,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -100035,24 +100017,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -100267,7 +100249,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -100275,20 +100257,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -100297,7 +100279,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -100316,20 +100298,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -100348,7 +100330,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -100365,7 +100347,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -100407,8 +100389,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -100433,15 +100415,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -100449,8 +100431,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -100466,7 +100448,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -100494,20 +100476,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -100515,12 +100497,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -100552,7 +100534,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -100566,7 +100548,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -100580,11 +100562,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -100596,7 +100578,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -100611,7 +100593,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -100631,8 +100613,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -100648,12 +100630,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -100663,16 +100645,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -100684,13 +100666,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -100707,13 +100689,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -100754,20 +100736,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -100791,11 +100773,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -100807,15 +100789,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -100823,7 +100805,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -100851,7 +100833,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -100861,13 +100843,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -100889,7 +100871,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -100899,15 +100881,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -100933,11 +100915,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -100945,7 +100927,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -100955,15 +100937,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -100971,7 +100953,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -100979,19 +100961,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -100999,25 +100981,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -101039,18 +101021,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -101058,22 +101040,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -101087,34 +101069,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -101132,36 +101114,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -101193,56 +101175,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -101250,26 +101232,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -101278,7 +101260,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -101288,7 +101270,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -101312,7 +101294,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -101328,7 +101310,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -101338,13 +101320,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -101354,11 +101336,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -101368,7 +101350,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -101376,22 +101358,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -101400,7 +101382,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -101415,7 +101397,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -101427,7 +101409,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -101438,7 +101420,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -101455,13 +101437,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -101509,7 +101491,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -101517,7 +101499,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -101531,7 +101513,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -101551,7 +101533,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -101575,23 +101557,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -101599,7 +101581,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -101613,7 +101595,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -101625,17 +101607,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -101645,7 +101627,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -101657,11 +101639,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -101675,7 +101657,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -101685,37 +101667,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -101729,23 +101711,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -101765,15 +101747,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -101799,11 +101781,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -101811,7 +101793,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -101821,15 +101803,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -101837,7 +101819,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -101845,19 +101827,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -101865,25 +101847,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -101905,18 +101887,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -101924,22 +101906,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -101953,34 +101935,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -101998,36 +101980,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -102059,56 +102041,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -102116,26 +102098,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -102144,7 +102126,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -102154,7 +102136,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -102178,7 +102160,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -102194,7 +102176,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -102204,13 +102186,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -102220,11 +102202,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -102234,7 +102216,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -102242,22 +102224,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -102266,7 +102248,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -102281,7 +102263,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -102293,7 +102275,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -102304,7 +102286,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -102321,13 +102303,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -102375,7 +102357,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -102383,7 +102365,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -102397,7 +102379,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -102417,7 +102399,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -102441,23 +102423,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -102465,7 +102447,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -102479,7 +102461,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -102491,17 +102473,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -102511,7 +102493,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -102523,11 +102505,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -102541,7 +102523,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -102551,37 +102533,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -102595,13 +102577,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -102609,17 +102591,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -102647,7 +102629,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -102661,7 +102643,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -102670,7 +102652,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -102682,27 +102664,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -102716,7 +102698,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -102738,29 +102720,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -102774,7 +102756,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -102784,7 +102766,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -102792,13 +102774,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -102808,25 +102790,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -102860,7 +102842,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -102870,7 +102852,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -102904,7 +102886,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -102916,25 +102898,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -102942,7 +102924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -102956,11 +102938,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -102996,7 +102978,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -103004,11 +102986,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -103024,11 +103006,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -103038,7 +103020,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -103056,7 +103038,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -103066,7 +103048,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -103074,7 +103056,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -103104,19 +103086,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -103124,7 +103106,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -103150,7 +103132,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -103166,11 +103148,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -103178,18 +103160,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -103197,7 +103179,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -103211,7 +103193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -103235,7 +103217,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -103243,21 +103225,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -103269,39 +103251,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -103317,7 +103299,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -103327,7 +103309,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -103351,7 +103333,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -103378,11 +103360,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -103390,8 +103372,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -103431,7 +103413,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -103439,20 +103421,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -103467,14 +103449,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -103544,7 +103526,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -103614,31 +103596,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -103664,11 +103646,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -103676,7 +103658,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -103686,15 +103668,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -103702,7 +103684,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -103710,19 +103692,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -103730,25 +103712,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -103770,18 +103752,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -103789,22 +103771,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -103818,34 +103800,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -103863,36 +103845,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -103924,56 +103906,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -103981,26 +103963,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -104009,7 +103991,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -104019,7 +104001,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -104043,7 +104025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -104059,7 +104041,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -104069,13 +104051,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -104085,11 +104067,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -104099,7 +104081,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -104107,22 +104089,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -104131,7 +104113,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -104146,7 +104128,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -104158,7 +104140,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -104169,7 +104151,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -104186,13 +104168,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -104240,7 +104222,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -104248,7 +104230,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -104262,7 +104244,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -104282,7 +104264,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -104306,23 +104288,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -104330,7 +104312,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -104344,7 +104326,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -104356,17 +104338,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -104376,7 +104358,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -104388,11 +104370,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -104406,7 +104388,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -104416,37 +104398,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -104460,26 +104442,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -104487,19 +104469,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -104507,11 +104489,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -104519,25 +104501,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -104549,13 +104531,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -104563,11 +104545,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -104575,25 +104557,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -104605,26 +104587,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -104632,19 +104614,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -104656,11 +104638,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -104678,18 +104660,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -104697,19 +104679,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -104720,13 +104700,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -104744,11 +104724,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -104758,17 +104738,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -104776,11 +104756,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -104790,21 +104770,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -104822,8 +104802,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -104839,31 +104819,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -104873,13 +104853,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -104895,22 +104875,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -104920,9 +104900,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -104933,10 +104913,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -104944,8 +104924,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -104954,8 +104934,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -104963,7 +104943,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -104972,7 +104952,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -104980,29 +104960,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.incomplete"`
@@ -105010,7 +104990,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.incomplete"`
-### Response Input Audio
+### Response 输入音频
- `ResponseInputAudio object { input_audio, type }`
@@ -105033,7 +105013,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_audio"`
- 输入项的类型。始终为 `input_audio`.
+ The type of the input item. Always `input_audio`.
- `"input_audio"`
@@ -105041,39 +105021,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputContent = ResponseInputText or ResponseInputImage or ResponseInputFile`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -105085,25 +105065,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105113,13 +105093,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -105129,27 +105109,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105161,13 +105141,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -105177,27 +105157,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105209,13 +105189,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -105229,23 +105209,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105253,11 +105233,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -105269,25 +105249,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105295,17 +105275,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -105317,19 +105297,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105337,40 +105317,40 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -105382,25 +105362,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105410,13 +105390,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -105426,27 +105406,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105460,40 +105440,40 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -105505,25 +105485,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105533,13 +105513,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -105549,33 +105529,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -105591,8 +105571,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -105604,25 +105584,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105630,25 +105610,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -105668,15 +105648,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallArgumentsDeltaEvent object { delta, item_id, output_index, 2 more }`
- 当 MCP 工具调用的参数存在增量(部分更新)时触发。
+ 当 MCP 工具调用的参数存在 delta(部分更新)时发出。
- `delta: string`
- 包含 MCP 工具调用参数部分更新的 JSON 字符串。
+ 一个 JSON 字符串,包含 MCP 工具调用参数的部分更新。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的唯一标识符。
+ 正在处理的 MCP 工具调用项的唯一标识符。
- `output_index: number`
@@ -105684,27 +105664,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call_arguments.delta"`
- 事件类型。始终为 'response.mcp_call_arguments.delta'。
+ 事件的类型。始终为 'response.mcp_call_arguments.delta'。
- `"response.mcp_call_arguments.delta"`
-### Response Mcp Call Arguments Done Event
+### Response Mcp 调用参数完成事件
- `ResponseMcpCallArgumentsDoneEvent object { arguments, item_id, output_index, 2 more }`
- 在 MCP 工具调用的参数最终确定时发出。
+ 当 MCP 工具调用的参数被最终确定时发出。
- `arguments: string`
- 一个 JSON 字符串,包含 MCP 工具调用最终确定的参数。
+ 一个 JSON 字符串,包含 MCP 工具调用的最终确定参数。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的唯一标识符。
+ 正在处理的 MCP 工具调用项的唯一标识符。
- `output_index: number`
@@ -105712,7 +105692,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call_arguments.done"`
@@ -105724,7 +105704,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 当 MCP 工具调用成功完成时发出。
+ 当 MCP 工具调用已成功完成时触发。
- `item_id: string`
@@ -105736,7 +105716,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call.completed"`
@@ -105748,7 +105728,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallFailedEvent object { item_id, output_index, sequence_number, type }`
- 在 MCP 工具调用失败时发出。
+ 当 MCP 工具调用失败时触发。
- `item_id: string`
@@ -105760,7 +105740,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call.failed"`
@@ -105768,15 +105748,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.mcp_call.failed"`
-### Response Mcp 调用进行中事件
+### Response Mcp Call In Progress 事件
- `ResponseMcpCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 当 MCP 工具调用正在进行时发出。
+ 在 MCP 工具调用进行中时发出。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的唯一标识符。
+ 正在处理的 MCP 工具调用项的唯一标识符。
- `output_index: number`
@@ -105784,7 +105764,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call.in_progress"`
@@ -105796,7 +105776,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpListToolsCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在成功检索到可用 MCP 工具列表时发出。
+ 在成功检索到可用的 MCP 工具列表时发出。
- `item_id: string`
@@ -105808,7 +105788,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_list_tools.completed"`
@@ -105832,7 +105812,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_list_tools.failed"`
@@ -105844,19 +105824,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpListToolsInProgressEvent object { item_id, output_index, sequence_number, type }`
- 系统正在检索可用 MCP 工具列表时触发。
+ 系统在检索可用 MCP 工具列表的过程中发出。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的 ID。
+ 正在处理的 MCP 工具调用项的 ID。
- `output_index: number`
- 正在处理的输出条目的索引。
+ 正在处理的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_list_tools.in_progress"`
@@ -105864,11 +105844,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.mcp_list_tools.in_progress"`
-### Response Output Audio
+### Response 输出音频
- `ResponseOutputAudio object { data, transcript, type }`
- 来自模型的音频输出。
+ 模型的音频输出。
- `data: string`
@@ -105876,7 +105856,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `transcript: string`
- 来自模型的音频数据的转录文本。
+ 来自模型的音频数据的文字稿。
- `type: "output_audio"`
@@ -105884,19 +105864,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"output_audio"`
-### Response Output Item
+### 响应输出项
- `ResponseOutputItem = ResponseOutputMessage or object { id, queries, status, 2 more } or object { arguments, call_id, name, 5 more } or 25 more`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -105904,15 +105884,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -105920,11 +105900,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -105934,19 +105914,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -105956,7 +105936,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -105968,7 +105948,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -105976,11 +105956,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -105998,7 +105978,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -106034,15 +106014,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -106054,8 +106034,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -106071,9 +106051,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -106081,7 +106061,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -106090,7 +106070,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -106109,20 +106089,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -106141,7 +106121,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -106158,7 +106138,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -106200,8 +106180,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -106226,39 +106206,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -106270,25 +106250,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -106298,13 +106278,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -106314,34 +106294,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -106357,7 +106337,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -106385,20 +106365,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -106406,12 +106386,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -106443,7 +106423,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -106457,7 +106437,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -106471,11 +106451,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -106487,7 +106467,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -106502,7 +106482,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -106522,8 +106502,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -106539,15 +106519,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -106561,25 +106541,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -106587,7 +106567,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -106601,11 +106581,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -106624,7 +106604,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -106634,11 +106614,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -106666,7 +106646,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -106698,15 +106678,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -106734,24 +106714,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -106781,22 +106761,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -106804,8 +106784,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -106817,13 +106797,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -106840,13 +106820,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -106889,20 +106869,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -106926,11 +106906,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -106942,15 +106922,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -106958,7 +106938,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -106986,7 +106966,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -106996,13 +106976,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -107024,7 +107004,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -107034,15 +107014,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -107068,11 +107048,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -107080,7 +107060,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -107090,19 +107070,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -107111,9 +107091,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -107155,11 +107135,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -107173,7 +107153,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -107181,19 +107161,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -107201,25 +107181,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -107241,18 +107221,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -107260,22 +107240,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -107289,34 +107269,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -107334,36 +107314,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -107395,56 +107375,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -107452,26 +107432,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -107480,7 +107460,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -107490,7 +107470,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -107520,33 +107500,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -107562,7 +107542,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -107572,13 +107552,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -107588,11 +107568,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -107602,7 +107582,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -107610,22 +107590,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -107634,7 +107614,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -107649,7 +107629,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -107661,7 +107641,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -107672,7 +107652,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -107689,13 +107669,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -107739,13 +107719,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -107769,7 +107749,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -107785,7 +107765,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -107799,7 +107779,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -107807,13 +107787,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -107845,13 +107825,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -107861,7 +107841,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -107869,7 +107849,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -107883,7 +107863,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -107895,7 +107875,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -107905,7 +107885,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -107913,7 +107893,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -107935,7 +107915,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -107959,23 +107939,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -107983,7 +107963,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -107997,7 +107977,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -108009,17 +107989,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -108029,7 +108009,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -108041,11 +108021,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -108059,7 +108039,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -108069,37 +108049,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -108113,23 +108093,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -108149,15 +108129,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -108183,11 +108163,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -108195,7 +108175,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -108205,15 +108185,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -108221,7 +108201,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -108229,19 +108209,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -108249,25 +108229,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -108289,18 +108269,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -108308,22 +108288,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -108337,34 +108317,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -108382,36 +108362,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -108443,56 +108423,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -108500,26 +108480,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -108528,7 +108508,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -108538,7 +108518,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -108562,7 +108542,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -108578,7 +108558,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -108588,13 +108568,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -108604,11 +108584,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -108618,7 +108598,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -108626,22 +108606,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -108650,7 +108630,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -108665,7 +108645,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -108677,7 +108657,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -108688,7 +108668,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -108705,13 +108685,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -108759,7 +108739,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -108767,7 +108747,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -108781,7 +108761,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -108801,7 +108781,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -108825,23 +108805,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -108849,7 +108829,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -108863,7 +108843,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -108875,17 +108855,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -108895,7 +108875,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -108907,11 +108887,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -108925,7 +108905,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -108935,37 +108915,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -108979,13 +108959,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -108993,17 +108973,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -109031,7 +109011,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -109045,7 +109025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -109054,7 +109034,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -109066,27 +109046,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -109100,7 +109080,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -109122,29 +109102,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -109158,7 +109138,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -109168,7 +109148,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -109176,13 +109156,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -109192,25 +109172,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -109244,7 +109224,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -109254,7 +109234,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -109288,7 +109268,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -109300,25 +109280,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -109326,7 +109306,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -109340,11 +109320,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -109380,7 +109360,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -109388,11 +109368,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -109408,11 +109388,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -109422,7 +109402,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -109440,7 +109420,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -109450,7 +109430,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -109458,7 +109438,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -109488,19 +109468,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -109508,7 +109488,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -109534,7 +109514,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -109550,11 +109530,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -109562,18 +109542,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -109609,7 +109589,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -109623,7 +109603,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -109647,7 +109627,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -109655,21 +109635,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -109681,39 +109661,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -109729,7 +109709,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -109739,7 +109719,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -109763,7 +109743,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -109790,11 +109770,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -109802,8 +109782,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -109843,9 +109823,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
-### Response Output Item Added Event
+### 响应输出项添加事件
- `ResponseOutputItemAddedEvent object { item, output_index, sequence_number, type }`
@@ -109853,18 +109833,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item: ResponseOutputItem`
- 被新增的输出项。对于推理项(reasoning items), `encrypted_content`
- 在该项仍在进行中时可能不完整。请使用对应事件中的推理项
- 来自 `response.output_item.done` 事件中的推理项,将其作为输入传入后续请求时使用。
- as input to a subsequent request.
+ 被添加的输出项。对于推理项, `encrypted_content`
+ 在项进行中时可能不完整。可使用相应
+ 事件中的推理项 `response.output_item.done` 在将其作为输入传递给后续请求时使用。
+ 后续请求的输入。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -109872,15 +109852,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -109888,11 +109868,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -109902,19 +109882,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -109924,7 +109904,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -109936,7 +109916,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -109944,11 +109924,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -109966,7 +109946,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -110002,15 +109982,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -110022,8 +110002,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -110039,9 +110019,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -110049,7 +110029,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -110058,7 +110038,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -110077,20 +110057,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -110109,7 +110089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -110126,7 +110106,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -110168,8 +110148,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -110194,39 +110174,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -110238,25 +110218,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -110266,13 +110246,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -110282,34 +110262,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -110325,7 +110305,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -110353,20 +110333,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -110374,12 +110354,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -110411,7 +110391,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -110425,7 +110405,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -110439,11 +110419,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -110455,7 +110435,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -110470,7 +110450,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -110490,8 +110470,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -110507,15 +110487,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -110529,25 +110509,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -110555,7 +110535,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -110569,11 +110549,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -110592,7 +110572,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -110602,11 +110582,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -110634,7 +110614,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -110666,15 +110646,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -110702,24 +110682,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -110749,22 +110729,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -110772,8 +110752,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -110785,13 +110765,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -110808,13 +110788,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -110857,20 +110837,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -110894,11 +110874,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -110910,15 +110890,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -110926,7 +110906,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -110954,7 +110934,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -110964,13 +110944,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -110992,7 +110972,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -111002,15 +110982,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -111036,11 +111016,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -111048,7 +111028,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -111058,19 +111038,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -111079,9 +111059,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -111123,11 +111103,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -111141,7 +111121,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -111149,19 +111129,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -111169,25 +111149,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -111209,18 +111189,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -111228,22 +111208,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -111257,34 +111237,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -111302,36 +111282,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -111363,56 +111343,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -111420,26 +111400,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -111448,7 +111428,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -111458,7 +111438,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -111488,33 +111468,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -111530,7 +111510,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -111540,13 +111520,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -111556,11 +111536,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -111570,7 +111550,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -111578,22 +111558,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -111602,7 +111582,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -111617,7 +111597,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -111629,7 +111609,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -111640,7 +111620,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -111657,13 +111637,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -111707,13 +111687,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -111737,7 +111717,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -111753,7 +111733,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -111767,7 +111747,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -111775,13 +111755,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -111813,13 +111793,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -111829,7 +111809,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -111837,7 +111817,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -111851,7 +111831,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -111863,7 +111843,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -111873,7 +111853,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -111881,7 +111861,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -111903,7 +111883,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -111927,23 +111907,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -111951,7 +111931,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -111965,7 +111945,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -111977,17 +111957,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -111997,7 +111977,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -112009,11 +111989,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -112027,7 +112007,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -112037,37 +112017,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -112081,23 +112061,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -112117,15 +112097,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -112151,11 +112131,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -112163,7 +112143,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -112173,15 +112153,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -112189,7 +112169,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -112197,19 +112177,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -112217,25 +112197,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -112257,18 +112237,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -112276,22 +112256,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -112305,34 +112285,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -112350,36 +112330,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -112411,56 +112391,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -112468,26 +112448,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -112496,7 +112476,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -112506,7 +112486,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -112530,7 +112510,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -112546,7 +112526,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -112556,13 +112536,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -112572,11 +112552,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -112586,7 +112566,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -112594,22 +112574,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -112618,7 +112598,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -112633,7 +112613,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -112645,7 +112625,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -112656,7 +112636,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -112673,13 +112653,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -112727,7 +112707,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -112735,7 +112715,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -112749,7 +112729,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -112769,7 +112749,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -112793,23 +112773,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -112817,7 +112797,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -112831,7 +112811,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -112843,17 +112823,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -112863,7 +112843,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -112875,11 +112855,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -112893,7 +112873,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -112903,37 +112883,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -112947,13 +112927,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -112961,17 +112941,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -112999,7 +112979,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -113013,7 +112993,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -113022,7 +113002,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -113034,27 +113014,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -113068,7 +113048,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -113090,29 +113070,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -113126,7 +113106,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -113136,7 +113116,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -113144,13 +113124,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -113160,25 +113140,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -113212,7 +113192,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -113222,7 +113202,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -113256,7 +113236,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -113268,25 +113248,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -113294,7 +113274,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -113308,11 +113288,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -113348,7 +113328,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -113356,11 +113336,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -113376,11 +113356,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -113390,7 +113370,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -113408,7 +113388,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -113418,7 +113398,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -113426,7 +113406,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -113456,19 +113436,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -113476,7 +113456,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -113502,7 +113482,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -113518,11 +113498,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -113530,18 +113510,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -113577,7 +113557,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -113591,7 +113571,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -113615,7 +113595,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -113623,21 +113603,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -113649,39 +113629,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -113697,7 +113677,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -113707,7 +113687,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -113731,7 +113711,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -113758,11 +113738,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -113770,8 +113750,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -113811,15 +113791,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `output_index: number`
- 被新增的输出项的索引。
+ 被添加的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.output_item.added"`
@@ -113827,7 +113807,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.output_item.added"`
-### Response 输出项完成事件
+### 响应输出项完成事件
- `ResponseOutputItemDoneEvent object { item, output_index, sequence_number, type }`
@@ -113839,11 +113819,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -113851,15 +113831,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -113867,11 +113847,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -113881,19 +113861,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -113903,7 +113883,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -113915,7 +113895,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -113923,11 +113903,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -113945,7 +113925,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -113981,15 +113961,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -114001,8 +113981,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -114018,9 +113998,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -114028,7 +114008,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -114037,7 +114017,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -114056,20 +114036,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -114088,7 +114068,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -114105,7 +114085,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -114147,8 +114127,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -114173,39 +114153,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -114217,25 +114197,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -114245,13 +114225,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -114261,34 +114241,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -114304,7 +114284,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -114332,20 +114312,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -114353,12 +114333,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -114390,7 +114370,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -114404,7 +114384,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -114418,11 +114398,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -114434,7 +114414,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -114449,7 +114429,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -114469,8 +114449,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -114486,15 +114466,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -114508,25 +114488,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -114534,7 +114514,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -114548,11 +114528,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -114571,7 +114551,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -114581,11 +114561,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -114613,7 +114593,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -114645,15 +114625,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -114681,24 +114661,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -114728,22 +114708,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -114751,8 +114731,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -114764,13 +114744,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -114787,13 +114767,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -114836,20 +114816,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -114873,11 +114853,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -114889,15 +114869,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -114905,7 +114885,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -114933,7 +114913,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -114943,13 +114923,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -114971,7 +114951,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -114981,15 +114961,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -115015,11 +114995,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -115027,7 +115007,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -115037,19 +115017,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -115058,9 +115038,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -115102,11 +115082,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -115120,7 +115100,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -115128,19 +115108,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -115148,25 +115128,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -115188,18 +115168,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -115207,22 +115187,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -115236,34 +115216,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -115281,36 +115261,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -115342,56 +115322,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -115399,26 +115379,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -115427,7 +115407,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -115437,7 +115417,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -115467,33 +115447,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -115509,7 +115489,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -115519,13 +115499,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -115535,11 +115515,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -115549,7 +115529,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -115557,22 +115537,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -115581,7 +115561,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -115596,7 +115576,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -115608,7 +115588,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -115619,7 +115599,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -115636,13 +115616,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -115686,13 +115666,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -115716,7 +115696,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -115732,7 +115712,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -115746,7 +115726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -115754,13 +115734,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -115792,13 +115772,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -115808,7 +115788,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -115816,7 +115796,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -115830,7 +115810,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -115842,7 +115822,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -115852,7 +115832,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -115860,7 +115840,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -115882,7 +115862,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -115906,23 +115886,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -115930,7 +115910,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -115944,7 +115924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -115956,17 +115936,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -115976,7 +115956,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -115988,11 +115968,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -116006,7 +115986,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -116016,37 +115996,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -116060,23 +116040,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -116096,15 +116076,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -116130,11 +116110,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -116142,7 +116122,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -116152,15 +116132,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -116168,7 +116148,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -116176,19 +116156,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -116196,25 +116176,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -116236,18 +116216,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -116255,22 +116235,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -116284,34 +116264,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -116329,36 +116309,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -116390,56 +116370,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -116447,26 +116427,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -116475,7 +116455,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -116485,7 +116465,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -116509,7 +116489,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -116525,7 +116505,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -116535,13 +116515,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -116551,11 +116531,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -116565,7 +116545,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -116573,22 +116553,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -116597,7 +116577,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -116612,7 +116592,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -116624,7 +116604,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -116635,7 +116615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -116652,13 +116632,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -116706,7 +116686,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -116714,7 +116694,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -116728,7 +116708,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -116748,7 +116728,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -116772,23 +116752,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -116796,7 +116776,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -116810,7 +116790,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -116822,17 +116802,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -116842,7 +116822,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -116854,11 +116834,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -116872,7 +116852,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -116882,37 +116862,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -116926,13 +116906,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -116940,17 +116920,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -116978,7 +116958,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -116992,7 +116972,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -117001,7 +116981,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -117013,27 +116993,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -117047,7 +117027,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -117069,29 +117049,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -117105,7 +117085,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -117115,7 +117095,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -117123,13 +117103,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -117139,25 +117119,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -117191,7 +117171,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -117201,7 +117181,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -117235,7 +117215,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -117247,25 +117227,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -117273,7 +117253,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -117287,11 +117267,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -117327,7 +117307,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -117335,11 +117315,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -117355,11 +117335,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -117369,7 +117349,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -117387,7 +117367,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -117397,7 +117377,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -117405,7 +117385,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -117435,19 +117415,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -117455,7 +117435,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -117481,7 +117461,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -117497,11 +117477,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -117509,18 +117489,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -117556,7 +117536,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -117570,7 +117550,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -117594,7 +117574,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -117602,21 +117582,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -117628,39 +117608,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -117676,7 +117656,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -117686,7 +117666,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -117710,7 +117690,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -117737,11 +117717,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -117749,8 +117729,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -117790,7 +117770,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `output_index: number`
@@ -117798,7 +117778,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.output_item.done"`
@@ -117806,15 +117786,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.output_item.done"`
-### Response 输出消息
+### Response Output Message
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -117822,15 +117802,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -117838,11 +117818,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -117852,19 +117832,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -117874,7 +117854,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -117886,7 +117866,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -117894,11 +117874,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -117916,7 +117896,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -117952,15 +117932,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -117972,8 +117952,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -117989,43 +117969,43 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
- `"final_answer"`
-### Response 输出拒绝
+### Response Output Refusal
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
-### Response 输出文本
+### Response Output Text
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -118033,11 +118013,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -118047,19 +118027,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -118069,7 +118049,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -118081,7 +118061,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -118089,11 +118069,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -118111,7 +118091,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -118145,19 +118125,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"output_text"`
-### Response 输出文本注解添加事件
+### Response Output Text Annotation Added Event
- `ResponseOutputTextAnnotationAddedEvent object { annotation, annotation_index, content_index, 4 more }`
- 当注释被添加到输出文本内容时发出。
+ 当向输出文本内容添加批注时发出。
- `annotation: object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type } or null`
- 应用于一段输出文本的注释。
+ 应用于一段输出文本的批注。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -118165,11 +118145,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -118179,19 +118159,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -118201,7 +118181,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -118213,7 +118193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -118221,11 +118201,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -118243,7 +118223,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -118253,15 +118233,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotation_index: number`
- 该注释在内容部分中的索引。
+ 内容片段中批注的索引。
- `content_index: number`
- 该内容部分在输出项中的索引。
+ 输出项中内容片段的索引。
- `item_id: string`
- 正在添加注释的项的唯一标识符。
+ 正在添加批注的项的唯一标识符。
- `output_index: number`
@@ -118269,7 +118249,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.output_text.annotation.added"`
@@ -118282,7 +118262,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponsePrompt object { id, variables, version }`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -118290,43 +118270,43 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -118338,25 +118318,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -118366,13 +118346,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -118382,27 +118362,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -118414,11 +118394,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseQueuedEvent object { response, sequence_number, type }`
- 当响应已加入队列并等待处理时发出。
+ 当响应被排队等待处理时发出。
- `response: Response`
- 已加入队列的完整响应对象。
+ 被排队的完整响应对象。
- `id: string`
@@ -118426,7 +118406,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -118482,11 +118462,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -118496,13 +118476,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -118512,57 +118492,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -118574,25 +118554,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -118602,13 +118582,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -118618,33 +118598,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -118657,9 +118637,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -118667,24 +118647,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -118694,8 +118674,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -118711,11 +118691,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -118723,15 +118703,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -118739,11 +118719,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -118753,19 +118733,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -118775,7 +118755,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -118787,7 +118767,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -118795,11 +118775,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -118817,7 +118797,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -118853,15 +118833,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -118873,8 +118853,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -118890,9 +118870,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -118900,7 +118880,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -118909,7 +118889,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -118928,20 +118908,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -118960,7 +118940,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -118977,7 +118957,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -118997,8 +118977,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -119014,15 +118994,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -119036,25 +119016,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -119062,7 +119042,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -119076,11 +119056,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -119099,7 +119079,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -119109,11 +119089,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -119141,7 +119121,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -119173,15 +119153,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -119209,24 +119189,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -119250,26 +119230,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -119277,17 +119257,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -119303,7 +119283,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -119313,8 +119293,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -119322,12 +119302,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -119359,7 +119339,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -119373,7 +119353,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -119387,11 +119367,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -119403,7 +119383,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -119418,7 +119398,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -119460,8 +119440,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -119475,7 +119455,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -119483,61 +119463,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -119547,13 +119527,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -119567,23 +119547,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -119595,11 +119575,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -119627,15 +119607,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -119651,7 +119631,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -119689,11 +119669,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -119719,11 +119699,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -119731,7 +119711,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -119741,19 +119721,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -119762,9 +119742,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -119806,11 +119786,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -119824,7 +119804,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -119832,19 +119812,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -119852,25 +119832,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -119892,18 +119872,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -119911,22 +119891,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -119940,34 +119920,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -119985,36 +119965,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -120046,56 +120026,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -120103,26 +120083,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -120131,7 +120111,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -120141,7 +120121,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -120171,33 +120151,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -120213,7 +120193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -120223,13 +120203,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -120239,11 +120219,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -120253,7 +120233,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -120261,22 +120241,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -120285,7 +120265,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -120300,7 +120280,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -120312,7 +120292,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -120323,7 +120303,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -120340,13 +120320,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -120390,13 +120370,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -120420,7 +120400,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -120436,7 +120416,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -120450,7 +120430,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -120458,13 +120438,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -120496,13 +120476,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -120512,7 +120492,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -120520,7 +120500,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -120534,7 +120514,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -120546,7 +120526,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -120556,7 +120536,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -120564,7 +120544,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -120586,7 +120566,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -120610,23 +120590,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -120634,7 +120614,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -120648,7 +120628,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -120660,17 +120640,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -120680,7 +120660,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -120692,11 +120672,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -120710,7 +120690,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -120720,37 +120700,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -120764,7 +120744,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -120798,21 +120778,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -120838,11 +120818,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -120850,7 +120830,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -120860,15 +120840,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -120876,7 +120856,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -120884,19 +120864,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -120904,25 +120884,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -120944,18 +120924,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -120963,22 +120943,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -120992,34 +120972,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -121037,36 +121017,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -121098,56 +121078,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -121155,26 +121135,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -121183,7 +121163,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -121193,7 +121173,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -121217,7 +121197,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -121233,7 +121213,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -121243,13 +121223,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -121259,11 +121239,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -121273,7 +121253,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -121281,22 +121261,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -121305,7 +121285,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -121320,7 +121300,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -121332,7 +121312,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -121343,7 +121323,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -121360,13 +121340,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -121414,7 +121394,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -121422,7 +121402,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -121436,7 +121416,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -121456,7 +121436,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -121480,23 +121460,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -121504,7 +121484,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -121518,7 +121498,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -121530,17 +121510,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -121550,7 +121530,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -121562,11 +121542,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -121580,7 +121560,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -121590,37 +121570,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -121634,19 +121614,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -121689,20 +121669,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -121712,7 +121692,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -121720,13 +121700,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -121754,7 +121734,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -121768,7 +121748,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -121777,7 +121757,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -121789,27 +121769,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -121823,7 +121803,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -121845,29 +121825,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -121881,7 +121861,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -121891,7 +121871,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -121899,13 +121879,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -121919,11 +121899,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -121931,7 +121911,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -121939,13 +121919,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -121981,7 +121961,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -121991,7 +121971,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -121999,7 +121979,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -122007,45 +121987,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -122073,7 +122053,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -122087,11 +122067,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -122103,11 +122083,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -122121,7 +122101,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -122135,11 +122115,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -122149,7 +122129,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -122157,13 +122137,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -122195,11 +122175,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -122207,13 +122187,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -122241,11 +122221,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -122269,7 +122249,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -122277,21 +122257,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -122303,39 +122283,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -122347,11 +122327,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -122359,18 +122339,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -122406,7 +122386,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -122420,7 +122400,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -122441,11 +122421,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -122459,7 +122439,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -122499,7 +122479,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -122509,7 +122489,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -122533,7 +122513,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -122541,7 +122521,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -122555,11 +122535,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -122579,11 +122559,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -122595,15 +122575,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -122611,24 +122591,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -122843,7 +122823,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -122851,20 +122831,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -122873,7 +122853,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -122892,20 +122872,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -122924,7 +122904,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -122941,7 +122921,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -122983,8 +122963,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -123009,15 +122989,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -123025,8 +123005,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -123042,7 +123022,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -123070,20 +123050,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -123091,12 +123071,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -123128,7 +123108,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -123142,7 +123122,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -123156,11 +123136,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -123172,7 +123152,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -123187,7 +123167,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -123207,8 +123187,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -123224,12 +123204,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -123239,16 +123219,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -123260,13 +123240,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -123283,13 +123263,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -123330,20 +123310,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -123367,11 +123347,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -123383,15 +123363,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -123399,7 +123379,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -123427,7 +123407,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -123437,13 +123417,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -123465,7 +123445,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -123475,15 +123455,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -123509,11 +123489,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -123521,7 +123501,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -123531,15 +123511,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -123547,7 +123527,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -123555,19 +123535,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -123575,25 +123555,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -123615,18 +123595,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -123634,22 +123614,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -123663,34 +123643,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -123708,36 +123688,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -123769,56 +123749,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -123826,26 +123806,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -123854,7 +123834,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -123864,7 +123844,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -123888,7 +123868,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -123904,7 +123884,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -123914,13 +123894,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -123930,11 +123910,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -123944,7 +123924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -123952,22 +123932,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -123976,7 +123956,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -123991,7 +123971,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -124003,7 +123983,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -124014,7 +123994,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -124031,13 +124011,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -124085,7 +124065,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -124093,7 +124073,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -124107,7 +124087,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -124127,7 +124107,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -124151,23 +124131,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -124175,7 +124155,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -124189,7 +124169,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -124201,17 +124181,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -124221,7 +124201,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -124233,11 +124213,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -124251,7 +124231,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -124261,37 +124241,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -124305,23 +124285,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -124341,15 +124321,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -124375,11 +124355,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -124387,7 +124367,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -124397,15 +124377,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -124413,7 +124393,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -124421,19 +124401,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -124441,25 +124421,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -124481,18 +124461,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -124500,22 +124480,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -124529,34 +124509,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -124574,36 +124554,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -124635,56 +124615,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -124692,26 +124672,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -124720,7 +124700,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -124730,7 +124710,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -124754,7 +124734,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -124770,7 +124750,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -124780,13 +124760,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -124796,11 +124776,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -124810,7 +124790,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -124818,22 +124798,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -124842,7 +124822,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -124857,7 +124837,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -124869,7 +124849,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -124880,7 +124860,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -124897,13 +124877,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -124951,7 +124931,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -124959,7 +124939,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -124973,7 +124953,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -124993,7 +124973,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -125017,23 +124997,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -125041,7 +125021,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -125055,7 +125035,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -125067,17 +125047,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -125087,7 +125067,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -125099,11 +125079,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -125117,7 +125097,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -125127,37 +125107,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -125171,13 +125151,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -125185,17 +125165,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -125223,7 +125203,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -125237,7 +125217,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -125246,7 +125226,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -125258,27 +125238,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -125292,7 +125272,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -125314,29 +125294,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -125350,7 +125330,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -125360,7 +125340,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -125368,13 +125348,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -125384,25 +125364,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -125436,7 +125416,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -125446,7 +125426,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -125480,7 +125460,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -125492,25 +125472,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -125518,7 +125498,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -125532,11 +125512,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -125572,7 +125552,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -125580,11 +125560,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -125600,11 +125580,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -125614,7 +125594,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -125632,7 +125612,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -125642,7 +125622,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -125650,7 +125630,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -125680,19 +125660,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -125700,7 +125680,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -125726,7 +125706,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -125742,11 +125722,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -125754,18 +125734,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -125773,7 +125753,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -125787,7 +125767,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -125811,7 +125791,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -125819,21 +125799,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -125845,39 +125825,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -125893,7 +125873,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -125903,7 +125883,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -125927,7 +125907,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -125954,11 +125934,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -125966,8 +125946,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -126007,7 +125987,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -126015,20 +125995,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -126043,14 +126023,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -126120,7 +126100,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -126190,31 +126170,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -126240,11 +126220,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -126252,7 +126232,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -126262,15 +126242,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -126278,7 +126258,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -126286,19 +126266,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -126306,25 +126286,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -126346,18 +126326,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -126365,22 +126345,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -126394,34 +126374,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -126439,36 +126419,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -126500,56 +126480,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -126557,26 +126537,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -126585,7 +126565,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -126595,7 +126575,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -126619,7 +126599,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -126635,7 +126615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -126645,13 +126625,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -126661,11 +126641,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -126675,7 +126655,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -126683,22 +126663,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -126707,7 +126687,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -126722,7 +126702,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -126734,7 +126714,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -126745,7 +126725,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -126762,13 +126742,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -126816,7 +126796,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -126824,7 +126804,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -126838,7 +126818,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -126858,7 +126838,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -126882,23 +126862,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -126906,7 +126886,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -126920,7 +126900,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -126932,17 +126912,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -126952,7 +126932,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -126964,11 +126944,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -126982,7 +126962,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -126992,37 +126972,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -127036,26 +127016,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -127063,19 +127043,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -127083,11 +127063,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -127095,25 +127075,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -127125,13 +127105,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -127139,11 +127119,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -127151,25 +127131,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -127181,26 +127161,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -127208,19 +127188,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -127232,11 +127212,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -127254,18 +127234,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -127273,19 +127253,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -127296,13 +127274,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -127320,11 +127298,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -127334,17 +127312,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -127352,11 +127330,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -127366,21 +127344,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -127398,8 +127376,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -127415,31 +127393,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -127449,13 +127427,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -127471,22 +127449,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -127496,9 +127474,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -127509,10 +127487,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -127520,8 +127498,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -127530,8 +127508,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -127539,7 +127517,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -127548,7 +127526,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -127556,25 +127534,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
@@ -127590,37 +127568,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningSummaryPartAddedEvent object { item_id, output_index, part, 3 more }`
- 当添加新的推理摘要分块时触发。
+ 当新的推理摘要部分被添加时触发。
- `item_id: string`
- 与此摘要分块关联的项的 ID。
+ 与此摘要部分相关联的项目的 ID。
- `output_index: number`
- 与此摘要分块关联的输出项的索引。
+ 与此摘要部分相关联的输出项目的索引。
- `part: object { text, type }`
- 已添加的摘要分块。
+ 被添加的摘要部分。
- `text: string`
- 摘要分块的文本。
+ 摘要部分的文本。
- `type: "summary_text"`
- 摘要分块的类型。始终为 `summary_text`.
+ 摘要部分的类型。始终为 `summary_text`.
- `"summary_text"`
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `type: "response.reasoning_summary_part.added"`
@@ -127632,37 +127610,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningSummaryPartDoneEvent object { item_id, output_index, part, 4 more }`
- 在某个推理摘要分段完成时发出。
+ 在推理摘要部分完成时发出。
- `item_id: string`
- 与此摘要分块关联的项的 ID。
+ 与此摘要部分相关联的项目的 ID。
- `output_index: number`
- 与此摘要分块关联的输出项的索引。
+ 与此摘要部分相关联的输出项目的索引。
- `part: object { text, type }`
- 已完成的摘要分段。
+ 已完成的摘要部分。
- `text: string`
- 摘要分块的文本。
+ 摘要部分的文本。
- `type: "summary_text"`
- 摘要分块的类型。始终为 `summary_text`.
+ 摘要部分的类型。始终为 `summary_text`.
- `"summary_text"`
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `type: "response.reasoning_summary_part.done"`
@@ -127672,16 +127650,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "incomplete"`
- 摘要分段的完成状态。当该分段正常完成时省略,
- 并在生成被中断时设为 `incomplete` 。
+ 摘要部分的完成状态。在该部分正常完成时省略,
+ 在生成被中断时设置为 `incomplete` 。
- `"incomplete"`
-### 响应推理摘要文本增量事件
+### Response 推理摘要文本增量事件
- `ResponseReasoningSummaryTextDeltaEvent object { delta, item_id, output_index, 3 more }`
- 当向推理摘要文本添加增量时触发。
+ 当有增量被添加到推理摘要文本时触发。
- `delta: string`
@@ -127697,11 +127675,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `type: "response.reasoning_summary_text.delta"`
@@ -127717,23 +127695,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 该摘要文本所关联的条目的 ID。
+ 此摘要文本所关联条目的 ID。
- `output_index: number`
- 该摘要文本所关联的输出条目的索引。
+ 此摘要文本所关联输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `text: string`
- 已完成的推理摘要的全文。
+ 已完成的推理摘要的完整文本。
- `type: "response.reasoning_summary_text.done"`
@@ -127745,7 +127723,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningTextDeltaEvent object { content_index, delta, item_id, 3 more }`
- 当一个增量被添加到推理文本时发出。
+ 在向推理文本添加增量时发出。
- `content_index: number`
@@ -127765,7 +127743,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.reasoning_text.delta"`
@@ -127773,11 +127751,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.reasoning_text.delta"`
-### 响应推理文本完成事件
+### Response Reasoning Text Done Event
- `ResponseReasoningTextDoneEvent object { content_index, item_id, output_index, 3 more }`
- 当一段推理文本完成时触发。
+ 在推理文本完成时发出。
- `content_index: number`
@@ -127785,15 +127763,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 此推理文本所关联条目的 ID。
+ 与此推理文本关联的条目 ID。
- `output_index: number`
- 此推理文本所关联输出条目的索引。
+ 与此推理文本关联的输出条目索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `text: string`
@@ -127809,27 +127787,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseRefusalDeltaEvent object { content_index, delta, item_id, 3 more }`
- 当存在部分拒绝文本时触发。
+ 当存在部分拒绝文本时发出。
- `content_index: number`
- 被添加拒绝文本的内容部分的索引。
+ 拒绝文本所添加到的内容部分的索引。
- `delta: string`
- 被添加的拒绝文本。
+ 所添加的拒绝文本。
- `item_id: string`
- 被添加拒绝文本的输出项的 ID。
+ 拒绝文本所添加到的输出项的 ID。
- `output_index: number`
- 被添加拒绝文本的输出项的索引。
+ 拒绝文本所添加到的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.refusal.delta"`
@@ -127845,15 +127823,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `content_index: number`
- 拒绝文本最终确定所在内容部分的索引。
+ 拒绝文本最终确定时所对应的内容分片的索引。
- `item_id: string`
- 拒绝文本最终确定所在输出项的 ID。
+ 拒绝文本最终确定时所对应的输出项的 ID。
- `output_index: number`
- 拒绝文本最终确定所在输出项的索引。
+ 拒绝文本最终确定时所对应的输出项的索引。
- `refusal: string`
@@ -127861,7 +127839,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.refusal.done"`
@@ -127873,19 +127851,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseShellCallCommandAddedEvent object { command, command_index, output_index, 2 more }`
- 表示有 shell 命令被添加到工具调用中的流式事件。
+ 指示已将 shell 命令添加到工具调用的流式事件。
- `command: string`
- 被添加的 shell 命令。
+ 已添加的 shell 命令。
- `command_index: number`
- 被添加的 shell 命令的索引。
+ 已添加的 shell 命令的索引。
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -127893,27 +127871,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_command.added"`
- 事件的类型,始终为 `response.shell_call_command.added`.
+ 事件的类型,always `response.shell_call_command.added`.
- `"response.shell_call_command.added"`
-### Response Shell 调用命令 Delta 事件
+### Response Shell Call Command Delta Event
- `ResponseShellCallCommandDeltaEvent object { command_index, delta, output_index, 3 more }`
- 表示 shell 命令已增量更新的流事件。
+ 表示 shell 命令被增量更新的流式事件。
- `command_index: number`
- 已更新的 shell 命令的索引。
+ 被更新的 shell 命令的索引。
- `delta: string`
- 已追加的 shell 命令增量内容。
+ 被追加的 shell 命令增量内容。
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -127921,19 +127899,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_command.delta"`
- 事件的类型,始终为 `response.shell_call_command.delta`.
+ 事件的类型,always `response.shell_call_command.delta`.
- `"response.shell_call_command.delta"`
- `obfuscation: optional string`
- 已添加用于填充事件负载的混淆字符串。
+ 为填充事件负载而添加的混淆字符串。
-### Response Shell Call Command Done Event
+### 响应 Shell 调用命令完成事件
- `ResponseShellCallCommandDoneEvent object { command, command_index, output_index, 2 more }`
- 表示 shell 命令已完成的流式事件。
+ 指示 shell 命令已完成的流事件。
- `command: string`
@@ -127945,7 +127923,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -127953,15 +127931,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_command.done"`
- 事件的类型,始终为 `response.shell_call_command.done`.
+ 事件的类型,always `response.shell_call_command.done`.
- `"response.shell_call_command.done"`
-### 响应 Shell 调用输出内容增量事件
+### Response Shell 调用输出内容增量事件
- `ResponseShellCallOutputContentDeltaEvent object { command_index, delta, item_id, 3 more }`
- 指示 shell 调用输出被增量添加的流式事件。
+ 表示 shell 调用输出被增量添加的流事件。
- `command_index: number`
@@ -127985,7 +127963,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -127993,11 +127971,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_output_content.delta"`
- 事件的类型,始终为 `response.shell_call_output_content.delta`.
+ 事件的类型,always `response.shell_call_output_content.delta`.
- `"response.shell_call_output_content.delta"`
-### 响应 Shell 调用输出内容完成事件
+### Response Shell Call Output Content Done Event
- `ResponseShellCallOutputContentDoneEvent object { command_index, item_id, output, 3 more }`
@@ -128017,21 +127995,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -128039,7 +128017,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -128053,11 +128031,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -128065,7 +128043,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_output_content.done"`
- 事件的类型,始终为 `response.shell_call_output_content.done`.
+ 事件的类型,always `response.shell_call_output_content.done`.
- `"response.shell_call_output_content.done"`
@@ -128073,8 +128051,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseStatus = "completed" or "failed" or "in_progress" or 3 more`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -128096,7 +128074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseAudioDeltaEvent object { delta, sequence_number, type }`
- 当存在部分音频响应时发出。
+ 当出现部分音频响应时发出。
- `delta: string`
@@ -128104,7 +128082,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该流式响应分块对应的序列号。
+ 该流式响应片段的序列号。
- `type: "response.audio.delta"`
@@ -128118,7 +128096,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 增量数据的序列号。
+ 增量事件的序列号。
- `type: "response.audio.done"`
@@ -128136,7 +128114,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.audio.transcript.delta"`
@@ -128146,11 +128124,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseAudioTranscriptDoneEvent object { sequence_number, type }`
- 在整个音频转录完成时发出。
+ 当完整音频转写完成时发出。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.audio.transcript.done"`
@@ -128160,23 +128138,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCodeInterpreterCallCodeDeltaEvent object { delta, item_id, output_index, 2 more }`
- 当代码解释器流式输出部分代码片段时触发。
+ 当代码解释器流式传输出部分代码片段时发出。
- `delta: string`
- 由代码解释器流式输出的部分代码片段。
+ 代码解释器正在流式传输的部分代码片段。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中正在流式输出代码的输出项的索引。
+ 响应中正在流式传输代码的输出条目的索引。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call_code.delta"`
@@ -128186,23 +128164,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCodeInterpreterCallCodeDoneEvent object { code, item_id, output_index, 2 more }`
- 当代码片段由代码解释器完成时发出。
+ 当代码解释器最终确定代码片段时发出。
- `code: string`
- 代码解释器输出的最终代码片段。
+ 由代码解释器输出的最终代码片段。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中已最终确定代码的输出项的索引。
+ 响应中输出项的索引,该输出项的代码已最终确定。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call_code.done"`
@@ -128216,7 +128194,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
@@ -128224,7 +128202,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call.completed"`
@@ -128234,19 +128212,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCodeInterpreterCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 当一次代码解释器调用正在进行时触发。
+ 当代码解释器调用正在进行时发出。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中正在进行代码解释器调用的输出项的索引。
+ 响应中正在执行代码解释器调用的输出项的索引。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call.in_progress"`
@@ -128256,19 +128234,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCodeInterpreterCallInterpretingEvent object { item_id, output_index, sequence_number, type }`
- 在代码解释器正在积极解释代码片段时发出。
+ 当代码解释器正在主动解释代码片段时发出。
- `item_id: string`
- 代码解释器工具调用项的唯一标识符。
+ 代码解释器工具调用条目的唯一标识符。
- `output_index: number`
- 响应中输出项的索引,表示代码解释器正在为其解释代码。
+ 响应中代码解释器正在解释代码的输出项索引。
- `sequence_number: number`
- 该事件的序列号,用于对流式事件排序。
+ 该事件的序列号,用于对流式传输事件进行排序。
- `type: "response.code_interpreter_call.interpreting"`
@@ -128290,7 +128268,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_at: number`
- 此 Response 创建时的 Unix 时间戳(以秒为单位)。
+ 创建此 Response 时的 Unix 时间戳(以秒为单位)。
- `error: ResponseError or null`
@@ -128346,11 +128324,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `incomplete_details: object { reason } or null`
- 有关响应为何不完整的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应不完整的原因。
+ 响应未完成的原因。
- `"max_output_tokens"`
@@ -128360,13 +128338,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -128376,57 +128354,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -128438,25 +128416,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -128466,13 +128444,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -128482,33 +128460,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -128521,9 +128499,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -128531,24 +128509,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -128558,8 +128536,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -128575,11 +128553,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -128587,15 +128565,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -128603,11 +128581,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -128617,19 +128595,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -128639,7 +128617,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -128651,7 +128629,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -128659,11 +128637,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -128681,7 +128659,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -128717,15 +128695,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -128737,8 +128715,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -128754,9 +128732,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -128764,7 +128742,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -128773,7 +128751,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -128792,20 +128770,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -128824,7 +128802,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -128841,7 +128819,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -128861,8 +128839,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -128878,15 +128856,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -128900,25 +128878,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -128926,7 +128904,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -128940,11 +128918,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -128963,7 +128941,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -128973,11 +128951,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -129005,7 +128983,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -129037,15 +129015,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -129073,24 +129051,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -129114,26 +129092,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -129141,17 +129119,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -129167,7 +129145,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -129177,8 +129155,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -129186,12 +129164,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -129223,7 +129201,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -129237,7 +129215,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -129251,11 +129229,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -129267,7 +129245,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -129282,7 +129260,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -129324,8 +129302,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -129339,7 +129317,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -129347,61 +129325,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -129411,13 +129389,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -129431,23 +129409,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -129459,11 +129437,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -129491,15 +129469,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -129515,7 +129493,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -129553,11 +129531,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -129583,11 +129561,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -129595,7 +129573,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -129605,19 +129583,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -129626,9 +129604,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -129670,11 +129648,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -129688,7 +129666,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -129696,19 +129674,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -129716,25 +129694,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -129756,18 +129734,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -129775,22 +129753,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -129804,34 +129782,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -129849,36 +129827,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -129910,56 +129888,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -129967,26 +129945,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -129995,7 +129973,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -130005,7 +129983,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -130035,33 +130013,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -130077,7 +130055,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -130087,13 +130065,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -130103,11 +130081,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -130117,7 +130095,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -130125,22 +130103,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -130149,7 +130127,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -130164,7 +130142,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -130176,7 +130154,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -130187,7 +130165,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -130204,13 +130182,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -130254,13 +130232,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -130284,7 +130262,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -130300,7 +130278,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -130314,7 +130292,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -130322,13 +130300,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -130360,13 +130338,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -130376,7 +130354,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -130384,7 +130362,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -130398,7 +130376,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -130410,7 +130388,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -130420,7 +130398,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -130428,7 +130406,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -130450,7 +130428,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -130474,23 +130452,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -130498,7 +130476,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -130512,7 +130490,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -130524,17 +130502,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -130544,7 +130522,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -130556,11 +130534,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -130574,7 +130552,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -130584,37 +130562,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -130628,7 +130606,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -130662,21 +130640,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -130702,11 +130680,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -130714,7 +130692,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -130724,15 +130702,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -130740,7 +130718,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -130748,19 +130726,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -130768,25 +130746,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -130808,18 +130786,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -130827,22 +130805,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -130856,34 +130834,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -130901,36 +130879,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -130962,56 +130940,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -131019,26 +130997,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -131047,7 +131025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -131057,7 +131035,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -131081,7 +131059,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -131097,7 +131075,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -131107,13 +131085,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -131123,11 +131101,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -131137,7 +131115,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -131145,22 +131123,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -131169,7 +131147,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -131184,7 +131162,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -131196,7 +131174,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -131207,7 +131185,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -131224,13 +131202,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -131278,7 +131256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -131286,7 +131264,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -131300,7 +131278,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -131320,7 +131298,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -131344,23 +131322,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -131368,7 +131346,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -131382,7 +131360,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -131394,17 +131372,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -131414,7 +131392,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -131426,11 +131404,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -131444,7 +131422,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -131454,37 +131432,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -131498,19 +131476,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -131553,20 +131531,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -131576,7 +131554,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -131584,13 +131562,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -131618,7 +131596,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -131632,7 +131610,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -131641,7 +131619,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -131653,27 +131631,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -131687,7 +131665,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -131709,29 +131687,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -131745,7 +131723,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -131755,7 +131733,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -131763,13 +131741,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -131783,11 +131761,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -131795,7 +131773,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -131803,13 +131781,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -131845,7 +131823,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -131855,7 +131833,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -131863,7 +131841,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -131871,45 +131849,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -131937,7 +131915,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -131951,11 +131929,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -131967,11 +131945,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -131985,7 +131963,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -131999,11 +131977,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -132013,7 +131991,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -132021,13 +131999,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -132059,11 +132037,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -132071,13 +132049,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -132105,11 +132083,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -132133,7 +132111,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -132141,21 +132119,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -132167,39 +132145,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -132211,11 +132189,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -132223,18 +132201,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -132270,7 +132248,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -132284,7 +132262,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -132305,11 +132283,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -132323,7 +132301,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -132363,7 +132341,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -132373,7 +132351,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -132397,7 +132375,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -132405,7 +132383,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -132419,11 +132397,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -132443,11 +132421,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -132459,15 +132437,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -132475,24 +132453,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `metadata: Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -132707,7 +132685,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -132715,20 +132693,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
由模型生成的内容项数组。
- - 数组中项的 `output` 长度和顺序取决于
+ - 该数组中项的数量和顺序 `output` 取决于
模型的响应。
- - 与直接访问 `output` 数组中的第一项
- 并假设它是一 `assistant` 条包含模型生成内容的
+ - 与直接访问该数组的 `output` 第一项并
+ 假设它是一 `assistant` 个包含模型生成内容的
消息相比,你也可以考虑使用 `output_text` 属性(在
- 受支持的 SDK 中)。
+ 受支持的 SDK 中可用)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -132737,7 +132715,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -132756,20 +132734,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -132788,7 +132766,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -132805,7 +132783,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -132847,8 +132825,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -132873,15 +132851,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -132889,8 +132867,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -132906,7 +132884,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -132934,20 +132912,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -132955,12 +132933,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -132992,7 +132970,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -133006,7 +132984,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -133020,11 +132998,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -133036,7 +133014,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -133051,7 +133029,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -133071,8 +133049,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -133088,12 +133066,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -133103,16 +133081,16 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -133124,13 +133102,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -133147,13 +133125,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -133194,20 +133172,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -133231,11 +133209,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -133247,15 +133225,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -133263,7 +133241,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
@@ -133291,7 +133269,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -133301,13 +133279,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -133329,7 +133307,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -133339,15 +133317,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -133373,11 +133351,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -133385,7 +133363,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -133395,15 +133373,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -133411,7 +133389,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -133419,19 +133397,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -133439,25 +133417,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -133479,18 +133457,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -133498,22 +133476,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -133527,34 +133505,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -133572,36 +133550,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -133633,56 +133611,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -133690,26 +133668,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -133718,7 +133696,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -133728,7 +133706,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -133752,7 +133730,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -133768,7 +133746,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -133778,13 +133756,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -133794,11 +133772,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -133808,7 +133786,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -133816,22 +133794,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -133840,7 +133818,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -133855,7 +133833,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -133867,7 +133845,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -133878,7 +133856,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -133895,13 +133873,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -133949,7 +133927,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -133957,7 +133935,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -133971,7 +133949,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -133991,7 +133969,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -134015,23 +133993,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -134039,7 +134017,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -134053,7 +134031,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -134065,17 +134043,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -134085,7 +134063,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -134097,11 +134075,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -134115,7 +134093,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -134125,37 +134103,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -134169,23 +134147,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -134205,15 +134183,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -134239,11 +134217,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -134251,7 +134229,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -134261,15 +134239,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -134277,7 +134255,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -134285,19 +134263,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -134305,25 +134283,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -134345,18 +134323,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -134364,22 +134342,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -134393,34 +134371,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -134438,36 +134416,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -134499,56 +134477,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -134556,26 +134534,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -134584,7 +134562,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -134594,7 +134572,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -134618,7 +134596,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -134634,7 +134612,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -134644,13 +134622,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -134660,11 +134638,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -134674,7 +134652,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -134682,22 +134660,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -134706,7 +134684,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -134721,7 +134699,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -134733,7 +134711,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -134744,7 +134722,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -134761,13 +134739,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -134815,7 +134793,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -134823,7 +134801,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -134837,7 +134815,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -134857,7 +134835,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -134881,23 +134859,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -134905,7 +134883,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -134919,7 +134897,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -134931,17 +134909,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -134951,7 +134929,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -134963,11 +134941,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -134981,7 +134959,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -134991,37 +134969,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -135035,13 +135013,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -135049,17 +135027,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -135087,7 +135065,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -135101,7 +135079,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -135110,7 +135088,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -135122,27 +135100,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -135156,7 +135134,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -135178,29 +135156,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -135214,7 +135192,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -135224,7 +135202,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -135232,13 +135210,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -135248,25 +135226,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -135300,7 +135278,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -135310,7 +135288,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -135344,7 +135322,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -135356,25 +135334,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -135382,7 +135360,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -135396,11 +135374,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -135436,7 +135414,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -135444,11 +135422,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -135464,11 +135442,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -135478,7 +135456,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -135496,7 +135474,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -135506,7 +135484,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -135514,7 +135492,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -135544,19 +135522,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -135564,7 +135542,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -135590,7 +135568,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -135606,11 +135584,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -135618,18 +135596,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -135637,7 +135615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -135651,7 +135629,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -135675,7 +135653,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -135683,21 +135661,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -135709,39 +135687,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -135757,7 +135735,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -135767,7 +135745,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -135791,7 +135769,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -135818,11 +135796,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -135830,8 +135808,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -135871,7 +135849,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `parallel_tool_calls: boolean`
@@ -135879,20 +135857,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `temperature: number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -135907,14 +135885,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -135984,7 +135962,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -136054,31 +136032,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -136104,11 +136082,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -136116,7 +136094,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -136126,15 +136104,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -136142,7 +136120,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -136150,19 +136128,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -136170,25 +136148,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -136210,18 +136188,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -136229,22 +136207,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -136258,34 +136236,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -136303,36 +136281,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -136364,56 +136342,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -136421,26 +136399,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -136449,7 +136427,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -136459,7 +136437,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -136483,7 +136461,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -136499,7 +136477,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -136509,13 +136487,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -136525,11 +136503,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -136539,7 +136517,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -136547,22 +136525,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -136571,7 +136549,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -136586,7 +136564,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -136598,7 +136576,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -136609,7 +136587,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -136626,13 +136604,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -136680,7 +136658,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -136688,7 +136666,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -136702,7 +136680,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -136722,7 +136700,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -136746,23 +136724,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -136770,7 +136748,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -136784,7 +136762,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -136796,17 +136774,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -136816,7 +136794,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -136828,11 +136806,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -136846,7 +136824,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -136856,37 +136834,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -136900,26 +136878,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_p: number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `completed_at: optional number or null`
此 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此次响应中的输入项和输出项已自动添加到此对话中。
+ 此响应所属的对话。此响应的输入项和输出项已自动添加到此对话。
- `id: string`
@@ -136927,19 +136905,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(若请求了经过审核的补全)。
+ 响应输入和输出的审核结果,前提是请求了已审核的补全。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -136947,11 +136925,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -136959,25 +136937,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -136989,13 +136967,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -137003,11 +136981,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `categories: map[boolean]`
- 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。
+ 从审核类别到布尔值的字典,如果输入被该类别标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -137015,25 +136993,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `category_scores: map[number]`
- 一个从审核类别到分数的字典。
+ 从审核类别到分数的字典。
- `flagged: boolean`
- 一个布尔值,指示内容是否被任何类别标记。
+ 指示内容是否被任何类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成该结果的审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的审核结果,该值始终为 `moderation_result` 。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在尝试对响应输入或输出进行审核时产生的错误。
+ 在对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -137045,26 +137023,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` (用于审核失败)。
+ 对象类型,对于成功的审核结果,该值始终为 `error` ,用于审核失败的情况。
- `"error"`
- `output_text: optional string or null`
- SDK 专属便捷属性,包含汇总后的文本输出
- ,来自所有 `output_text` 数组中的项(如果存在) `output` 。
+ 仅限SDK的便捷属性,包含所有输出消息中聚合的文本输出
+ 来自所有 `output_text` 数组中的 `output` 条目(如果有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -137072,19 +137050,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -137096,11 +137074,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -137118,18 +137096,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -137137,19 +137115,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -137160,13 +137136,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -137184,11 +137160,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -137198,17 +137174,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -137216,11 +137192,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -137230,21 +137206,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -137262,8 +137238,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional ResponseStatus`
- 响应生成的状态。值为以下之一 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`,或 `incomplete`.
+ 响应生成的状态。取值之一为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`, or `incomplete`.
- `"completed"`
@@ -137279,31 +137255,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -137313,13 +137289,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -137335,22 +137311,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -137360,9 +137336,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -137373,10 +137349,10 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -137384,8 +137360,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -137394,8 +137370,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -137403,7 +137379,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -137412,7 +137388,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -137420,25 +137396,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
- `sequence_number: number`
@@ -137452,31 +137428,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseContentPartAddedEvent object { content_index, item_id, output_index, 3 more }`
- 当新增内容片段时发出。
+ 在新增内容部分时触发。
- `content_index: number`
- 被添加内容片段的索引。
+ 被新增内容部分的索引。
- `item_id: string`
- 内容片段被添加到的输出项的 ID。
+ 内容部分所添加到的输出项的 ID。
- `output_index: number`
- 内容片段被添加到的输出项的索引。
+ 内容部分所添加到的输出项的索引。
- `part: ResponseOutputText or ResponseOutputRefusal or object { text, type }`
- 被添加的内容片段。
+ 被新增的内容部分。
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `ReasoningText object { text, type }`
@@ -137494,7 +137470,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.content_part.added"`
@@ -137504,31 +137480,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseContentPartDoneEvent object { content_index, item_id, output_index, 3 more }`
- 在内容片段完成时发出。
+ 当某个内容部分完成时触发。
- `content_index: number`
- 已完成的内容片段的索引。
+ 已完成的内容部分的索引。
- `item_id: string`
- 内容片段被添加到的输出项的 ID。
+ 内容部分所添加到的输出项的 ID。
- `output_index: number`
- 内容片段被添加到的输出项的索引。
+ 内容部分所添加到的输出项的索引。
- `part: ResponseOutputText or ResponseOutputRefusal or object { text, type }`
- 已完成的内容片段。
+ 已完成的内容部分。
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `ReasoningText object { text, type }`
@@ -137546,7 +137522,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.content_part.done"`
@@ -137556,7 +137532,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCreatedEvent object { response, sequence_number, type }`
- 在响应被创建时发出的事件。
+ 在创建响应时发出的事件。
- `response: Response`
@@ -137574,7 +137550,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseErrorEvent object { code, message, param, 2 more }`
- 在发生错误时发出。
+ 发生错误时触发。
- `code: string or null`
@@ -137590,7 +137566,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "error"`
@@ -137600,7 +137576,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFileSearchCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在文件搜索调用完成时发出(已找到结果)。
+ 在文件搜索调用完成(找到结果)时发出。
- `item_id: string`
@@ -137612,7 +137588,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.file_search_call.completed"`
@@ -137634,7 +137610,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.file_search_call.in_progress"`
@@ -137644,7 +137620,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFileSearchCallSearchingEvent object { item_id, output_index, sequence_number, type }`
- 在文件搜索正在执行搜索时发出。
+ 在文件搜索正在执行检索时发出。
- `item_id: string`
@@ -137656,7 +137632,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.file_search_call.searching"`
@@ -137666,23 +137642,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFunctionCallArgumentsDeltaEvent object { delta, item_id, output_index, 2 more }`
- 在出现部分函数调用参数的增量时触发。
+ 当存在部分函数调用参数的增量时发出。
- `delta: string`
- 新增的函数调用参数增量。
+ 添加的函数调用参数增量。
- `item_id: string`
- 函数调用参数增量所添加到的输出项的 ID。
+ 添加函数调用参数增量的输出项的 ID。
- `output_index: number`
- 函数调用参数增量所添加到的输出项的索引。
+ 添加函数调用参数增量的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.function_call_arguments.delta"`
@@ -137692,19 +137668,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFunctionCallArgumentsDoneEvent object { arguments, item_id, name, 3 more }`
- 在函数调用参数最终确定时发出。
+ 在函数调用参数被最终确定时发出。
- `arguments: string`
- 函数调用的参数。
+ 函数调用参数。
- `item_id: string`
- 项目的 ID。
+ 该项的 ID。
- `name: string`
- 被调用的函数名称。
+ 被调用的函数的名称。
- `output_index: number`
@@ -137712,7 +137688,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.function_call_arguments.done"`
@@ -137720,19 +137696,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseShellCallCommandAddedEvent object { command, command_index, output_index, 2 more }`
- 表示有 shell 命令被添加到工具调用中的流式事件。
+ 指示已将 shell 命令添加到工具调用的流式事件。
- `command: string`
- 被添加的 shell 命令。
+ 已添加的 shell 命令。
- `command_index: number`
- 被添加的 shell 命令的索引。
+ 已添加的 shell 命令的索引。
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -137740,25 +137716,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_command.added"`
- 事件的类型,始终为 `response.shell_call_command.added`.
+ 事件的类型,always `response.shell_call_command.added`.
- `"response.shell_call_command.added"`
- `ResponseShellCallCommandDeltaEvent object { command_index, delta, output_index, 3 more }`
- 表示 shell 命令已增量更新的流事件。
+ 表示 shell 命令被增量更新的流式事件。
- `command_index: number`
- 已更新的 shell 命令的索引。
+ 被更新的 shell 命令的索引。
- `delta: string`
- 已追加的 shell 命令增量内容。
+ 被追加的 shell 命令增量内容。
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -137766,17 +137742,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_command.delta"`
- 事件的类型,始终为 `response.shell_call_command.delta`.
+ 事件的类型,always `response.shell_call_command.delta`.
- `"response.shell_call_command.delta"`
- `obfuscation: optional string`
- 已添加用于填充事件负载的混淆字符串。
+ 为填充事件负载而添加的混淆字符串。
- `ResponseShellCallCommandDoneEvent object { command, command_index, output_index, 2 more }`
- 表示 shell 命令已完成的流式事件。
+ 指示 shell 命令已完成的流事件。
- `command: string`
@@ -137788,7 +137764,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -137796,13 +137772,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_command.done"`
- 事件的类型,始终为 `response.shell_call_command.done`.
+ 事件的类型,always `response.shell_call_command.done`.
- `"response.shell_call_command.done"`
- `ResponseShellCallOutputContentDeltaEvent object { command_index, delta, item_id, 3 more }`
- 指示 shell 调用输出被增量添加的流式事件。
+ 表示 shell 调用输出被增量添加的流事件。
- `command_index: number`
@@ -137826,7 +137802,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -137834,7 +137810,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_output_content.delta"`
- 事件的类型,始终为 `response.shell_call_output_content.delta`.
+ 事件的类型,always `response.shell_call_output_content.delta`.
- `"response.shell_call_output_content.delta"`
@@ -137856,21 +137832,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -137878,7 +137854,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -137892,11 +137868,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `output_index: number`
- 被更新的输出项的索引。
+ 已更新的输出项的索引。
- `sequence_number: number`
@@ -137904,7 +137880,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "response.shell_call_output_content.done"`
- 事件的类型,始终为 `response.shell_call_output_content.done`.
+ 事件的类型,always `response.shell_call_output_content.done`.
- `"response.shell_call_output_content.done"`
@@ -137918,7 +137894,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.in_progress"`
@@ -137928,15 +137904,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFailedEvent object { response, sequence_number, type }`
- 在响应失败时发出的事件。
+ 当 response 失败时发出的事件。
- `response: Response`
- 失败的响应。
+ 失败的 response。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.failed"`
@@ -137946,15 +137922,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseIncompleteEvent object { response, sequence_number, type }`
- 当响应以未完成状态结束时发出的事件。
+ 当响应以不完整状态结束时发出的事件。
- `response: Response`
- 未完成的响应。
+ 不完整的响应。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.incomplete"`
@@ -137968,18 +137944,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item: ResponseOutputItem`
- 被新增的输出项。对于推理项(reasoning items), `encrypted_content`
- 在该项仍在进行中时可能不完整。请使用对应事件中的推理项
- 来自 `response.output_item.done` 事件中的推理项,将其作为输入传入后续请求时使用。
- as input to a subsequent request.
+ 被添加的输出项。对于推理项, `encrypted_content`
+ 在项进行中时可能不完整。可使用相应
+ 事件中的推理项 `response.output_item.done` 在将其作为输入传递给后续请求时使用。
+ 后续请求的输入。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `FunctionCall object { arguments, call_id, name, 5 more }`
@@ -137991,8 +137967,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
@@ -138003,9 +137979,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `Program object { id, call_id, code, 2 more }`
@@ -138020,7 +137996,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `ImageGenerationCall object { id, result, status, type }`
@@ -138040,7 +138016,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `ShellCallOutput object { id, call_id, max_output_length, 5 more }`
@@ -138052,7 +138028,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `McpCall object { id, arguments, name, 6 more }`
@@ -138060,15 +138036,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `CustomToolCall object { call_id, input, name, 4 more }`
@@ -138078,11 +138054,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被新增的输出项的索引。
+ 被添加的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.output_item.added"`
@@ -138104,7 +138080,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.output_item.done"`
@@ -138114,37 +138090,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningSummaryPartAddedEvent object { item_id, output_index, part, 3 more }`
- 当添加新的推理摘要分块时触发。
+ 当新的推理摘要部分被添加时触发。
- `item_id: string`
- 与此摘要分块关联的项的 ID。
+ 与此摘要部分相关联的项目的 ID。
- `output_index: number`
- 与此摘要分块关联的输出项的索引。
+ 与此摘要部分相关联的输出项目的索引。
- `part: object { text, type }`
- 已添加的摘要分块。
+ 被添加的摘要部分。
- `text: string`
- 摘要分块的文本。
+ 摘要部分的文本。
- `type: "summary_text"`
- 摘要分块的类型。始终为 `summary_text`.
+ 摘要部分的类型。始终为 `summary_text`.
- `"summary_text"`
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `type: "response.reasoning_summary_part.added"`
@@ -138154,37 +138130,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningSummaryPartDoneEvent object { item_id, output_index, part, 4 more }`
- 在某个推理摘要分段完成时发出。
+ 在推理摘要部分完成时发出。
- `item_id: string`
- 与此摘要分块关联的项的 ID。
+ 与此摘要部分相关联的项目的 ID。
- `output_index: number`
- 与此摘要分块关联的输出项的索引。
+ 与此摘要部分相关联的输出项目的索引。
- `part: object { text, type }`
- 已完成的摘要分段。
+ 已完成的摘要部分。
- `text: string`
- 摘要分块的文本。
+ 摘要部分的文本。
- `type: "summary_text"`
- 摘要分块的类型。始终为 `summary_text`.
+ 摘要部分的类型。始终为 `summary_text`.
- `"summary_text"`
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `type: "response.reasoning_summary_part.done"`
@@ -138194,14 +138170,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "incomplete"`
- 摘要分段的完成状态。当该分段正常完成时省略,
- 并在生成被中断时设为 `incomplete` 。
+ 摘要部分的完成状态。在该部分正常完成时省略,
+ 在生成被中断时设置为 `incomplete` 。
- `"incomplete"`
- `ResponseReasoningSummaryTextDeltaEvent object { delta, item_id, output_index, 3 more }`
- 当向推理摘要文本添加增量时触发。
+ 当有增量被添加到推理摘要文本时触发。
- `delta: string`
@@ -138217,11 +138193,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `type: "response.reasoning_summary_text.delta"`
@@ -138235,23 +138211,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 该摘要文本所关联的条目的 ID。
+ 此摘要文本所关联条目的 ID。
- `output_index: number`
- 该摘要文本所关联的输出条目的索引。
+ 此摘要文本所关联输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `summary_index: number`
- 推理摘要中摘要分块的索引。
+ 推理摘要内此摘要部分的索引。
- `text: string`
- 已完成的推理摘要的全文。
+ 已完成的推理摘要的完整文本。
- `type: "response.reasoning_summary_text.done"`
@@ -138261,7 +138237,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningTextDeltaEvent object { content_index, delta, item_id, 3 more }`
- 当一个增量被添加到推理文本时发出。
+ 在向推理文本添加增量时发出。
- `content_index: number`
@@ -138281,7 +138257,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.reasoning_text.delta"`
@@ -138291,7 +138267,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseReasoningTextDoneEvent object { content_index, item_id, output_index, 3 more }`
- 当一段推理文本完成时触发。
+ 在推理文本完成时发出。
- `content_index: number`
@@ -138299,15 +138275,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 此推理文本所关联条目的 ID。
+ 与此推理文本关联的条目 ID。
- `output_index: number`
- 此推理文本所关联输出条目的索引。
+ 与此推理文本关联的输出条目索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `text: string`
@@ -138321,27 +138297,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseRefusalDeltaEvent object { content_index, delta, item_id, 3 more }`
- 当存在部分拒绝文本时触发。
+ 当存在部分拒绝文本时发出。
- `content_index: number`
- 被添加拒绝文本的内容部分的索引。
+ 拒绝文本所添加到的内容部分的索引。
- `delta: string`
- 被添加的拒绝文本。
+ 所添加的拒绝文本。
- `item_id: string`
- 被添加拒绝文本的输出项的 ID。
+ 拒绝文本所添加到的输出项的 ID。
- `output_index: number`
- 被添加拒绝文本的输出项的索引。
+ 拒绝文本所添加到的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.refusal.delta"`
@@ -138355,15 +138331,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `content_index: number`
- 拒绝文本最终确定所在内容部分的索引。
+ 拒绝文本最终确定时所对应的内容分片的索引。
- `item_id: string`
- 拒绝文本最终确定所在输出项的 ID。
+ 拒绝文本最终确定时所对应的输出项的 ID。
- `output_index: number`
- 拒绝文本最终确定所在输出项的索引。
+ 拒绝文本最终确定时所对应的输出项的索引。
- `refusal: string`
@@ -138371,7 +138347,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.refusal.done"`
@@ -138385,15 +138361,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `content_index: number`
- 被添加文本增量的内容部分的索引。
+ 文本增量所添加到的内容部分的索引。
- `delta: string`
- 被添加的文本增量。
+ 已添加的文本增量。
- `item_id: string`
- 被添加文本增量的输出项的 ID。
+ 文本增量所添加到的输出项的 ID。
- `logprobs: array of object { token, logprob, top_logprobs }`
@@ -138421,7 +138397,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被添加文本增量的输出项的索引。
+ 文本增量所添加到的输出项的索引。
- `sequence_number: number`
@@ -138435,15 +138411,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseTextDoneEvent object { content_index, item_id, logprobs, 4 more }`
- 在文本内容最终确定时发出。
+ 当文本内容最终确定时发出。
- `content_index: number`
- 文本内容最终确定所在的内容部分的索引。
+ 文本内容最终确定的内容部分的索引。
- `item_id: string`
- 文本内容最终确定所在的输出项的 ID。
+ 文本内容最终确定的输出项的 ID。
- `logprobs: array of object { token, logprob, top_logprobs }`
@@ -138471,7 +138447,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 文本内容最终确定所在的输出项的索引。
+ 文本内容最终确定的输出项的索引。
- `sequence_number: number`
@@ -138489,7 +138465,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseWebSearchCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在网页搜索调用完成时发出。
+ 当一次网页搜索调用完成时发出。
- `item_id: string`
@@ -138501,7 +138477,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 正在处理的网页搜索调用的序列号。
+ 正在处理的网页搜索调用的序号。
- `type: "response.web_search_call.completed"`
@@ -138511,7 +138487,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseWebSearchCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 在网页搜索调用发起时发出。
+ 当一次网页搜索调用被发起时发出。
- `item_id: string`
@@ -138523,7 +138499,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 正在处理的网页搜索调用的序列号。
+ 正在处理的网页搜索调用的序号。
- `type: "response.web_search_call.in_progress"`
@@ -138533,7 +138509,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseWebSearchCallSearchingEvent object { item_id, output_index, sequence_number, type }`
- 当 网页搜索 调用正在执行时触发。
+ 在网页搜索调用执行时发出。
- `item_id: string`
@@ -138545,7 +138521,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 正在处理的网页搜索调用的序列号。
+ 正在处理的网页搜索调用的序号。
- `type: "response.web_search_call.searching"`
@@ -138555,7 +138531,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseImageGenCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在图像生成工具调用已完成且最终图像可用时发出。
+ 当一个图像生成工具调用已完成且最终图像可用时发出。
- `item_id: string`
@@ -138567,7 +138543,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.image_generation_call.completed"`
@@ -138577,7 +138553,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseImageGenCallGeneratingEvent object { item_id, output_index, sequence_number, type }`
- 当图像生成工具调用正在主动生成图像时发出(中间状态)。
+ 当图像生成工具调用正在主动生成图像时触发(中间状态)。
- `item_id: string`
@@ -138599,7 +138575,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseImageGenCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 在图像生成工具调用进行中时发出。
+ 当图像生成工具调用进行中时发出。
- `item_id: string`
@@ -138621,7 +138597,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 7 more }`
- 在图像生成流式传输过程中,当有部分图像可用时发出。
+ 在图像生成流式传输过程中,当有部分图像可用时触发。
- `item_id: string`
@@ -138633,11 +138609,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_image_b64: string`
- Base64 编码的部分图像数据,适合直接渲染为图像。
+ Base64 编码的部分图像数据,可用于渲染为图像。
- `partial_image_index: number`
- 部分图像的基于 0 的索引(后端使用基于 1 的索引,但此处为面向用户的基于 0 的索引)。
+ 部分图像的从 0 开始的索引(后端使用从 1 开始的索引,但此处为面向用户的从 0 开始)。
- `sequence_number: number`
@@ -138667,15 +138643,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallArgumentsDeltaEvent object { delta, item_id, output_index, 2 more }`
- 当 MCP 工具调用的参数存在增量(部分更新)时触发。
+ 当 MCP 工具调用的参数存在 delta(部分更新)时发出。
- `delta: string`
- 包含 MCP 工具调用参数部分更新的 JSON 字符串。
+ 一个 JSON 字符串,包含 MCP 工具调用参数的部分更新。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的唯一标识符。
+ 正在处理的 MCP 工具调用项的唯一标识符。
- `output_index: number`
@@ -138683,25 +138659,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call_arguments.delta"`
- 事件类型。始终为 'response.mcp_call_arguments.delta'。
+ 事件的类型。始终为 'response.mcp_call_arguments.delta'。
- `"response.mcp_call_arguments.delta"`
- `ResponseMcpCallArgumentsDoneEvent object { arguments, item_id, output_index, 2 more }`
- 在 MCP 工具调用的参数最终确定时发出。
+ 当 MCP 工具调用的参数被最终确定时发出。
- `arguments: string`
- 一个 JSON 字符串,包含 MCP 工具调用最终确定的参数。
+ 一个 JSON 字符串,包含 MCP 工具调用的最终确定参数。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的唯一标识符。
+ 正在处理的 MCP 工具调用项的唯一标识符。
- `output_index: number`
@@ -138709,7 +138685,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call_arguments.done"`
@@ -138719,7 +138695,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 当 MCP 工具调用成功完成时发出。
+ 当 MCP 工具调用已成功完成时触发。
- `item_id: string`
@@ -138731,7 +138707,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call.completed"`
@@ -138741,7 +138717,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallFailedEvent object { item_id, output_index, sequence_number, type }`
- 在 MCP 工具调用失败时发出。
+ 当 MCP 工具调用失败时触发。
- `item_id: string`
@@ -138753,7 +138729,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call.failed"`
@@ -138763,11 +138739,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 当 MCP 工具调用正在进行时发出。
+ 在 MCP 工具调用进行中时发出。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的唯一标识符。
+ 正在处理的 MCP 工具调用项的唯一标识符。
- `output_index: number`
@@ -138775,7 +138751,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_call.in_progress"`
@@ -138785,7 +138761,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpListToolsCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在成功检索到可用 MCP 工具列表时发出。
+ 在成功检索到可用的 MCP 工具列表时发出。
- `item_id: string`
@@ -138797,7 +138773,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_list_tools.completed"`
@@ -138819,7 +138795,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_list_tools.failed"`
@@ -138829,19 +138805,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseMcpListToolsInProgressEvent object { item_id, output_index, sequence_number, type }`
- 系统正在检索可用 MCP 工具列表时触发。
+ 系统在检索可用 MCP 工具列表的过程中发出。
- `item_id: string`
- 正在处理的 MCP 工具调用条目的 ID。
+ 正在处理的 MCP 工具调用项的 ID。
- `output_index: number`
- 正在处理的输出条目的索引。
+ 正在处理的输出项的索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.mcp_list_tools.in_progress"`
@@ -138851,15 +138827,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputTextAnnotationAddedEvent object { annotation, annotation_index, content_index, 4 more }`
- 当注释被添加到输出文本内容时发出。
+ 当向输出文本内容添加批注时发出。
- `annotation: object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type } or null`
- 应用于一段输出文本的注释。
+ 应用于一段输出文本的批注。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -138867,11 +138843,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -138881,19 +138857,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -138903,7 +138879,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -138915,7 +138891,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -138923,11 +138899,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -138945,7 +138921,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -138955,15 +138931,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotation_index: number`
- 该注释在内容部分中的索引。
+ 内容片段中批注的索引。
- `content_index: number`
- 该内容部分在输出项中的索引。
+ 输出项中内容片段的索引。
- `item_id: string`
- 正在添加注释的项的唯一标识符。
+ 正在添加批注的项的唯一标识符。
- `output_index: number`
@@ -138971,7 +138947,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.output_text.annotation.added"`
@@ -138981,11 +138957,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseQueuedEvent object { response, sequence_number, type }`
- 当响应已加入队列并等待处理时发出。
+ 当响应被排队等待处理时发出。
- `response: Response`
- 已加入队列的完整响应对象。
+ 被排队的完整响应对象。
- `sequence_number: number`
@@ -138999,7 +138975,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseCustomToolCallInputDeltaEvent object { delta, item_id, output_index, 2 more }`
- 表示对自定义工具调用的输入的增量(部分更新)的事件。
+ 表示自定义工具调用的输入增量(部分更新)的事件。
- `delta: string`
@@ -139007,15 +138983,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 与此事件关联的 API 条目的唯一标识符。
+ 与此事件关联的 API 项的唯一标识符。
- `output_index: number`
- 此增量所应用的输出的索引。
+ 此增量所应用的输出索引。
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.custom_tool_call_input.delta"`
@@ -139033,7 +139009,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `item_id: string`
- 与此事件关联的 API 条目的唯一标识符。
+ 与此事件关联的 API 项的唯一标识符。
- `output_index: number`
@@ -139041,7 +139017,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 该事件的序列号。
+ 此事件的序列号。
- `type: "response.custom_tool_call_input.done"`
@@ -139049,35 +139025,35 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.custom_tool_call_input.done"`
-### Response Text Config
+### 响应文本配置
- `ResponseTextConfig object { format, verbosity }`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -139087,13 +139063,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -139109,22 +139085,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -139134,9 +139110,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -139145,7 +139121,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"high"`
-### Response Text Delta Event
+### 响应文本增量事件
- `ResponseTextDeltaEvent object { content_index, delta, item_id, 4 more }`
@@ -139153,15 +139129,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `content_index: number`
- 被添加文本增量的内容部分的索引。
+ 文本增量所添加到的内容部分的索引。
- `delta: string`
- 被添加的文本增量。
+ 已添加的文本增量。
- `item_id: string`
- 被添加文本增量的输出项的 ID。
+ 文本增量所添加到的输出项的 ID。
- `logprobs: array of object { token, logprob, top_logprobs }`
@@ -139189,7 +139165,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 被添加文本增量的输出项的索引。
+ 文本增量所添加到的输出项的索引。
- `sequence_number: number`
@@ -139201,19 +139177,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.output_text.delta"`
-### Response Text Done Event
+### 响应文本完成事件
- `ResponseTextDoneEvent object { content_index, item_id, logprobs, 4 more }`
- 在文本内容最终确定时发出。
+ 当文本内容最终确定时发出。
- `content_index: number`
- 文本内容最终确定所在的内容部分的索引。
+ 文本内容最终确定的内容部分的索引。
- `item_id: string`
- 文本内容最终确定所在的输出项的 ID。
+ 文本内容最终确定的输出项的 ID。
- `logprobs: array of object { token, logprob, top_logprobs }`
@@ -139241,7 +139217,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_index: number`
- 文本内容最终确定所在的输出项的索引。
+ 文本内容最终确定的输出项的索引。
- `sequence_number: number`
@@ -139257,12 +139233,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.output_text.done"`
-### Response Usage
+### 响应使用情况
- `ResponseUsage object { input_tokens, input_tokens_details, output_tokens, 3 more }`
- 表示 token 使用详情,包括输入 token、输出 token、
- 输出 token 的细分以及使用的总 token 数。
+ 表示 token 使用详情,包括输入 token、输出 token,
+ 的输出 token 明细,以及所使用的 token 总数。
- `input_tokens: number`
@@ -139270,7 +139246,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细细分。
+ 输入 token 的详细明细。
- `cache_write_tokens: number`
@@ -139279,7 +139255,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [关于 prompt caching 的更多信息](/docs/guides/prompt-caching).
+ [了解更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -139287,25 +139263,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细分类统计。
+ 输出令牌的详细明细。
- `reasoning_tokens: number`
- 推理 token 的数量。
+ 推理令牌的数量。
- `total_tokens: number`
- 使用的 token 总数。
+ 使用的令牌总数。
- `compute_units: optional number or null`
- 本次请求的计算单元。当前可用时为 null。
+ 该请求的计算单元。在可用时当前为 null。
-### Response Web Search Call Completed Event
+### 响应网页搜索调用完成事件
- `ResponseWebSearchCallCompletedEvent object { item_id, output_index, sequence_number, type }`
- 在网页搜索调用完成时发出。
+ 当一次网页搜索调用完成时发出。
- `item_id: string`
@@ -139317,7 +139293,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 正在处理的网页搜索调用的序列号。
+ 正在处理的网页搜索调用的序号。
- `type: "response.web_search_call.completed"`
@@ -139325,11 +139301,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.web_search_call.completed"`
-### Response Web Search Call In Progress Event
+### 响应网页搜索调用进行中事件
- `ResponseWebSearchCallInProgressEvent object { item_id, output_index, sequence_number, type }`
- 在网页搜索调用发起时发出。
+ 当一次网页搜索调用被发起时发出。
- `item_id: string`
@@ -139341,7 +139317,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 正在处理的网页搜索调用的序列号。
+ 正在处理的网页搜索调用的序号。
- `type: "response.web_search_call.in_progress"`
@@ -139349,11 +139325,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.web_search_call.in_progress"`
-### Response Web Search Call Searching Event
+### 响应网页搜索调用搜索中事件
- `ResponseWebSearchCallSearchingEvent object { item_id, output_index, sequence_number, type }`
- 当 网页搜索 调用正在执行时触发。
+ 在网页搜索调用执行时发出。
- `item_id: string`
@@ -139365,7 +139341,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `sequence_number: number`
- 正在处理的网页搜索调用的序列号。
+ 正在处理的网页搜索调用的序号。
- `type: "response.web_search_call.searching"`
@@ -139373,61 +139349,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"response.web_search_call.searching"`
-### Responses Client Event
+### Responses 客户端事件
- `ResponsesClientEvent object { type, background, context_management, 30 more }`
- `type: "response.create"`
- 客户端事件的类型。始终 `response.create`.
+ 客户端事件的类型。始终为 `response.create`.
- `"response.create"`
- `background: optional boolean or null`
是否在后台运行模型响应。
- [了解更多](/docs/guides/background).
+ [详细了解](/docs/guides/background).
- `context_management: optional array of object { type, compact_threshold } or null`
- 本次请求的上下文管理配置。
+ 此请求的上下文管理配置。
- `type: string`
- 上下文管理条目的类型。目前仅支持 'compaction'。
+ 上下文管理条目类型。目前仅支持 'compaction'。
- `compact_threshold: optional number or null`
- 触发该条目压缩的 token 阈值。
+ 应触发此条目压缩的 token 阈值。
- `conversation: optional string or ResponseConversationParam or null`
- 本次响应所属的会话。该会话中的条目会作为前缀拼接到 `input_items` 本次响应请求的前面。
- 本次响应完成后,本次响应中的输入条目和输出条目会自动添加到此会话中。
+ 此响应所属的对话。该对话中的条目会被添加到 `input_items` 此响应请求之前。
+ 此响应的输入条目和输出条目会在该响应完成后自动添加到此对话中。
- `ConversationID = string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
- `ResponseConversationParam object { id }`
- 本次响应所属的会话。
+ 此响应所属的对话。
- `id: string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
- `include: optional array of ResponseIncludable or null`
指定要在模型响应中包含的其他输出数据。目前支持的值包括:
- - `web_search_call.action.sources`: 包含 网页搜索 工具调用的来源。
- - `code_interpreter_call.outputs`: 在代码解释器工具调用条目中包含 Python 代码执行的输出。
- - `computer_call_output.output.image_url`: 包含来自 computer call 输出的图片 URL。
- - `file_search_call.results`: 包含 文件搜索 工具调用的搜索结果。
- - `message.input_image.image_url`: 包含来自输入消息的图片 URL。
- - `message.output_text.logprobs`: 在助手消息中包含 logprobs。
- - `reasoning.encrypted_content`: 在推理条目输出中包含加密版本的推理 token。这使得在无状态地使用 Responses API 时(例如当 `store` 参数被设置为 `false`,时,或当组织已加入零数据保留计划时),推理条目可以用于多轮对话。
+ - `web_search_call.action.sources`:包含 网页搜索 工具调用的来源。
+ - `code_interpreter_call.outputs`:在代码解释器工具调用条目中包含 Python 代码执行的输出。
+ - `computer_call_output.output.image_url`:包含来自计算机调用输出的图片 URL。
+ - `file_search_call.results`:包含 文件搜索 工具调用的搜索结果。
+ - `message.input_image.image_url`:包含来自输入消息的图片 URL。
+ - `message.output_text.logprobs`:在助手消息中包含 logprobs。
+ - `reasoning.encrypted_content`:在推理条目的输出中包含加密版本的推理 token。这使得在使用 Responses API 以无状态方式处理多轮对话时能够使用推理条目(例如 `store` 参数设置为 `false`,时,或组织已加入零数据留存计划时)。
- `"file_search_call.results"`
@@ -139449,9 +139425,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
提供给模型的文本、图片或文件输入,用于生成响应。
- 了解更多:
+ 了解详情:
- - [Text inputs and outputs](/docs/guides/text)
+ - [文本输入与输出](/docs/guides/text)
- [图像输入](/docs/guides/images)
- [文件输入](/docs/guides/pdf-files)
- [会话状态](/docs/guides/conversation-state)
@@ -139459,7 +139435,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `TextInput = string`
- 发送给模型的文本输入,等同于带有
+ 发送给模型的文本输入,相当于使用
`user` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
@@ -139469,57 +139445,57 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -139531,25 +139507,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -139559,13 +139535,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -139575,33 +139551,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -139614,9 +139590,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -139624,24 +139600,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -139651,8 +139627,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -139668,11 +139644,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -139680,15 +139656,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -139696,11 +139672,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -139710,19 +139686,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -139732,7 +139708,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -139744,7 +139720,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -139752,11 +139728,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -139774,7 +139750,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -139810,15 +139786,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -139830,8 +139806,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -139847,9 +139823,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -139857,7 +139833,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -139866,7 +139842,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -139885,20 +139861,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -139917,7 +139893,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -139934,7 +139910,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -139954,8 +139930,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -139971,15 +139947,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -139993,25 +139969,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -140019,7 +139995,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -140033,11 +140009,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -140056,7 +140032,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -140066,11 +140042,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -140098,7 +140074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -140130,15 +140106,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -140166,24 +140142,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -140207,26 +140183,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -140234,17 +140210,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -140260,7 +140236,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -140270,8 +140246,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -140279,12 +140255,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -140316,7 +140292,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -140330,7 +140306,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -140344,11 +140320,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -140360,7 +140336,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -140375,7 +140351,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -140417,8 +140393,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -140432,7 +140408,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -140440,61 +140416,61 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -140504,13 +140480,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -140524,23 +140500,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -140552,11 +140528,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -140584,15 +140560,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -140608,7 +140584,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -140646,11 +140622,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -140676,11 +140652,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -140688,7 +140664,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -140698,19 +140674,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -140719,9 +140695,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -140763,11 +140739,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -140781,7 +140757,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -140789,19 +140765,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -140809,25 +140785,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -140849,18 +140825,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -140868,22 +140844,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -140897,34 +140873,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -140942,36 +140918,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -141003,56 +140979,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -141060,26 +141036,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -141088,7 +141064,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -141098,7 +141074,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -141128,33 +141104,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -141170,7 +141146,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -141180,13 +141156,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -141196,11 +141172,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -141210,7 +141186,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -141218,22 +141194,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -141242,7 +141218,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -141257,7 +141233,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -141269,7 +141245,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -141280,7 +141256,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -141297,13 +141273,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -141347,13 +141323,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -141377,7 +141353,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -141393,7 +141369,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -141407,7 +141383,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -141415,13 +141391,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -141453,13 +141429,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -141469,7 +141445,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -141477,7 +141453,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -141491,7 +141467,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -141503,7 +141479,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -141513,7 +141489,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -141521,7 +141497,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -141543,7 +141519,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -141567,23 +141543,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -141591,7 +141567,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -141605,7 +141581,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -141617,17 +141593,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -141637,7 +141613,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -141649,11 +141625,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -141667,7 +141643,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -141677,37 +141653,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -141721,7 +141697,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -141755,21 +141731,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -141795,11 +141771,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -141807,7 +141783,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -141817,15 +141793,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -141833,7 +141809,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -141841,19 +141817,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -141861,25 +141837,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -141901,18 +141877,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -141920,22 +141896,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -141949,34 +141925,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -141994,36 +141970,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -142055,56 +142031,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -142112,26 +142088,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -142140,7 +142116,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -142150,7 +142126,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -142174,7 +142150,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -142190,7 +142166,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -142200,13 +142176,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -142216,11 +142192,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -142230,7 +142206,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -142238,22 +142214,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -142262,7 +142238,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -142277,7 +142253,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -142289,7 +142265,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -142300,7 +142276,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -142317,13 +142293,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -142371,7 +142347,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -142379,7 +142355,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -142393,7 +142369,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -142413,7 +142389,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -142437,23 +142413,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -142461,7 +142437,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -142475,7 +142451,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -142487,17 +142463,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -142507,7 +142483,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -142519,11 +142495,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -142537,7 +142513,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -142547,37 +142523,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -142591,19 +142567,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -142646,20 +142622,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -142669,7 +142645,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -142677,13 +142653,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -142711,7 +142687,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -142725,7 +142701,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -142734,7 +142710,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -142746,27 +142722,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -142780,7 +142756,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -142802,29 +142778,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -142838,7 +142814,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -142848,7 +142824,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -142856,13 +142832,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -142876,11 +142852,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -142888,7 +142864,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -142896,13 +142872,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -142938,7 +142914,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -142948,7 +142924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -142956,7 +142932,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -142964,45 +142940,45 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -143030,7 +143006,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -143044,11 +143020,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -143060,11 +143036,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -143078,7 +143054,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -143092,11 +143068,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -143106,7 +143082,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -143114,13 +143090,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -143152,11 +143128,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -143164,13 +143140,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -143198,11 +143174,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -143226,7 +143202,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -143234,21 +143210,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -143260,39 +143236,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -143304,11 +143280,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -143316,18 +143292,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -143363,7 +143339,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -143377,7 +143353,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -143398,11 +143374,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -143416,7 +143392,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -143456,7 +143432,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -143466,7 +143442,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -143490,7 +143466,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -143498,7 +143474,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -143512,11 +143488,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -143536,11 +143512,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -143552,15 +143528,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -143568,7 +143544,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
@@ -143576,32 +143552,32 @@ curl https://api.openai.com/v1/responses/resp_123 \
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- 响应中的指令不会被延续到下一个响应。这样可以轻松
- 在新响应中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,前一次
+ 响应的指令不会延续到下一次响应。这便于在新响应中
+ 替换系统(或开发者)消息。
- `max_output_tokens: optional number or null`
- 可在响应中生成的 token 数上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 一次响应中可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 单个响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非每个单独工具。模型后续任何进一步的工具调用尝试都将被忽略。
+ 响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `metadata: optional Metadata or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- 格式,并通过 API 或控制台查询对象。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 格式,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
- 最大长度为 512 个字符。
+ 键为字符串,最长 64 个字符。值为字符串
+ 最长 512 个字符。
- `model: optional ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供多种模型,它们在能力、性能
- 特征和价格方面各不相同。请参阅 [模型指南](/docs/models)
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI
+ 提供了多种不同能力、性能
+ 特性和定价的模型。请参阅 [模型指南](/docs/models)
以浏览和比较可用的模型。
- `string`
@@ -143820,15 +143796,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `model: string`
- 用于审核补全的审核模型,例如 'omni-moderation-latest'。
+ 用于受审核补全的审核模型,例如 'omni-moderation-latest'。
- `policy: optional object { input, output } or null`
- 应用于已审核响应输入和输出的策略。
+ 应用于受审核响应输入和输出的策略。
- `input: optional object { mode } or null`
- 响应输入的审核策略。
+ 用于响应输入的审核策略。
- `mode: "score" or "block"`
@@ -143838,7 +143814,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: optional object { mode } or null`
- 响应输出的审核策略。
+ 用于响应输出的审核策略。
- `mode: "score" or "block"`
@@ -143852,14 +143828,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。用它来
- 创建多轮对话。了解更多关于
- [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 模型上一次响应的唯一 ID。使用它来
+ 创建多轮对话。了解有关
+ [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
对提示模板及其变量的引用。
- [了解更多](/docs/guides/text?api-mode=responses#reusable-prompts).
+ [详细了解](/docs/guides/text?api-mode=responses#reusable-prompts).
- `id: string`
@@ -143867,19 +143843,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你的
+ 用于替换提示模板中变量的可选值映射,
prompt。替换值可以是字符串,也可以是其他
- Response 输入类型,例如图片或文件。
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -143891,15 +143867,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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"`
@@ -143907,24 +143883,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 此字段表示最大保留策略,而
- `prompt_cache_options.ttl` 表示最小缓存生命周期。这两个
- 字段相互独立,不会相互影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来的模型,仅 `24h` 。
+ 提示词缓存的保留策略。设置为 `24h` 以启用扩展提示词缓存,使缓存前缀保持更长时间,最长可达 24 小时。 [详细了解](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最长保留策略,而
+ `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"`
@@ -143932,19 +143908,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型**
-
- 针对
+ 配置选项,适用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -143955,13 +143929,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -143979,11 +143953,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -143993,17 +143967,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -144011,11 +143985,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -144025,21 +143999,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -144062,67 +144036,67 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `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).
- 请参阅下方 [流式传输部分](/docs/api-reference/responses-streaming)
+ 如果设置为 true,模型响应数据将流式传输到客户端
+ ,使用 [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+ 参见下方 [流式传输部分](/docs/api-reference/responses-streaming)
了解更多信息。
- `stream_id: optional string`
- 此响应的 WebSocket 通道。具有相同
- `stream_id` 的请求按 FIFO 顺序处理,并且该响应的事件会回显相同的
- 相同 `stream_id`.
+ 此响应所使用的 WebSocket 通道。请求若使用相同的
+ `stream_id` 则会按 FIFO 顺序处理,且响应的事件会回显该
+ 相同的 `stream_id`.
- `stream_id` 用于控制路由; `previous_response_id` 用于控制
- 会话血缘,因此可以从在另一个通道上创建的响应派生出新通道
- 。
+ `stream_id` 控制路由; `previous_response_id` 控制
+ 对话谱系,以便新通道可以从在另一条通道上创建的响应分叉
+ 出来。
- `stream_options: optional object { include_obfuscation } or null`
- 流式响应选项。仅在设置 stream: true 时设置此参数。 `stream: true`.
+ 用于流式响应选项。仅当你设置了 `stream: true`.
- `include_obfuscation: optional boolean`
- 如果为 true,将启用流混淆。流混淆会向流式 delta 事件上的 obfuscation 字段添加
- 随机字符,以 `obfuscation` 帮助防止某些浏览器在响应完成前被截断。
+ 为 true 时,将启用流混淆。流混淆会向流式增量事件上的
+ 字段添加 `obfuscation` 随机字符
将载荷大小归一化,作为对某些侧信道攻击的缓解措施。
- 这些混淆字段默认会包含在内,但会给数据流带来少量
- 开销。如果你的应用程序与 OpenAI API 之间的网络链路可信,你可以设置 `include_obfuscation` 设为
- 为 false 以优化带宽。
- 为 false 以优化带宽。
+ 默认会包含这些混淆字段,但会为数据流带来少量
+ 开销。你可以将 `include_obfuscation` 设置为
+ 设为 false 以优化带宽,前提是你信任应用与
+ OpenAI API 之间的网络链路。
- `temperature: optional number or null`
- 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
- 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
+ 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议修改此参数或 `top_p` 但不要同时修改两者。
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -144132,13 +144106,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -144154,22 +144128,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -144179,9 +144153,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -144192,15 +144166,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tool_choice: optional ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成时应如何选择要使用的工具(或多个工具)。请参阅
- 响应时使用的工具。请参阅如何指定哪些工具 `tools` 参数以了解如何指定要使用的工具
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -144215,14 +144189,14 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -144292,7 +144266,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -144362,31 +144336,31 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置来指定要使用的工具, `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展
- 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
[内置工具](/docs/guides/tools).
- - **MCP 工具**: 通过自定义 MCP 服务与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。详细了解
+ - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive 和 SharePoint 等预定义连接器。详细了解
[MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数和返回值调用你自己的代码。详细了解
- 。你还可以使用
- [function calling](/docs/guides/function-calling)。你也可以使用
- 自定义工具来调用你自己的代码。
+ - **函数调用(自定义工具)**:由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码。详细了解
+ 。你也可以使用
+ [function calling](/docs/guides/function-calling)。你还可以使用
+ 自定义工具调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -144412,11 +144386,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -144424,7 +144398,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -144434,15 +144408,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -144450,7 +144424,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -144458,19 +144432,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -144478,25 +144452,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -144518,18 +144492,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -144537,22 +144511,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -144566,34 +144540,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -144611,36 +144585,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -144672,56 +144646,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -144729,26 +144703,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -144757,7 +144731,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -144767,7 +144741,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -144791,7 +144765,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -144807,7 +144781,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -144817,13 +144791,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -144833,11 +144807,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -144847,7 +144821,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -144855,22 +144829,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -144879,7 +144853,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -144894,7 +144868,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -144906,7 +144880,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -144917,7 +144891,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -144934,13 +144908,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -144988,7 +144962,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -144996,7 +144970,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -145010,7 +144984,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -145030,7 +145004,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -145054,23 +145028,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -145078,7 +145052,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -145092,7 +145066,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -145104,17 +145078,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -145124,7 +145098,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -145136,11 +145110,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -145154,7 +145128,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -145164,37 +145138,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -145208,19 +145182,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能 token 数,每个 token 附带一个对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最大最可能
+ token 数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
- 请求的数量。
- 请求的数量。
+ 所请求的数量。
- `top_p: optional number or null`
- temperature 采样的替代方法,称为核采样,
- 即模型考虑 top_p 概率质量范围内的标记结果。
- 因此 0.1 表示只考虑构成前 10% 概率质量的标记。
- 。
+ 一种名为核采样的温度采样替代方案,
+ 其中模型会考虑 top_p 概率质量排名前列的词元结果。
+ 因此,0.1 表示仅考虑构成前 10% 概率质量的词元。
+ 会被考虑。
- 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不要同时修改两者。
- `truncation: optional "auto" or "disabled" or null`
@@ -145228,8 +145202,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `auto`:如果此 Response 的输入超过
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -145238,9 +145212,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user: optional string`
- 该字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
- 面向你的最终用户的稳定标识符。
- 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化效果。
+ 用于标识你的最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶以提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [详细了解](/docs/guides/safety-best-practices#safety-identifiers).
### Responses 服务端事件
@@ -145250,12 +145224,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseAudioWsDelta = ResponseAudioDeltaEvent`
- 当存在部分音频响应时发出。
+ 当出现部分音频响应时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseAudioWsDone = ResponseAudioDoneEvent`
@@ -145264,8 +145238,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseAudioTranscriptWsDelta = ResponseAudioTranscriptDeltaEvent`
@@ -145274,38 +145248,38 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseAudioTranscriptWsDone = ResponseAudioTranscriptDoneEvent`
- 在整个音频转录完成时发出。
+ 当完整音频转写完成时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCodeInterpreterCallCodeWsDelta = ResponseCodeInterpreterCallCodeDeltaEvent`
- 当代码解释器流式输出部分代码片段时触发。
+ 当代码解释器流式传输出部分代码片段时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCodeInterpreterCallCodeWsDone = ResponseCodeInterpreterCallCodeDoneEvent`
- 当代码片段由代码解释器完成时发出。
+ 当代码解释器最终确定代码片段时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCodeInterpreterCallWsCompleted = ResponseCodeInterpreterCallCompletedEvent`
@@ -145314,28 +145288,28 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCodeInterpreterCallInWsProgress = ResponseCodeInterpreterCallInProgressEvent`
- 当一次代码解释器调用正在进行时触发。
+ 当代码解释器调用正在进行时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCodeInterpreterCallWsInterpreting = ResponseCodeInterpreterCallInterpretingEvent`
- 在代码解释器正在积极解释代码片段时发出。
+ 当代码解释器正在主动解释代码片段时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWsCompleted = ResponseCompletedEvent`
@@ -145344,48 +145318,48 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseContentPartWsAdded = ResponseContentPartAddedEvent`
- 当新增内容片段时发出。
+ 在新增内容部分时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseContentPartWsDone = ResponseContentPartDoneEvent`
- 在内容片段完成时发出。
+ 当某个内容部分完成时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWsCreated = ResponseCreatedEvent`
- 在响应被创建时发出的事件。
+ 在创建响应时发出的事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseFileSearchCallWsCompleted = ResponseFileSearchCallCompletedEvent`
- 在文件搜索调用完成时发出(已找到结果)。
+ 在文件搜索调用完成(找到结果)时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseFileSearchCallInWsProgress = ResponseFileSearchCallInProgressEvent`
@@ -145394,78 +145368,78 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseFileSearchCallWsSearching = ResponseFileSearchCallSearchingEvent`
- 在文件搜索正在执行搜索时发出。
+ 在文件搜索正在执行检索时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseFunctionCallArgumentsWsDelta = ResponseFunctionCallArgumentsDeltaEvent`
- 在出现部分函数调用参数的增量时触发。
+ 当存在部分函数调用参数的增量时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseFunctionCallArgumentsWsDone = ResponseFunctionCallArgumentsDoneEvent`
- 在函数调用参数最终确定时发出。
+ 在函数调用参数被最终确定时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseShellCallCommandWsAdded = ResponseShellCallCommandAddedEvent`
- 表示有 shell 命令被添加到工具调用中的流式事件。
+ 指示已将 shell 命令添加到工具调用的流式事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseShellCallCommandWsDelta = ResponseShellCallCommandDeltaEvent`
- 表示 shell 命令已增量更新的流事件。
+ 表示 shell 命令被增量更新的流式事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseShellCallCommandWsDone = ResponseShellCallCommandDoneEvent`
- 表示 shell 命令已完成的流式事件。
+ 指示 shell 命令已完成的流事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseShellCallOutputContentWsDelta = ResponseShellCallOutputContentDeltaEvent`
- 指示 shell 调用输出被增量添加的流式事件。
+ 表示 shell 调用输出被增量添加的流事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseShellCallOutputContentWsDone = ResponseShellCallOutputContentDoneEvent`
@@ -145474,8 +145448,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseInWsProgress = ResponseInProgressEvent`
@@ -145484,28 +145458,28 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWsFailed = ResponseFailedEvent`
- 在响应失败时发出的事件。
+ 当 response 失败时发出的事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWsIncomplete = ResponseIncompleteEvent`
- 当响应以未完成状态结束时发出的事件。
+ 当响应以不完整状态结束时发出的事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseOutputItemWsAdded = ResponseOutputItemAddedEvent`
@@ -145514,8 +145488,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseOutputItemWsDone = ResponseOutputItemDoneEvent`
@@ -145524,38 +145498,38 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseReasoningSummaryPartWsAdded = ResponseReasoningSummaryPartAddedEvent`
- 当添加新的推理摘要分块时触发。
+ 当新的推理摘要部分被添加时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseReasoningSummaryPartWsDone = ResponseReasoningSummaryPartDoneEvent`
- 在某个推理摘要分段完成时发出。
+ 在推理摘要部分完成时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseReasoningSummaryTextWsDelta = ResponseReasoningSummaryTextDeltaEvent`
- 当向推理摘要文本添加增量时触发。
+ 当有增量被添加到推理摘要文本时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseReasoningSummaryTextWsDone = ResponseReasoningSummaryTextDoneEvent`
@@ -145564,38 +145538,38 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseReasoningTextWsDelta = ResponseReasoningTextDeltaEvent`
- 当一个增量被添加到推理文本时发出。
+ 在向推理文本添加增量时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseReasoningTextWsDone = ResponseReasoningTextDoneEvent`
- 当一段推理文本完成时触发。
+ 在推理文本完成时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseRefusalWsDelta = ResponseRefusalDeltaEvent`
- 当存在部分拒绝文本时触发。
+ 当存在部分拒绝文本时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseRefusalWsDone = ResponseRefusalDoneEvent`
@@ -145604,8 +145578,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseTextWsDelta = ResponseTextDeltaEvent`
@@ -145614,148 +145588,148 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseTextWsDone = ResponseTextDoneEvent`
- 在文本内容最终确定时发出。
+ 当文本内容最终确定时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWebSearchCallWsCompleted = ResponseWebSearchCallCompletedEvent`
- 在网页搜索调用完成时发出。
+ 当一次网页搜索调用完成时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWebSearchCallInWsProgress = ResponseWebSearchCallInProgressEvent`
- 在网页搜索调用发起时发出。
+ 当一次网页搜索调用被发起时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWebSearchCallWsSearching = ResponseWebSearchCallSearchingEvent`
- 当 网页搜索 调用正在执行时触发。
+ 在网页搜索调用执行时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseImageGenCallWsCompleted = ResponseImageGenCallCompletedEvent`
- 在图像生成工具调用已完成且最终图像可用时发出。
+ 当一个图像生成工具调用已完成且最终图像可用时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseImageGenCallWsGenerating = ResponseImageGenCallGeneratingEvent`
- 当图像生成工具调用正在主动生成图像时发出(中间状态)。
+ 当图像生成工具调用正在主动生成图像时触发(中间状态)。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseImageGenCallInWsProgress = ResponseImageGenCallInProgressEvent`
- 在图像生成工具调用进行中时发出。
+ 当图像生成工具调用进行中时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseImageGenCallPartialWsImage = ResponseImageGenCallPartialImageEvent`
- 在图像生成流式传输过程中,当有部分图像可用时发出。
+ 在图像生成流式传输过程中,当有部分图像可用时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpCallArgumentsWsDelta = ResponseMcpCallArgumentsDeltaEvent`
- 当 MCP 工具调用的参数存在增量(部分更新)时触发。
+ 当 MCP 工具调用的参数存在 delta(部分更新)时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpCallArgumentsWsDone = ResponseMcpCallArgumentsDoneEvent`
- 在 MCP 工具调用的参数最终确定时发出。
+ 当 MCP 工具调用的参数被最终确定时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpCallWsCompleted = ResponseMcpCallCompletedEvent`
- 当 MCP 工具调用成功完成时发出。
+ 当 MCP 工具调用已成功完成时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpCallWsFailed = ResponseMcpCallFailedEvent`
- 在 MCP 工具调用失败时发出。
+ 当 MCP 工具调用失败时触发。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpCallInWsProgress = ResponseMcpCallInProgressEvent`
- 当 MCP 工具调用正在进行时发出。
+ 在 MCP 工具调用进行中时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpListToolsWsCompleted = ResponseMcpListToolsCompletedEvent`
- 在成功检索到可用 MCP 工具列表时发出。
+ 在成功检索到可用的 MCP 工具列表时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpListToolsWsFailed = ResponseMcpListToolsFailedEvent`
@@ -145764,48 +145738,48 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseMcpListToolsInWsProgress = ResponseMcpListToolsInProgressEvent`
- 系统正在检索可用 MCP 工具列表时触发。
+ 系统在检索可用 MCP 工具列表的过程中发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseOutputTextAnnotationWsAdded = ResponseOutputTextAnnotationAddedEvent`
- 当注释被添加到输出文本内容时发出。
+ 当向输出文本内容添加批注时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWsQueued = ResponseQueuedEvent`
- 当响应已加入队列并等待处理时发出。
+ 当响应被排队等待处理时发出。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCustomToolCallInputWsDelta = ResponseCustomToolCallInputDeltaEvent`
- 表示对自定义工具调用的输入的增量(部分更新)的事件。
+ 表示自定义工具调用的输入增量(部分更新)的事件。
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseCustomToolCallInputWsDone = ResponseCustomToolCallInputDoneEvent`
@@ -145814,17 +145788,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源事件提供
- 源事件时存在 `response.create` 事件提供了
+ 发出此事件的 WebSocket 通道。该字段在以下情况下存在
+ 当原始 `response.create` 事件提供了
`stream_id`.
- `ResponseWsError object { error, type, sequence_number, 2 more }`
- 在处理 Responses WebSocket 请求时发生错误时发出。
+ 在处理 Responses WebSocket 请求过程中发生错误时发出。
- `error: object { code, message, param, 2 more }`
- 有关该错误的详细信息。
+ 有关错误的详细信息。
- `code: string or null`
@@ -145832,19 +145806,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `message: string`
- 已发出的、可读的面向用户的消息。
+ 已发出的、人类可读的错误消息。
- `param: string or null`
- 与该错误关联的参数名称(如果有)。
+ 与此错误关联的参数名称(若有)。
- `type: string`
- 已发出的错误类型。
+ 发出的错误类型。
- `headers: optional map[string]`
- 随错误一起发出的响应头(如果有)。
+ 与此错误一同发出的响应头(若有)。
- `type: "error"`
@@ -145862,23 +145836,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `stream_id: optional string`
- 发出此事件的 WebSocket 通道。该字段在源
- 事件提供时存在 `response.create` 事件提供了 `stream_id`.
+ 发出该事件的 WebSocket 通道。当以下情况时会出现此字段:
+ 原始 `response.create` 事件提供了 `stream_id`.
-### Service Tier
+### 服务等级
- `ServiceTier = "auto" or "default" or "flex" or 4 more`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。
- - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数,适用于 Responses 或 Chat Completions。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级当前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
+ - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
+ - 要在请求级别选择启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 `service_tier=fast` 或 `service_tier=priority` 参数用于 Responses 或 Chat Completions。响应将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
+ - 如果未设置,默认行为是 'auto'。
- 当 `service_tier` 参数被设置时,响应主体将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置 `service_tier` 参数时,响应正文将包含基于实际用于处理该请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -145894,7 +145868,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"ultrafast"`
-### Skill Reference
+### 技能参考
- `SkillReference object { skill_id, type, version }`
@@ -145910,20 +145884,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
-### Tool Choice Allowed
+### 工具选择可用
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -145951,7 +145925,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"allowed_tools"`
-### Tool Choice Apply Patch
+### 工具选择 Apply Patch
- `ToolChoiceApplyPatch object { type }`
@@ -145963,7 +145937,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"apply_patch"`
-### Tool Choice Custom
+### 工具选择 Custom
- `ToolChoiceCustom object { name, type }`
@@ -145979,7 +145953,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"custom"`
-### Tool Choice Function
+### 工具选择 Function
- `ToolChoiceFunction object { name, type }`
@@ -145987,7 +145961,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -145995,7 +145969,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"function"`
-### Tool Choice Mcp
+### 工具选择 Mcp
- `ToolChoiceMcp object { server_label, type, name }`
@@ -146015,13 +145989,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
要在服务器上调用的工具的名称。
-### Tool Choice Options
+### 工具选择选项
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -146034,7 +146008,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"required"`
-### Tool Choice Shell
+### 工具选择 Shell
- `ToolChoiceShell object { type }`
@@ -146046,7 +146020,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"shell"`
-### Tool Choice Types
+### 工具选择类型
- `ToolChoiceTypes object { type }`
@@ -146084,9 +146058,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `"code_interpreter"`
-# Input Items
+# 输入项
-## List input items
+## 列出输入项
**get** `/responses/{response_id}/input_items`
@@ -146100,12 +146074,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `after: optional string`
- 在分页中使用的项目 ID,用于列出其之后的项目。
+ 分页时用于列出其后各项的项 ID。
- `include: optional array of ResponseIncludable`
- 响应中要包含的附加字段。有关更多信息,请参阅上文 Response 创建中的 `include`
- 参数。
+ 要在响应中包含的其他字段。详见上方 `include`
+ 参数的 Response 创建部分以了解更多信息。
- `"file_search_call.results"`
@@ -146125,15 +146099,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `limit: optional number`
- 要返回的对象数量上限。限制范围介于
+ 返回对象数量的上限。Limit 的取值范围介于
1 到 100 之间,默认值为 20。
- `order: optional "asc" or "desc"`
- 返回输入项目的顺序。默认为 `desc`.
+ 输入项的返回顺序。默认值为 `desc`.
- - `asc`: 按升序返回输入项目。
- - `desc`: 按降序返回输入项目。
+ - `asc`: 按升序返回输入项。
+ - `desc`: 按降序返回输入项。
- `"asc"`
@@ -146143,11 +146117,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseItemList object { data, first_id, has_more, 2 more }`
- Response 项目列表。
+ Response 项的列表。
- `data: array of ResponseInputMessageItem or ResponseOutputMessage or object { id, queries, status, 2 more } or 26 more`
- 用于生成此响应的项目列表。
+ 用于生成此响应的项列表。
- `ResponseInputMessageItem object { id, content, role, 2 more }`
@@ -146157,40 +146131,40 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -146202,25 +146176,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -146230,13 +146204,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -146246,33 +146220,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -146288,8 +146262,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -146299,11 +146273,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -146311,15 +146285,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -146327,11 +146301,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -146341,19 +146315,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -146363,7 +146337,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -146375,7 +146349,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -146383,11 +146357,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -146405,7 +146379,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -146441,15 +146415,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -146461,8 +146435,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -146478,9 +146452,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -146488,7 +146462,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -146497,7 +146471,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -146516,20 +146490,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -146548,7 +146522,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -146565,7 +146539,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -146585,8 +146559,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -146602,15 +146576,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -146624,25 +146598,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -146650,7 +146624,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -146664,11 +146638,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -146687,7 +146661,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -146697,11 +146671,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -146729,7 +146703,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -146761,15 +146735,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -146797,24 +146771,24 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -146844,22 +146818,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -146867,8 +146841,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -146880,13 +146854,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -146903,12 +146877,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -146916,12 +146890,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -146953,7 +146927,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -146967,7 +146941,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -146981,11 +146955,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -146997,7 +146971,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -147013,7 +146987,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -147021,8 +146995,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -147058,7 +147032,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `namespace: optional string`
@@ -147081,15 +147055,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -147097,8 +147071,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -147114,7 +147088,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -147142,15 +147116,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `ToolSearchCall object { id, arguments, call_id, 4 more }`
@@ -147176,7 +147150,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -147186,13 +147160,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -147214,7 +147188,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -147224,15 +147198,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -147258,11 +147232,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -147270,7 +147244,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -147280,19 +147254,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -147301,9 +147275,9 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -147345,11 +147319,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -147363,7 +147337,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -147371,19 +147345,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -147391,25 +147365,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -147431,18 +147405,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -147450,22 +147424,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -147479,34 +147453,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -147524,36 +147498,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -147585,56 +147559,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -147642,26 +147616,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -147670,7 +147644,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -147680,7 +147654,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -147710,33 +147684,33 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -147752,7 +147726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -147762,13 +147736,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -147778,11 +147752,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -147792,7 +147766,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -147800,22 +147774,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -147824,7 +147798,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -147839,7 +147813,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -147851,7 +147825,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -147862,7 +147836,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -147879,13 +147853,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -147929,13 +147903,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -147959,7 +147933,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -147975,7 +147949,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -147989,7 +147963,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -147997,13 +147971,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -148035,13 +148009,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -148051,7 +148025,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -148059,7 +148033,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -148073,7 +148047,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -148085,7 +148059,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -148095,7 +148069,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -148103,7 +148077,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -148125,7 +148099,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -148149,23 +148123,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -148173,7 +148147,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -148187,7 +148161,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -148199,17 +148173,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -148219,7 +148193,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -148231,11 +148205,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -148249,7 +148223,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -148259,37 +148233,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -148303,23 +148277,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -148339,15 +148313,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -148373,11 +148347,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -148385,7 +148359,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -148395,15 +148369,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -148411,7 +148385,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -148419,19 +148393,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -148439,25 +148413,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -148479,18 +148453,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -148498,22 +148472,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -148527,34 +148501,34 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -148572,36 +148546,36 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -148633,56 +148607,56 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -148690,26 +148664,26 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -148718,7 +148692,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -148728,7 +148702,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -148752,7 +148726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -148768,7 +148742,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -148778,13 +148752,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -148794,11 +148768,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -148808,7 +148782,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -148816,22 +148790,22 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -148840,7 +148814,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -148855,7 +148829,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -148867,7 +148841,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -148878,7 +148852,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -148895,13 +148869,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -148949,7 +148923,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -148957,7 +148931,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -148971,7 +148945,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -148991,7 +148965,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -149015,23 +148989,23 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -149039,7 +149013,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -149053,7 +149027,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -149065,17 +149039,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -149085,7 +149059,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -149097,11 +149071,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -149115,7 +149089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -149125,37 +149099,37 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -149169,15 +149143,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -149220,20 +149194,20 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -149257,11 +149231,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -149273,15 +149247,15 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -149289,13 +149263,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -149303,17 +149277,17 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -149341,7 +149315,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -149355,7 +149329,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -149364,7 +149338,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -149376,27 +149350,27 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -149410,7 +149384,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -149432,29 +149406,29 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -149468,7 +149442,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -149478,7 +149452,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -149486,13 +149460,13 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -149502,25 +149476,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -149554,7 +149528,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -149564,7 +149538,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -149598,7 +149572,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -149610,25 +149584,25 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -149636,7 +149610,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -149650,11 +149624,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -149690,7 +149664,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -149698,11 +149672,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -149718,11 +149692,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -149732,7 +149706,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -149750,7 +149724,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -149760,7 +149734,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -149768,7 +149742,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -149798,19 +149772,19 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -149818,7 +149792,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -149844,7 +149818,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -149852,7 +149826,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -149876,7 +149850,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -149884,21 +149858,21 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -149910,39 +149884,39 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -149954,11 +149928,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -149966,18 +149940,18 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -150013,7 +149987,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -150029,7 +150003,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `id: string`
- 自定义工具调用项目的唯一 ID。
+ 自定义工具调用项的唯一 ID。
- `call_id: string`
@@ -150041,12 +150015,12 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -150082,11 +150056,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -150113,11 +150087,11 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -150125,8 +150099,8 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -150166,7 +150140,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `first_id: string`
@@ -150174,7 +150148,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
- `has_more: boolean`
- 是否有更多可用项目。
+ 是否还有更多项可用。
- `last_id: string`
@@ -150193,7 +150167,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID/input_items \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -150229,7 +150203,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -150259,11 +150233,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseItemList object { data, first_id, has_more, 2 more }`
- Response 项目列表。
+ Response 项的列表。
- `data: array of ResponseInputMessageItem or ResponseOutputMessage or object { id, queries, status, 2 more } or 26 more`
- 用于生成此响应的项目列表。
+ 用于生成此响应的项列表。
- `ResponseInputMessageItem object { id, content, role, 2 more }`
@@ -150273,40 +150247,40 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -150318,25 +150292,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -150346,13 +150320,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -150362,33 +150336,33 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -150404,8 +150378,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -150415,11 +150389,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -150427,15 +150401,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -150443,11 +150417,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -150457,19 +150431,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -150479,7 +150453,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -150491,7 +150465,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -150499,11 +150473,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -150521,7 +150495,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -150557,15 +150531,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -150577,8 +150551,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -150594,9 +150568,9 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -150604,7 +150578,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -150613,7 +150587,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -150632,20 +150606,20 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -150664,7 +150638,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -150681,7 +150655,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -150701,8 +150675,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -150718,15 +150692,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -150740,25 +150714,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -150766,7 +150740,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -150780,11 +150754,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -150803,7 +150777,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -150813,11 +150787,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -150845,7 +150819,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -150877,15 +150851,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -150913,24 +150887,24 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -150960,22 +150934,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -150983,8 +150957,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -150996,13 +150970,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告并已被
+ 由 API 报告的、已被
开发者确认的安全检查。
- `id: string`
@@ -151019,12 +150993,12 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -151032,12 +151006,12 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -151069,7 +151043,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -151083,7 +151057,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -151097,11 +151071,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -151113,7 +151087,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -151129,7 +151103,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -151137,8 +151111,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -151174,7 +151148,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `namespace: optional string`
@@ -151197,15 +151171,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -151213,8 +151187,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -151230,7 +151204,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -151258,15 +151232,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `name: optional string`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `ToolSearchCall object { id, arguments, call_id, 4 more }`
@@ -151292,7 +151266,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -151302,13 +151276,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "tool_search_call"`
- 项目的类型。始终为 `tool_search_call`.
+ 条目的类型,恒为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -151330,7 +151304,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -151340,15 +151314,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -151374,11 +151348,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -151386,7 +151360,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -151396,19 +151370,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -151417,9 +151391,9 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -151461,11 +151435,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -151479,7 +151453,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -151487,19 +151461,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -151507,25 +151481,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -151547,18 +151521,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -151566,22 +151540,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -151595,34 +151569,34 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -151640,36 +151614,36 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -151701,56 +151675,56 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -151758,26 +151732,26 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -151786,7 +151760,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -151796,7 +151770,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -151826,33 +151800,33 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -151868,7 +151842,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -151878,13 +151852,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -151894,11 +151868,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -151908,7 +151882,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -151916,22 +151890,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -151940,7 +151914,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -151955,7 +151929,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -151967,7 +151941,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -151978,7 +151952,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -151995,13 +151969,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -152045,13 +152019,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -152075,7 +152049,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -152091,7 +152065,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -152105,7 +152079,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -152113,13 +152087,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -152151,13 +152125,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -152167,7 +152141,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -152175,7 +152149,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -152189,7 +152163,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -152201,7 +152175,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -152211,7 +152185,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -152219,7 +152193,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -152241,7 +152215,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -152265,23 +152239,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -152289,7 +152263,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -152303,7 +152277,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -152315,17 +152289,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -152335,7 +152309,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -152347,11 +152321,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -152365,7 +152339,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -152375,37 +152349,37 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -152419,23 +152393,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "tool_search_output"`
- 项目的类型。始终为 `tool_search_output`.
+ 条目的类型,恒为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -152455,15 +152429,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -152489,11 +152463,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -152501,7 +152475,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -152511,15 +152485,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -152527,7 +152501,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -152535,19 +152509,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -152555,25 +152529,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -152595,18 +152569,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -152614,22 +152588,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -152643,34 +152617,34 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -152688,36 +152662,36 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -152749,56 +152723,56 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -152806,26 +152780,26 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -152834,7 +152808,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -152844,7 +152818,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -152868,7 +152842,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -152884,7 +152858,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -152894,13 +152868,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -152910,11 +152884,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -152924,7 +152898,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -152932,22 +152906,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -152956,7 +152930,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -152971,7 +152945,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -152983,7 +152957,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -152994,7 +152968,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -153011,13 +152985,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -153065,7 +153039,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -153073,7 +153047,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -153087,7 +153061,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -153107,7 +153081,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -153131,23 +153105,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -153155,7 +153129,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -153169,7 +153143,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -153181,17 +153155,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -153201,7 +153175,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -153213,11 +153187,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -153231,7 +153205,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -153241,37 +153215,37 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -153285,15 +153259,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "additional_tools"`
- 项目的类型。始终为 `additional_tools`.
+ 条目的类型,恒为 `additional_tools`.
- `"additional_tools"`
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -153336,20 +153310,20 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -153373,11 +153347,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项目的类型。始终为 `program`.
+ 条目的类型,恒为 `program`.
- `"program"`
@@ -153389,15 +153363,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终态。
+ 程序输出条目的终止状态。
- `"completed"`
@@ -153405,13 +153379,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "program_output"`
- 项目的类型。始终为 `program_output`.
+ 条目的类型,恒为 `program_output`.
- `"program_output"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -153419,17 +153393,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `encrypted_content: string`
- 由压缩生成的加密内容。
+ 由压缩产生的加密内容。
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -153457,7 +153431,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -153471,7 +153445,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -153480,7 +153454,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -153492,27 +153466,27 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -153526,7 +153500,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -153548,29 +153522,29 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -153584,7 +153558,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -153594,7 +153568,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -153602,13 +153576,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -153618,25 +153592,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回结果的最大字符数(可选)。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 命令的超时时间(毫秒,可选)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
@@ -153670,7 +153644,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -153680,7 +153654,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
@@ -153714,7 +153688,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -153726,25 +153700,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块对应的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
@@ -153752,7 +153726,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
@@ -153766,11 +153740,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -153806,7 +153780,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -153814,11 +153788,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: string`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -153834,11 +153808,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `path: string`
- 要创建的文件的路径。
+ 要创建的文件路径。
- `type: "create_file"`
- 使用提供的差异创建一个新文件。
+ 使用提供的差异创建新文件。
- `"create_file"`
@@ -153848,7 +153822,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `path: string`
- 要删除的文件的路径。
+ 要删除的文件路径。
- `type: "delete_file"`
@@ -153866,7 +153840,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `path: string`
- 要更新的文件的路径。
+ 要更新的文件路径。
- `type: "update_file"`
@@ -153876,7 +153850,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -153884,7 +153858,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -153914,19 +153888,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用产生的输出。
+ apply patch 工具调用所发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -153934,7 +153908,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -153960,7 +153934,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
@@ -153968,7 +153942,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -153992,7 +153966,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -154000,21 +153974,21 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -154026,39 +154000,39 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { id, approval_request_id, approve, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `id: string`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -154070,11 +154044,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -154082,18 +154056,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -154129,7 +154103,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -154145,7 +154119,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: string`
- 自定义工具调用项目的唯一 ID。
+ 自定义工具调用项的唯一 ID。
- `call_id: string`
@@ -154157,12 +154131,12 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -154198,11 +154172,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -154229,11 +154203,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -154241,8 +154215,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -154282,7 +154256,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `created_by: optional string`
- 创建该条目的参与者的标识符。
+ 创建该条目的行为者的标识符。
- `first_id: string`
@@ -154290,7 +154264,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `has_more: boolean`
- 是否有更多可用项目。
+ 是否还有更多项可用。
- `last_id: string`
@@ -154302,34 +154276,34 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `"list"`
-# 输入 Tokens
+# 输入令牌
-## 获取输入 token 计数
+## 获取输入令牌计数
**post** `/responses/input_tokens`
返回请求的输入 token 计数。
-返回一个对象,其中 `object` 设置为 `response.input_tokens` 以及一个 `input_tokens` 计数。
+返回一个对象,其中包含 `object` 设置为 `response.input_tokens` 以及一个 `input_tokens` 计数。
-### 正文参数
+### 请求体参数
- `conversation: optional string or ResponseConversationParam or null`
- 本次响应所属的会话。该会话中的条目会作为前缀拼接到 `input_items` 本次响应请求的前面。
- 本次响应完成后,本次响应中的输入条目和输出条目会自动添加到此会话中。
+ 此响应所属的对话。该对话中的条目会被添加到 `input_items` 此响应请求之前。
+ 此响应的输入条目和输出条目会在该响应完成后自动添加到此对话中。
- `ConversationID = string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
- `ResponseConversationParam object { id }`
- 本次响应所属的会话。
+ 此响应所属的对话。
- `id: string`
- 该会话的唯一 ID。
+ 对话的唯一 ID。
- `input: optional string or array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more or null`
@@ -154337,65 +154311,65 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `string`
- 发送给模型的文本输入,等同于带有 `user` 角色的文本输入。
+ 发送给模型的文本输入,相当于使用 `user` 角色的文本输入。
- `array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 由一个或多个输入项组成的列表,发送给模型,包含不同的内容类型。
+ 包含一个或多个输入条目的列表,用于模型,包含不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
- `content: string or ResponseInputMessageContentList`
- 发给模型的文本、图像或音频输入,用于生成响应。
- 也可以包含之前的助手响应。
+ Text, image, or audio input to the model, used to generate a response.
+ Can also contain previous assistant responses.
- `TextInput = string`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `"low"`
@@ -154407,25 +154381,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -154435,13 +154409,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -154451,33 +154425,33 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色。可选值为 `user`, `assistant`, `system`, or
`developer`.
- `"user"`
@@ -154490,9 +154464,9 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -154500,24 +154474,24 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 的层级关系。使用 `developer` 或 `system` 角色给出的指令
+ 发送给模型的消息输入,其角色表示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色给出的指令具有
precedence over instructions given with the `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 包含不同内容类型的一个或多个发给模型的输入项的列表
+ A list of one or many input items to the model, containing different content
types.
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色。可选值为 `user`, `system`, or `developer`.
- `"user"`
@@ -154527,8 +154501,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。可选值为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -154544,11 +154518,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 模型输出的消息。
+ 来自模型的一条输出消息。
- `id: string`
- 输出消息的唯一 ID。
+ 该输出消息的唯一 ID。
- `content: array of ResponseOutputText or ResponseOutputRefusal`
@@ -154556,15 +154530,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的文本输出。
+ 模型生成的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
- 文本输出的注释。
+ 该文本输出的注解。
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对某个文件的引用。
- `file_id: string`
@@ -154572,11 +154546,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -154586,19 +154560,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网络资源的引用。
+ 用于生成模型响应的网页资源的引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中该 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中该 URL 引用第一个字符的索引。
- `title: string`
- 网络资源的标题。
+ 该网页资源的标题。
- `type: "url_citation"`
@@ -154608,7 +154582,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `url: string`
- 网络资源的 URL。
+ 该网页资源的 URL。
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
@@ -154620,7 +154594,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中该容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -154628,11 +154602,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `filename: string`
- 所引用的容器文件的文件名。
+ 被引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用内容的起始字符索引。
- `type: "container_file_citation"`
@@ -154650,7 +154624,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -154686,15 +154660,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝内容。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
- 拒绝回复的类型。始终为 `refusal`.
+ 拒绝内容的类型。始终为 `refusal`.
- `"refusal"`
@@ -154706,8 +154680,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -154723,9 +154697,9 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `phase: optional "commentary" or "final_answer" or null`
- 将一条 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- )。对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
- 阶段于所有助手消息中——省略该字段可能导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段信息于所有助手消息中——省略它可能会降低性能。不会用于用户消息。
- `"commentary"`
@@ -154733,7 +154707,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。请参阅
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -154742,7 +154716,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
@@ -154761,20 +154735,20 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "file_search_call"`
- 文件搜索工具调用的类型。始终为 `file_search_call`.
+ 文件搜索 工具调用的类型。始终为 `file_search_call`.
- `"file_search_call"`
- `results: optional array of object { attributes, file_id, filename, 2 more } or null`
- 文件搜索工具调用的结果。
+ 文件搜索 工具调用的结果。
- `attributes: optional map[string or number or boolean] or null`
- 可以附加到对象的 16 个键值对。可用于
- 以结构化格式存储有关对象的附加信息,并通过
- API 或仪表板查询对象。键是字符串,
- 最大长度为 64 个字符。值是字符串,最大
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储有关对象的附加信息,并通过 API 或仪表板
+ 查询对象。键为字符串,最大
+ 长度为 64 个字符。值为字符串,最大
长度为 512 个字符、布尔值或数字。
- `string`
@@ -154793,7 +154767,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score: optional number`
- 文件的相关性评分,取值介于 0 和 1 之间。
+ 文件的相关性评分,取值范围为 0 到 1。
- `text: optional string`
@@ -154810,7 +154784,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 在向工具调用返回输出时使用的标识符。
+ 在响应工具调用并提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -154830,8 +154804,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -154847,15 +154821,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `action: optional ComputerAction`
- 单击动作。
+ 点击操作。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在单击期间按下了哪个鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下了哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`, or `forward`.
- `"left"`
@@ -154869,25 +154843,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "click"`
- 指定事件类型。对于单击动作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `keys: array of string or null`
@@ -154895,7 +154869,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -154909,11 +154883,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
```
[
@@ -154932,7 +154906,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -154942,11 +154916,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
- `type: "keypress"`
@@ -154974,7 +154948,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `keys: optional array of string or null`
- 移动鼠标时按住的按键。
+ 移动鼠标时按住的键。
- `Screenshot object { type }`
@@ -155006,15 +154980,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `x: number`
- 发生滚动的 x 坐标。
+ 发生滚动位置的 x 坐标。
- `y: number`
- 发生滚动的 y 坐标。
+ 发生滚动位置的 y 坐标。
- `keys: optional array of string or null`
- 滚动时按住的按键。
+ 滚动时按住的键。
- `Type object { text, type }`
@@ -155042,24 +155016,24 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `actions: optional ComputerActionList`
- 扁平化批处理操作,用于 `computer_use`。每个操作都包含一个
- `type` 判别字段以及特定于该操作的字段。
+ 批量操作的扁平化形式, `computer_use`。每个操作包含一个
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击动作。
+ 点击操作。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -155083,26 +155057,26 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- 计算机工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的 computer 工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机截图图像。
+ 与 computer use 工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,该属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -155110,17 +155084,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_call_output"`
- 计算机工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终为 `computer_call_output`.
- `"computer_call_output"`
- `id: optional string or null`
- 计算机工具调用输出的 ID。
+ computer 工具调用输出的 ID。
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 所报告的安全检查。
+ 已被开发者确认的 API 所报告的安全检查结果。
- `id: string`
@@ -155136,7 +155110,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回输入项时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`, or `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -155146,8 +155120,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
@@ -155155,12 +155129,12 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索调用中所执行具体操作的对象。
+ 描述此次 网页搜索调用中所执行具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索查询。
+ 操作类型 "search" — 执行一次 网页搜索 查询。
- `type: "search"`
@@ -155192,7 +155166,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 动作类型 "open_page" - 打开搜索结果中的某个特定 URL。
- `type: "open_page"`
@@ -155206,7 +155180,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -155220,11 +155194,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索工具调用的状态。
+ 网页搜索 工具调用的状态。
- `"in_progress"`
@@ -155236,7 +155210,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
@@ -155251,7 +155225,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -155293,8 +155267,8 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -155308,7 +155282,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -155316,61 +155290,61 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `text: string`
- 发给模型的文本输入。
+ The text input to the model.
- `type: "input_text"`
- 输入项的类型。始终为 `input_text`.
+ The type of the input item. Always `input_text`.
- `"input_text"`
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision)
+ An image input to the model. Learn about [image inputs](/docs/guides/vision)
- `type: "input_image"`
- 输入项的类型。始终为 `input_image`.
+ The type of the input item. Always `input_image`.
- `"input_image"`
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `image_url: optional string or null`
- 要发送给模型的图片的 URL。可以使用完整的 URL 或 data URL 中的 base64 编码图片。
+ 发送给模型的图片的 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -155380,13 +155354,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "input_file"`
- 输入项的类型。始终为 `input_file`.
+ The type of the input item. Always `input_file`.
- `"input_file"`
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或者使用 `high` 以更高的质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的使用量。使用 `low` 以获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -155400,23 +155374,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_id: optional string or null`
- 发送给模型的文件的 ID。
+ The ID of the file to be sent to the model.
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
+ Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.
- `mode: "explicit"`
- 断点模式。始终为 `explicit`.
+ The breakpoint mode. Always `explicit`.
- `"explicit"`
@@ -155428,11 +155402,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -155460,15 +155434,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: optional string or null`
- 生成输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -155484,7 +155458,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "tool_search_call"`
- 项类型。始终为 `tool_search_call`.
+ 条目类型。始终为 `tool_search_call`.
- `"tool_search_call"`
@@ -155522,11 +155496,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -155552,11 +155526,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -155564,7 +155538,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -155574,19 +155548,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 要与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
@@ -155595,9 +155569,9 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `eq`:等于
- `ne`:不等于
- `gt`:大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
+ - `lte`: 小于或等于
- `in`: 包含
- `nin`: 不包含
@@ -155639,11 +155613,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。数组项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `unknown`
@@ -155657,7 +155631,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -155665,19 +155639,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -155685,25 +155659,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -155725,18 +155699,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -155744,22 +155718,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -155773,34 +155747,34 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -155818,36 +155792,36 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -155879,56 +155853,56 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -155936,26 +155910,26 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -155964,7 +155938,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -155974,7 +155948,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -156004,33 +155978,33 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_domains: array of string`
- 当 type 为时允许的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域名的出站网络访问。始终 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 针对白名单域的可选域范围密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与密钥关联的域。
- `name: string`
- 为该域名注入的密钥名称。
+ 要注入到该域的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 要注入到该域的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -156046,7 +156020,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -156056,13 +156030,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -156072,11 +156046,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -156086,7 +156060,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -156094,22 +156068,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -156118,7 +156092,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -156133,7 +156107,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -156145,7 +156119,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -156156,7 +156130,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -156173,13 +156147,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -156223,13 +156197,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "container_auto"`
- 自动为本次请求创建容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -156253,7 +156227,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `skills: optional array of SkillReference or InlineSkill`
- 按 id 引用或内联引用的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -156269,7 +156243,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认版本。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -156283,7 +156257,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -156291,13 +156265,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能来源的类型。必须为 `base64`.
+ 内联技能源的类型。必须为 `base64`.
- `"base64"`
@@ -156329,13 +156303,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `path: string`
- 指向包含该技能的目录的路径。
+ 包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
- `container_id: string`
- 被引用容器的 ID。
+ 所引用的容器的 ID。
- `type: "container_reference"`
@@ -156345,7 +156319,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -156353,7 +156327,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -156367,7 +156341,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -156379,7 +156353,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Text object { type }`
- 无约束的自由格式文本。
+ 无约束的任意形式文本。
- `type: "text"`
@@ -156389,7 +156363,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Grammar object { definition, syntax, type }`
- 用户定义的语法。
+ 由用户定义的语法。
- `definition: string`
@@ -156397,7 +156371,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法。取值之一为 `lark` 或 `regex`.
- `"lark"`
@@ -156419,7 +156393,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -156443,23 +156417,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -156467,7 +156441,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -156481,7 +156455,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -156493,17 +156467,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -156513,7 +156487,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -156525,11 +156499,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -156543,7 +156517,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -156553,37 +156527,37 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -156597,7 +156571,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "tool_search_output"`
- 项类型。始终为 `tool_search_output`.
+ 条目类型。始终为 `tool_search_output`.
- `"tool_search_output"`
@@ -156631,21 +156605,21 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供其他工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 此条目中提供的额外工具列表。
+ 此项目提供的其他工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -156671,11 +156645,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -156683,7 +156657,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -156693,15 +156667,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -156709,7 +156683,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -156717,19 +156691,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -156737,25 +156711,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -156777,18 +156751,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -156796,22 +156770,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -156825,34 +156799,34 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -156870,36 +156844,36 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -156931,56 +156905,56 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -156988,26 +156962,26 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -157016,7 +156990,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -157026,7 +157000,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -157050,7 +157024,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -157066,7 +157040,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -157076,13 +157050,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -157092,11 +157066,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -157106,7 +157080,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -157114,22 +157088,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -157138,7 +157112,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -157153,7 +157127,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -157165,7 +157139,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -157176,7 +157150,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -157193,13 +157167,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -157247,7 +157221,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -157255,7 +157229,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -157269,7 +157243,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -157289,7 +157263,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -157313,23 +157287,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -157337,7 +157311,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -157351,7 +157325,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -157363,17 +157337,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -157383,7 +157357,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -157395,11 +157369,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -157413,7 +157387,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -157423,37 +157397,37 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -157467,19 +157441,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "additional_tools"`
- 项类型。始终为 `additional_tools`.
+ 条目类型。始终为 `additional_tools`.
- `"additional_tools"`
- `id: optional string or null`
- 此额外工具条目的唯一 ID。
+ 此其他工具项目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成响应时所使用的思维链的描述
- 。请务必将这些条目包含在你的 `input` 到 Responses API
- 用于在手动
+ 推理模型在生成
+ 响应时所使用的思维链的描述。请务必将这些项目包含在你的 `input` 到 Responses API
+ 用于在手动管理上下文时后续轮次的对话
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -157522,20 +157496,20 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此字段,
- 用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充该字段,
+ 用于由返回的推理条目 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件中的
- 。后续请求中的 `encrypted_content` 可能
- `response.output_item.added` 不完整。这一点在
- 在以下情况下尤为重要: `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 在流式传输时,请使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 在后续请求中使用。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。尤其是在
+ 重要场景:在以下情况下尤为重要 `store` 是 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回条目时填充该字段。
+ 条目的状态。取值之一为 `in_progress`, `completed`, or
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -157545,7 +157519,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -157553,13 +157527,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "compaction"`
- 项目的类型。始终为 `compaction`.
+ 条目的类型,恒为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩项的 ID。
+ 压缩条目的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -157587,7 +157561,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation_call"`
- 图像生成调用的类型。始终为 `image_generation_call`.
+ 图像生成调用的类型,恒为 `image_generation_call`.
- `"image_generation_call"`
@@ -157601,7 +157575,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `code: string or null`
- 要运行的代码,如果不可用则为 null。
+ 要运行的代码,若不可用则为 null。
- `container_id: string`
@@ -157610,7 +157584,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 如果无可用输出,可以为 null。
- `Logs object { logs, type }`
@@ -157622,27 +157596,27 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "logs"`
- 输出的类型。始终为 `logs`.
+ 输出的类型。Always `logs`.
- `"logs"`
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
- 输出的类型。始终为 `image`.
+ 输出的类型。Always `image`.
- `"image"`
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`: 默认:auto, 和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -157656,7 +157630,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "code_interpreter_call"`
- 代码解释器工具调用的类型。始终为 `code_interpreter_call`.
+ 代码解释器工具调用的类型。Always `code_interpreter_call`.
- `"code_interpreter_call"`
@@ -157678,29 +157652,29 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `env: map[string]`
- 为该命令设置的环境变量。
+ 要为命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型。始终为 `exec`.
+ 本地 shell 操作的类型。Always `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行该命令所用的可选用户。
+ 运行命令时使用的可选用户。
- `working_directory: optional string or null`
- 运行该命令所在的可选工作目录。
+ 运行命令时使用的可选工作目录。
- `call_id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -157714,7 +157688,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "local_shell_call"`
- 本地 shell 调用的类型。始终为 `local_shell_call`.
+ 本地 shell 调用的类型。Always `local_shell_call`.
- `"local_shell_call"`
@@ -157724,7 +157698,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: string`
- 由模型生成的本地 shell 工具调用的唯一 ID。
+ 模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -157732,13 +157706,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。Always `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ 条目的状态。取值之一为 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -157752,11 +157726,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 供执行环境运行的有序 shell 命令。
- `max_output_length: optional number or null`
@@ -157764,7 +157738,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的墙钟时间上限(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
@@ -157772,13 +157746,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "shell_call"`
- 项目的类型。始终为 `shell_call`.
+ 条目的类型,恒为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -157814,7 +157788,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态,取值之一 `in_progress`, `completed`, or `incomplete`.
- `"in_progress"`
@@ -157824,7 +157798,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用发出的流式输出条目。
+ shell 工具调用发出的流式输出项。
- `call_id: string`
@@ -157832,7 +157806,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 与 stderr 输出块,以及它们关联的结果。
+ stdout 和 stderr 输出的捕获块及其关联结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -157840,45 +157814,45 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Timeout object { type }`
- 表示该 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
- 结果类型。始终为 `timeout`.
+ 结果类型,恒为 `timeout`.
- `"timeout"`
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已完成并返回了退出码。
- `exit_code: number`
- 由 shell 进程返回的退出码。
+ shell 进程返回的退出码。
- `type: "exit"`
- 结果类型。始终为 `exit`.
+ 结果类型,恒为 `exit`.
- `"exit"`
- `stderr: string`
- 针对该 shell 调用捕获的 stderr 输出。
+ shell 调用捕获的 stderr 输出。
- `stdout: string`
- 针对该 shell 调用捕获的 stdout 输出。
+ shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
- 项目的类型。始终为 `shell_call_output`.
+ 条目的类型,恒为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -157906,7 +157880,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `max_output_length: optional number or null`
- 针对该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -157920,11 +157894,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的工具调用。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -157936,11 +157910,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `diff: string`
- 创建文件时应用的 unified diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待创建文件路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -157954,7 +157928,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `path: string`
- 相对于工作区根目录的待删除文件路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -157968,11 +157942,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `diff: string`
- 应用到现有文件的 unified diff 内容。
+ 要应用于现有文件的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的待更新文件路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -157982,7 +157956,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -157990,13 +157964,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "apply_patch_call"`
- 项目的类型。始终为 `apply_patch_call`.
+ 条目的类型,恒为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -158028,11 +158002,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
- `"completed"`
@@ -158040,13 +158014,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "apply_patch_call_output"`
- 项目的类型。始终为 `apply_patch_call_output`.
+ 条目的类型,恒为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
+ apply patch 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -158074,11 +158048,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用工具的列表。
+ MCP 服务器上可用的工具列表。
- `id: string`
@@ -158102,7 +158076,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 有关该工具的附加注解。
- `description: optional string or null`
@@ -158110,21 +158084,21 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "mcp_list_tools"`
- 项目的类型。始终为 `mcp_list_tools`.
+ 条目的类型,恒为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 如果服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具时返回的错误信息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工批准工具调用。
- `id: string`
- 审批请求的唯一 ID。
+ 批准请求的唯一 ID。
- `arguments: string`
@@ -158136,39 +158110,39 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 项目的类型。始终为 `mcp_approval_request`.
+ 条目的类型,恒为 `mcp_approval_request`.
- `"mcp_approval_request"`
- `McpApprovalResponse object { approval_request_id, approve, type, 2 more }`
- 对 MCP 审批请求的响应。
+ 对 MCP 批准请求的响应。
- `approval_request_id: string`
- 所回答的审批请求的 ID。
+ 正在回复的批准请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 项目的类型。始终为 `mcp_approval_response`.
+ 条目的类型,恒为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 批准响应的唯一 ID
- `reason: optional string or null`
- 该决策的可选原因。
+ 可选的决策原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -158180,11 +158154,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给该工具的参数。
- `name: string`
- 所运行工具的名称。
+ 已运行的工具名称。
- `server_label: string`
@@ -158192,18 +158166,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "mcp_call"`
- 项目的类型。始终为 `mcp_call`.
+ 条目的类型,恒为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中传入此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -158239,7 +158213,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.
- `"in_progress"`
@@ -158253,7 +158227,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,将被发送回模型。
+ 由你的代码生成的自定义工具调用输出,将被发送回模型。
- `call_id: string`
@@ -158274,11 +158248,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 发给模型的文本输入。
+ A text input to the model.
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发给模型的图像输入。了解有关 [image inputs](/docs/guides/vision).
+ An image input to the model. Learn about [image inputs](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -158292,7 +158266,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: optional string`
- OpenAI 平台中该自定义工具调用输出的唯一 ID。
+ 自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -158332,7 +158306,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 正在调用的自定义工具的名称。
+ 被调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -158342,7 +158316,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台上的唯一 ID。
+ OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -158366,7 +158340,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `namespace: optional string`
- 正在调用的自定义工具的命名空间。
+ 被调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -158374,7 +158348,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "compaction_trigger"`
- 项目的类型。始终为 `compaction_trigger`.
+ 条目的类型,恒为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -158388,11 +158362,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `id: string`
- 要引用的条目的 ID。
+ 要引用的条目 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -158412,11 +158386,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `fingerprint: string`
- 必须往返透传的不透明程序重放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
- 项类型。始终为 `program`.
+ 条目类型。始终为 `program`.
- `"program"`
@@ -158428,15 +158402,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的最终状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -158444,18 +158418,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "program_output"`
- 项类型。始终为 `program_output`.
+ 条目类型。始终为 `program_output`.
- `"program_output"`
- `instructions: optional string or null`
插入到模型上下文中的系统(或开发者)消息。
- 与 `previous_response_id`,一起使用时,上一次响应中的指令不会延续到下一次响应。这便于在新响应中替换系统(或开发者)消息。
+ 与 `previous_response_id`,配合使用时,上一次响应中的指令不会延续到下一次响应。这样可以方便地在新响应中替换系统(或开发者)消息。
- `model: optional string or null`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`. OpenAI 提供多种不同能力、性能特征和价格水平的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
+ 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`. OpenAI 提供一系列具有不同能力、性能特征和价格点的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
- `parallel_tool_calls: optional boolean or null`
@@ -158463,13 +158437,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `personality: optional string or "friendly" or "pragmatic"`
- 要应用于本次请求的模型自有风格预设。省略此参数将使用模型的默认风格。支持的取值可能会随时间增加。值的长度不得超过 64 个字符。
+ 应用于本次请求的模型自有风格预设。省略此参数将使用模型的默认风格。支持的值可能会随时间扩展。值的长度不得超过 64 个字符。
- `string`
- `"friendly" or "pragmatic"`
- 要应用于本次请求的模型自有风格预设。省略此参数将使用模型的默认风格。支持的取值可能会随时间增加。值的长度不得超过 64 个字符。
+ 应用于本次请求的模型自有风格预设。省略此参数将使用模型的默认风格。支持的值可能会随时间扩展。值的长度不得超过 64 个字符。
- `"friendly"`
@@ -158477,20 +158451,20 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `previous_response_id: optional string or null`
- 上一次模型响应的唯一 ID。使用它可以创建多轮对话。了解更多关于 [conversation state](/docs/guides/conversation-state)。不能同时使用 `conversation`.
+ 上一次模型响应的唯一 ID。使用此 ID 可以创建多轮对话。详细了解 [对话状态](/docs/guides/conversation-state)。的更多信息。不能与 `conversation`.
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o-series 模型** 针对 [推理模型](https://platform.openai.com/docs/guides/reasoning).
+ **仅适用于 gpt-5 和 o-series 模型** 配置选项,适用于 [推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续回合中回传给模型的推理项。
- 若省略或设置为 `auto`,由模型决定上下文模式。
- `gpt-5.6` 模型族默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中呈现回模型的推理项。
+ 如果省略或设置为 `auto`,则由模型确定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 在响应中返回时,表示本次响应实际使用的推理上下文模式
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
。
- `"auto"`
@@ -158501,13 +158475,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `effort: optional ReasoningEffort or null`
- 用于约束推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`: 默认:auto, 和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中用于推理的 token 数量。并非所有推理
- 模型都支持每一个取值。请参阅
+ 限制推理模型在推理上的投入程度。当前支持的值
+ 包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中推理所用的 token 数。并非所有推理模型都支持每个
+ 值。请参阅
推理指南
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解模型对各取值的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -158525,11 +158499,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已废弃:** 请使用 `summary` 改为使用。
+ **已弃用:** 请使用 `summary` 相反。
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `"auto"`
@@ -158539,17 +158513,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `mode: optional string or "standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 用于控制本次请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,表示本次响应实际使用的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -158557,11 +158531,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型所执行推理的摘要,可用于调试和理解模型的
- 推理过程。
- 取值为 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这可用于调试和理解模型的推理过程。取值之一
+ 可用于调试和理解模型的推理过程。
+ 取值为 `auto`, `concise`, or `detailed`.
- `concise` 适用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型 `computer-use-preview` 以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -158571,31 +158545,31 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `text: optional object { format, verbosity } or null`
- 模型文本响应的配置选项。可以是纯
- 文本或结构化 JSON 数据。了解更多:
+ 用于配置模型文本响应的选项。可以是纯文本,也可以是结构化的 JSON 数据。详见:
+ 文本输入与输出:
- - [Text inputs and outputs](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [文本输入与输出](/docs/guides/text)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个用于指定模型必须输出的格式的对象。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 这会确保模型匹配你提供的 JSON schema。详见
- [Structured Outputs guide](/docs/guides/structured-outputs).
+ 设置为 `{ "type": "json_schema" }` 时,将启用结构化输出,
+ 功能,从而确保模型的输出与你提供的 JSON schema 相匹配。详见
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含其他选项。
+ 默认的格式为 `{ "type": "text" }` ,且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不建议在 gpt-4o 及更新模型上使用:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,
- 该模式确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用该格式。
- `ResponseFormatText object { type }`
- 默认响应格式。用于生成文本响应。
+ 默认的响应格式。用于生成文本响应。
- `type: "text"`
@@ -158605,13 +158579,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
- 下划线和短横线,且最大长度为 64。
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 下划线和连字符,最大长度为 64。
- `schema: map[unknown]`
@@ -158627,22 +158601,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `description: optional string`
响应格式用途的描述,供模型用于
- 决定如何以该格式进行响应。
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的 schema 遵循。
+ 是否在生成输出时启用严格的 schema 一致性。
如果设置为 true,模型将始终遵循
- 字段中定义的 `schema` 确切 schema。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请参阅 [结构化输出
+ 字段中 `schema` 定义的精确 schema。仅支持 JSON Schema 的一个子集,当
+ `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应方法。
- 对于支持 `json_schema` 的模型,建议使用。请注意,如果没有系统或用户消息指示,
- 模型将不会生成 JSON。
- 以指示其这样做。
+ JSON 对象响应格式。一种较早的生成 JSON 响应的方法。
+ 使用 `json_schema` 对支持它的模型是推荐的做法。请注意
+ 模型在没有系统或用户消息指示的情况下不会生成
+ JSON。
- `type: "json_object"`
@@ -158652,9 +158626,9 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的回复,而更高的值会导致更冗长的回复。
- 目前支持的值包括 `low`, `medium`: 默认:auto, 和 `high`。默认值为
+ 约束模型响应的详细程度。较低的值会产生
+ 更简洁的响应,较高的值会产生更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -158665,13 +158639,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `tool_choice: optional ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more or null`
- 用于控制模型应使用的工具(若有)。
+ 控制模型应使用的工具(若有)。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不会调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息或调用一个或
多个工具之间进行选择。
@@ -158686,14 +158660,14 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的集合。
- `auto` 允许模型从允许的工具中进行选择并生成
- 一条消息。
+ `auto` 允许模型从允许的工具中进行选择并生成一条
+ 消息。
`required` 要求模型调用一个或多个允许的工具。
@@ -158763,7 +158737,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -158833,15 +158807,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more or null`
- 模型在生成响应时可以调用的工具列表。你可以通过设置 `tool_choice` 参数。
+ 模型在生成响应时可以调用的工具数组。你可以通过设置以下项来指定要使用的工具: `tool_choice` 参数来指定要使用的工具。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个模型可以选择调用的函数。详细了解 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -158867,11 +158841,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否被延迟加载并通过 tool search 加载。
+ 此函数是否延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -158879,7 +158853,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -158889,15 +158863,15 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库的 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的过滤器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用已定义的比较操作将指定属性键与给定值进行比较的过滤器。
+ 用于将某个指定的属性键与给定值按定义的比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -158905,7 +158879,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -158913,19 +158887,19 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于调节倒数排名融合中语义嵌入匹配与稀疏关键词匹配权重的权重值。
- `embedding_weight: number`
- 在互逆排序融合中嵌入的权重。
+ 倒数排名融合中嵌入的权重。
- `text_weight: number`
- 在互逆排序融合中文本的权重。
+ 倒数排名融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
- 用于文件搜索的排序器。
+ 用于 文件搜索 的排序器。
- `"auto"`
@@ -158933,25 +158907,25 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数值。数值越接近 1,会尝试只返回最相关的结果,但返回的结果数量可能更少。
+ 文件搜索 的分数阈值,介于 0 到 1 之间。越接近 1 的数值越倾向于只返回最相关的结果,但返回的结果数量可能更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer tool 的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示的高度。
- `display_width: number`
@@ -158973,18 +158947,18 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型,始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型,取值之一为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -158992,22 +158966,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。若省略,默认值为 true。当值为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的过滤器。
+ 搜索的筛选条件。
- `allowed_domains: optional array of string or null`
- 允许进行搜索的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -159021,34 +158995,34 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器,为模型提供对其他工具的访问权限。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ (MCP)服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 用于标识该 MCP 服务器的标签,会在工具调用中使用。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -159066,36 +159040,36 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许使用的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 一个可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可以配合
- 自定义的 MCP 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合
+ 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程并在此提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的那些。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供以下之一
+ `server_url`, `connector_id`, or `tunnel_id` 中的某一项。了解更多
关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
当前支持 `connector_id` 的值为:
@@ -159127,56 +159101,56 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要批准。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选器对象
- 需要批准的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的过滤对象
+ 用于需要审批的工具。
- `always: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许使用哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指明某个工具是否会修改数据,或者是否为只读。如果某个
- MCP 服务器 [被标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单一批准策略。其一为 `always` 或
- `never`. 当设置为 `always`,所有工具都需要审批。当
- 设置为 `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
+ `never`. 当设置为 `always`,所有工具都需要审批。当设置为
+ 设置为 `never`,所有工具都不需要审批。
- `"always"`
@@ -159184,26 +159158,26 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。 `server_url`, `connector_id`,或
- `tunnel_id` 必须提供一个。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`, or
+ `tunnel_id` 中的一个。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供一个。
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供
+ `server_url`, `connector_id`, or `tunnel_id` 中的一个。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
+ 代码解释器容器。可以是容器 ID,也可以是指定
+ 可供你的代码使用的已上传文件 ID 以及一个
可选的 `memory_limit` 设置的对象。
- `string`
@@ -159212,7 +159186,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
@@ -159222,7 +159196,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -159246,7 +159220,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终 `code_interpreter`.
+ 代码解释器工具的类型。始终为 `code_interpreter`.
- `"code_interpreter"`
@@ -159262,7 +159236,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "programmatic_tool_calling"`
- 工具的类型。始终 `programmatic_tool_calling`.
+ 工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -159272,13 +159246,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "image_generation"`
- 图像生成工具的类型。始终 `image_generation`.
+ 图像生成工具的类型。始终为 `image_generation`.
- `"image_generation"`
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 是生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -159288,11 +159262,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。支持的 GPT Image 模型可使用透明背景。对于
+ 设置生成图像的背景。为 `transparent`,
+ `opaque`, or `auto`。之一。透明背景适用于
支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ `gpt-image-2-2026-04-21`,该支持目前处于预览阶段。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -159302,7 +159276,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`. Supports `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不受 `gpt-image-1-mini`. 支持 `high` 和 `low`. Defaults to `low`.
- `"high"`
@@ -159310,22 +159284,22 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
+ 用于修复的可选遮罩。包含 `image_url`
(string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ 经过 Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -159334,7 +159308,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -159349,7 +159323,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -159361,7 +159335,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`, or
`jpeg`。默认值: `png`.
- `"png"`
@@ -159372,7 +159346,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -159389,13 +159363,13 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽度和高度都必须能被 16 整除,且请求的宽高比必须介于 1:3 与 3:1 之间。高于 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` ,请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`: 默认:auto, 和 `1024x1024`, `1536x1024`: 默认:auto, 和 `1024x1536` : 默认:auto, 和; `auto` 仅适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.
- `"1024x1024"`
@@ -159443,7 +159417,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -159451,7 +159425,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -159465,7 +159439,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -159485,7 +159459,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -159509,23 +159483,23 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 此函数是否应被延后并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组形式的输出。
+ 一个 JSON Schema,用于描述此函数工具的字符串输出中编码的 JSON 值。这不描述 content-array 类型的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,响应接口 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -159533,7 +159507,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "custom"`
- 自定义工具的类型。始终为 `custom`.
+ 自定义工具的类型,始终为 `custom`.
- `"custom"`
@@ -159547,7 +159521,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `defer_loading: optional boolean`
- 是否应推迟此工具并通过工具搜索来发现它。
+ 是否应将此工具延迟并通过工具搜索发现。
- `description: optional string`
@@ -159559,17 +159533,17 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `type: "namespace"`
- 工具的类型。始终 `namespace`.
+ 工具的类型。始终为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延后工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终 `tool_search`.
+ 工具的类型。始终为 `tool_search`.
- `"tool_search"`
@@ -159579,7 +159553,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -159591,11 +159565,11 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页上搜索相关结果以用于响应中。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具在网页上搜索可用于回复的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型,取值之一为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -159609,7 +159583,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级指导量。取值之一: `low`, `medium`, or `high`. `medium` 为默认值。
- `"low"`
@@ -159619,37 +159593,37 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户的位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如 `San Francisco`.
+ 用户所在城市的自由文本输入,例如: `San Francisco`.
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如: `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如 `California`.
+ 用户所在地区的自由文本输入,例如: `California`.
- `timezone: optional string or null`
- 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如: `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终 `apply_patch`.
+ 工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -159663,7 +159637,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \
- `truncation: optional "auto" or "disabled"`
- 用于模型响应的截断策略。 - `auto`:如果此响应的输入超出模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断响应,以适配上下文窗口。 - `disabled` (默认):如果输入大小将超出模型的上下文窗口大小,请求将失败并返回 400 错误。
+ 用于模型响应的截断策略。- `auto`: 如果此响应的输入超出模型的上下文窗口大小,模型将通过丢弃对话开头的条目来截断响应,以适配上下文窗口。- `disabled` (默认):如果输入大小将超出模型的上下文窗口大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -159685,7 +159659,7 @@ curl https://api.openai.com/v1/responses/input_tokens \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
-#### Response
+#### 响应
```json
{
@@ -159701,12 +159675,12 @@ curl -X POST https://api.openai.com/v1/responses/input_tokens \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5",
+ "model": "gpt-5.6-sol",
"input": "Tell me a joke."
}'
```
-#### Response
+#### 响应
```json
{
@@ -159717,7 +159691,7 @@ curl -X POST https://api.openai.com/v1/responses/input_tokens \
## Domain Types
-### 输入 Token 数量响应
+### Input Token Count Response
- `InputTokenCountResponse object { input_tokens, object }`
diff --git a/docs/zh/api/reference/resources/responses/methods/cancel.md b/docs/zh/api/reference/resources/responses/methods/cancel.md
index 02af220..8b25e4c 100644
--- a/docs/zh/api/reference/resources/responses/methods/cancel.md
+++ b/docs/zh/api/reference/resources/responses/methods/cancel.md
@@ -1,10 +1,10 @@
-> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 获取文档页面的 Markdown 版本。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾附加 `.md` 来获取文档页面的 Markdown 版本。
## 取消响应
**post** `/responses/{response_id}/cancel`
-取消具有指定 ID 的模型响应。仅可取消使用
+取消具有给定 ID 的模型响应。只能取消使用
该 `background` 参数设置为 `true` 创建的响应。
[了解详情](/docs/guides/background).
@@ -78,11 +78,11 @@
- `incomplete_details: object { reason } or null`
- 关于响应为何未完成的详细信息。
+ 关于响应不完整的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
- 响应未完成的原因。
+ 响应不完整的原因。
- `"max_output_tokens"`
@@ -92,27 +92,27 @@
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- response 中的指令不会延续到下一个 response。这使得在新的 response 中替换系统(或开发者)消息变得简单
- 。
+ 当与 previous_response_id 一起使用时, `previous_response_id`,上一个 response 中的指令将不会延续到下一个 response。这使得在新的 response 中替换系统(或开发者)消息变得简单。
+ 上一个 response 中的指令将不会延续到下一个 response。这使得在新的 response 中替换系统(或开发者)消息变得简单。
+ 上一个 response 中的指令将不会延续到下一个 response。这使得在新的 response 中替换系统(或开发者)消息变得简单。
- `string`
- 对模型的文本输入,等同于使用
- `developer` 角色的文本输入。
+ 模型的文本输入,等同于 role 为 "user" 的文本输入。
+ `developer` role 为 "user" 的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 包含
- 不同内容类型的一个或多个输入项的列表。
+ 一个由一个或多个输入项组成的列表,传递给模型,包含不同内容类型。
+ 包含不同内容类型的输入项。
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 层级。使用 `developer` 或 `system` 角色给出的指令具有
- 优先于使用 `user` 角色提供的指令。使用
- `assistant` 角色的消息被视为模型在之前的
- 交互中生成。
+ 具有角色(指示指令遵循层级)的模型消息输入。使用 "system" 或 "developer" 角色给出的指令优先级高于 "user" 消息,但低于 "assistant" 消息。
+ 使用 "system" 或 "developer" 角色给出的指令优先级高于 "user" 消息。 `developer` 或 `system` role 优先级高于
+ 优先级高于通过 `user` 角色给出的指令。带有
+ `assistant` 角色的消息被假定为在先前
+ 交互中由模型生成。
- `content: string or ResponseInputMessageContentList`
@@ -144,7 +144,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用的提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会四舍五入到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -158,7 +158,7 @@
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。取值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的图像的详细级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `"low"`
@@ -176,15 +176,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 要发送给模型的文件。
- `image_url: optional string or null`
- 要发送给模型的图像 URL。可以是完整的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图片的 URL。可以是完整 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用的提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会四舍五入到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -204,7 +204,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的详细程度。使用 `auto` 让系统选择详细程度;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 消耗。使用 `low` 以较低成本渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -214,23 +214,23 @@
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 要发送给模型的文件。
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用的提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会四舍五入到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -240,7 +240,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色。取值之一为 `user`, `assistant`, `system`,或
+ 消息输入的角色,可选值为 `user`, `assistant`, `system`,或
`developer`.
- `"user"`
@@ -253,9 +253,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
- )对于像 `gpt-5.3-codex` 及更高的模型,在发送后续请求时,请在所有助手消息中保留并重新发送
- 阶段,丢弃它可能会导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终回答(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高的模型,在发送后续请求时,请保留并重新发送
+ 阶段于所有助手消息上——丢弃它可能会降低性能。不用于用户消息。
- `"commentary"`
@@ -263,15 +263,15 @@
- `type: optional "message"`
- 消息输入的类型。始终为 `message`.
+ 消息输入的类型,始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示指令遵循
- 层级。使用 `developer` 或 `system` 角色给出的指令具有
- 优先于使用 `user` 角色的文本输入。
+ 具有角色(指示指令遵循层级)的模型消息输入。使用 "system" 或 "developer" 角色给出的指令优先级高于 "user" 消息,但低于 "assistant" 消息。
+ 使用 "system" 或 "developer" 角色给出的指令优先级高于 "user" 消息。 `developer` 或 `system` role 优先级高于
+ 优先级高于通过 `user` role 为 "user" 的文本输入。
- `content: ResponseInputMessageContentList`
@@ -280,7 +280,7 @@
- `role: "user" or "system" or "developer"`
- 消息输入的角色。取值之一为 `user`, `system`,或 `developer`.
+ 消息输入的角色,可选值为 `user`, `system`,或 `developer`.
- `"user"`
@@ -290,7 +290,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。取值之一为 `in_progress`, `completed`,或
+ 条目的状态,可选值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -319,7 +319,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型输出的文本。
+ 来自模型的一段文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -327,7 +327,7 @@
- `FileCitation object { file_id, filename, index, type }`
- 对文件的引用。
+ 对一个文件的引用。
- `file_id: string`
@@ -335,11 +335,11 @@
- `filename: string`
- 所引用文件的文件名。
+ 被引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -349,15 +349,15 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网页资源的引用。
+ 用于生成模型响应的网页资源引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中 URL 引用末尾字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中 URL 引用起始字符的索引。
- `title: string`
@@ -375,7 +375,7 @@
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
- 用于生成模型响应的容器文件的引用。
+ 用于生成模型响应的容器文件引用。
- `container_id: string`
@@ -383,7 +383,7 @@
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中容器文件引用末尾字符的索引。
- `file_id: string`
@@ -391,11 +391,11 @@
- `filename: string`
- 所引用的容器文件的文件名。
+ 所引用容器文件的文件名。
- `start_index: number`
- 容器文件引用在消息中的起始字符索引。
+ 消息中容器文件引用起始字符的索引。
- `type: "container_file_citation"`
@@ -413,7 +413,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -449,15 +449,15 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝内容。
+ 模型的拒绝。
- `refusal: string`
- 模型给出的拒绝解释。
+ 模型的拒绝解释。
- `type: "refusal"`
- 拒绝内容的类型。始终为 `refusal`.
+ 拒绝的类型。始终为 `refusal`.
- `"refusal"`
@@ -469,8 +469,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。取值之一 `in_progress`, `completed`,或
- `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -486,9 +486,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
- )对于像 `gpt-5.3-codex` 及更高的模型,在发送后续请求时,请在所有助手消息中保留并重新发送
- 阶段,丢弃它可能会导致性能下降。不适用于用户消息。
+ 将 `assistant` 消息标记为中间注释(`commentary`)或最终回答(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高的模型,在发送后续请求时,请保留并重新发送
+ 阶段于所有助手消息上——丢弃它可能会降低性能。不用于用户消息。
- `"commentary"`
@@ -496,7 +496,7 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。参见
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -505,11 +505,11 @@
- `queries: array of string`
- 用于搜索文件的查询语句。
+ 用于搜索文件的查询。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。取值之一 `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -534,11 +534,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 组键值对。可用于以结构化格式存储有关对象的附加信息,
- 并通过 API 或仪表板查询对象。键为长度不超过 64 个字符
- 的字符串。值为长度不超过 512 个字符的字符串、布尔值或数字。
- 的字符串。值为长度不超过 512 个字符的字符串、布尔值或数字。
- 的字符串、布尔值或数字。
+ 可附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储关于对象的附加信息,并通过 API 或仪表板查询对象。键为字符串
+ 格式,以及通过 接口 或仪表板查询对象。键为字符串
+ 最大长度为 64 个字符。值是字符串、
+ 长度为 512 个字符以内的字符串、布尔值或数字。
- `string`
@@ -564,20 +564,20 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。详见
- [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
+ 对计算机使用工具的工具调用。参见
+ [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
- 计算机调用的唯一 ID。
+ 该计算机调用的唯一 ID。
- `call_id: string`
- 使用输出响应该工具调用时所使用的标识符。
+ 使用输出响应工具调用时所用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
- 计算机调用的待处理安全检查。
+ 该计算机调用的待处理安全检查。
- `id: string`
@@ -589,11 +589,11 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 有关待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -604,21 +604,21 @@
- `type: "computer_call"`
- 计算机调用的类型。始终为 `computer_call`.
+ 电脑调用的类型。始终为 `computer_call`.
- `"computer_call"`
- `action: optional ComputerAction`
- 单击操作。
+ 一次点击动作。
- `Click object { button, type, x, 2 more }`
- 单击操作。
+ 一次点击动作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示点击时按下了哪个鼠标按键。取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 表示点击时按下的鼠标按键。取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -632,17 +632,17 @@
- `type: "click"`
- 指定事件类型。对于单击操作,此属性始终为 `click`.
+ 指定事件类型。对于点击动作,此属性始终为 `click`.
- `"click"`
- `x: number`
- 发生点击的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 发生点击的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
@@ -650,7 +650,7 @@
- `DoubleClick object { keys, type, x, y }`
- 双击操作。
+ 一次双击动作。
- `keys: array of string or null`
@@ -658,25 +658,25 @@
- `type: "double_click"`
- 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
- `"double_click"`
- `x: number`
- 发生双击的 x 坐标。
+ 双击发生位置的 x 坐标。
- `y: number`
- 发生双击的 y 坐标。
+ 双击发生位置的 y 坐标。
- `Drag object { path, type, keys }`
- 拖动操作。
+ 一次拖动动作。
- `path: array of object { x, y }`
- 表示拖动操作路径的坐标数组。坐标将以对象数组的形式出现,例如
+ 表示拖动动作路径的坐标数组。坐标以对象数组形式呈现,例如
```
[
@@ -695,7 +695,7 @@
- `type: "drag"`
- 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
- `"drag"`
@@ -705,11 +705,11 @@
- `Keypress object { keys, type }`
- 模型希望执行的按键操作的集合。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
+ 模型请求按下的按键组合。它是一个字符串数组,每个字符串代表一个键。
- `type: "keypress"`
@@ -729,11 +729,11 @@
- `x: number`
- 要移至的 x 坐标。
+ 要移动到的 x 坐标。
- `y: number`
- 要移至的 y 坐标。
+ 要移动到的 y 坐标。
- `keys: optional array of string or null`
@@ -781,7 +781,7 @@
- `Type object { text, type }`
- 用于输入文本的操作。
+ 输入文本的操作。
- `text: string`
@@ -789,7 +789,7 @@
- `type: "type"`
- 指定事件类型。对于 type 操作,此属性始终设置为 `type`.
+ 指定事件类型。对于输入操作,此属性始终设置为 `type`.
- `"type"`
@@ -806,23 +806,23 @@
- `actions: optional ComputerActionList`
扁平化批处理操作,用于 `computer_use`。每个操作包含一个
- `type` 判别字段以及操作特有的字段。
+ `type` 判别字段和操作专属字段。
- `Click object { button, type, x, 2 more }`
- 单击操作。
+ 一次点击动作。
- `DoubleClick object { keys, type, x, y }`
- 双击操作。
+ 一次双击动作。
- `Drag object { path, type, keys }`
- 拖动操作。
+ 一次拖动动作。
- `Keypress object { keys, type }`
- 模型希望执行的按键操作的集合。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -838,7 +838,7 @@
- `Type object { text, type }`
- 用于输入文本的操作。
+ 输入文本的操作。
- `Wait object { type }`
@@ -850,26 +850,26 @@
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机屏幕截图图像。
+ 与计算机使用工具一起使用的计算机截图图像。
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机屏幕截图,此属性始终设置为
+ 指定事件类型。对于计算机截图,此属性
始终设置为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含屏幕截图的上传文件的标识符。
+ 包含截图的上传文件的标识符。
- `image_url: optional string`
- 屏幕截图图像的 URL。
+ 截图图像的 URL。
- `type: "computer_call_output"`
@@ -883,7 +883,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由 API 报告的、已被开发者确认的安全检查。
+ 已被开发者确认的 API 报告的安全检查。
- `id: string`
@@ -895,11 +895,11 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 有关待处理安全检查的详细信息。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。取值之一 `in_progress`, `completed`,或 `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -909,21 +909,21 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。请参阅
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。请参阅
+ [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 网页搜索 工具调用的唯一 ID。
+ 网页搜索工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
- 包含模型如何使用网页(搜索、open_page、find_in_page)的详细信息。
+ 描述本次 网页搜索调用中所执行具体操作的对象。
+ 包含模型使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行一次 网页搜索 查询。
+ 操作类型 "search" - 执行一次 网页搜索查询。
- `type: "search"`
@@ -933,11 +933,11 @@
- `queries: optional array of string`
- 搜索查询语句。
+ 搜索查询。
- `query: optional string`
- 搜索查询语句。
+ 搜索查询。
- `sources: optional array of object { type, url }`
@@ -955,7 +955,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" —— 打开搜索结果中的指定 URL。
+ 操作类型 "open_page" - 打开搜索结果中的特定 URL。
- `type: "open_page"`
@@ -969,11 +969,11 @@
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 操作类型 "find_in_page":在已加载页面中搜索某个模式。
- `pattern: string`
- 要在页面中搜索的模式或文本。
+ 在页面内搜索的模式或文本。
- `type: "find_in_page"`
@@ -983,7 +983,7 @@
- `url: string`
- 在该 URL 的页面中搜索该模式。
+ 搜索该模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -1005,16 +1005,16 @@
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 用于运行函数的工具调用。详见
+ 用于运行函数的工具调用。请参阅
[函数调用指南](/docs/guides/function-calling) 了解更多信息。
- `arguments: string`
- 传递给该函数的参数的 JSON 字符串。
+ 传递给函数的参数的 JSON 字符串。
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -1044,7 +1044,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -1056,7 +1056,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1071,7 +1071,7 @@
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -1079,7 +1079,7 @@
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
@@ -1097,7 +1097,7 @@
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用的提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会四舍五入到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1117,19 +1117,19 @@
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。取值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的图像的详细级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 要发送给模型的文件。
- `image_url: optional string or null`
- 要发送给模型的图像 URL。可以是完整的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图片的 URL。可以是完整 URL,也可以是 data URL 中 base64 编码的图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用的提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会四舍五入到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1149,7 +1149,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的详细程度。使用 `auto` 让系统选择详细程度;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 消耗。使用 `low` 以较低成本渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 可降低渲染成本,或 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -1163,19 +1163,19 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 要发送给模型的文件。
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件的名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用的提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会四舍五入到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1195,7 +1195,7 @@
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -1213,7 +1213,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -1223,15 +1223,15 @@
- `name: optional string or null`
- 产生该输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 产生该输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。可选值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充。
+ 该条目的状态。值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1261,7 +1261,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -1285,11 +1285,11 @@
- `Function object { name, parameters, strict, 5 more }`
- 定义你自己代码中模型可以选择调用的函数。了解有关 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -1301,7 +1301,7 @@
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型,恒为 `function`.
- `"function"`
@@ -1315,54 +1315,54 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载,并通过工具搜索加载。
+ 该函数是否被延迟加载,并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述。模型使用此描述来决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数在字符串输出中所编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索 工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,恒为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于在指定的比较运算下,将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定属性键与给定值按定义比较运算进行比较的筛选条件。
- `key: string`
- 要与该值进行比较的键。
+ 用于与值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`: 等于
- - `ne`: 不等于
- - `gt`: 大于
- - `gte`: 大于或等于
- - `lt`: 小于
- - `lte`: 小于或等于
- - `in`: 包含于
- - `nin`: 不包含于
+ - `eq`:等于
+ - `ne`:不等于
+ - `gt`:大于
+ - `gte`:大于等于
+ - `lt`:小于
+ - `lte`:小于等于
+ - `in`:包含于
+ - `nin`:不包含于
- `"eq"`
@@ -1382,7 +1382,7 @@
- `value: string or number or boolean or array of string or number`
- 与属性键进行比较的值,支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值,支持字符串、数字或布尔类型。
- `string`
@@ -1402,11 +1402,11 @@
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。元素可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于在指定的比较运算下,将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定属性键与给定值按定义比较运算进行比较的筛选条件。
- `unknown`
@@ -1420,7 +1420,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数量应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -1428,7 +1428,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -1448,7 +1448,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1,尝试返回的结果越相关,但返回的结果数量可能更少。
- `Computer object { type }`
@@ -1456,7 +1456,7 @@
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer 工具的类型,始终为 `computer`.
- `"computer"`
@@ -1494,12 +1494,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解网页搜索工具
+ 通过互联网搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为以下之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1507,7 +1507,7 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。如果省略,默认值为 true。当值为 false 时,网页搜索工具将以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。省略时默认为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -1515,14 +1515,14 @@
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 同时允许所提供域名的子域名。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -1540,7 +1540,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -1548,7 +1548,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -1563,7 +1563,7 @@
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 此 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -1581,21 +1581,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许的工具名称列表或过滤对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -1603,26 +1603,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合自定义 MCP
+ 服务器 URL 或服务连接器使用。你的应用
必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其
- `server_url`, `connector_id`,或 `tunnel_id` 中之一即可。详细了解
- 关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
+ 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持 `connector_id` 的值为:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -1646,28 +1646,28 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 头,用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 中哪些工具需要审批。
+ 指定 MCP 服务器的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选对象
- 需要审批的工具。
+ 指定 MCP 服务器的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤对象
+ 。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -1675,13 +1675,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -1689,7 +1689,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
+ 为所有工具指定单个审批策略。其一为 `always` 或
`never`. 当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -1703,23 +1703,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下之一 `server_url`, `connector_id`,或
- `tunnel_id` 。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ `tunnel_id` 之一。
- `tunnel_id: optional string`
- 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一
- `server_url`, `connector_id`,或 `tunnel_id` 。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。必须提供
+ `server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 用于运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
- 可选 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 用于指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -1727,7 +1727,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可指定要运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -1737,7 +1737,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1759,7 +1759,7 @@
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用对外网络访问。始终 `disabled`.
- `"disabled"`
@@ -1767,29 +1767,29 @@
- `allowed_domains: array of string`
- 当 type 为时允许访问的域名列表 `allowlist`.
+ 当 type 为时允许的域名列表 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域名的出站网络访问。始终为 `allowlist`.
+ 仅允许向指定域名的出站网络访问。始终 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 针对已加入白名单域名的可选域作用域密钥。
+ 允许列表中域名对应的可选域级密钥。
- `domain: string`
- 与密钥关联的域名。
+ 与该密钥关联的域名。
- `name: string`
- 为该域名注入的密钥名称。
+ 要为该域名注入的密钥名称。
- `value: string`
- 为该域名注入的密钥值。
+ 为该域注入的密钥值。
- `type: "code_interpreter"`
@@ -1809,7 +1809,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 该工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -1825,7 +1825,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 是否生成新图像或编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -1836,9 +1836,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于
+ 支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1849,7 +1849,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,对于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -1857,20 +1857,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (字符串,可选)以及 `file_id` (字符串,可选)。
+ 用于修复(inpainting)的可选遮罩。包含 `image_url`
+ (string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -1879,7 +1879,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -1896,7 +1896,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -1908,7 +1908,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式,取值为以下之一: `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -1919,11 +1919,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量,取值为以下之一: `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -1936,13 +1936,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -1986,13 +1986,13 @@
- `type: "container_auto"`
- 自动为此请求创建一个容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2032,7 +2032,7 @@
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略时使用默认值。
+ 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -2066,7 +2066,7 @@
- `type: "inline"`
- 为此请求定义一个内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -2112,7 +2112,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -2130,7 +2130,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -2138,15 +2138,15 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Text object { type }`
- 无约束的自由格式文本。
+ 不受约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终为 `text`.
+ 不受约束的文本格式。始终为 `text`.
- `"text"`
@@ -2160,7 +2160,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法。可选值之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值之一 `lark` 或 `regex`.
- `"lark"`
@@ -2174,7 +2174,7 @@
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -2182,11 +2182,11 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如 `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 此命名空间内可用的函数/自定义工具。
+ 该命名空间内可用的函数/自定义工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -2206,19 +2206,19 @@
- `defer_loading: optional boolean`
- 是否应延迟该函数并通过工具搜索来发现。
+ 该函数是否应被延迟并通过工具搜索被发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 一个 JSON Schema,用于描述此函数工具的字符串输出中所编码的 JSON 值。该描述不适用于 content 数组输出。
+ 描述该函数工具字符串输出中所编码 JSON 值的 JSON Schema。此项不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。若省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。若省略,当 响应接口 在 schema 兼容时会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -2226,7 +2226,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -2244,7 +2244,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -2252,11 +2252,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 该工具的类型。始终为 `namespace`.
- `"namespace"`
@@ -2266,17 +2266,17 @@
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 该工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 展示给模型的、用于客户端执行的工具搜索工具的描述。
+ 展示给模型、用于客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -2284,15 +2284,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网络上搜索用于回复的相关结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为以下之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -2306,7 +2306,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -2316,7 +2316,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -2330,7 +2330,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2338,7 +2338,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -2346,7 +2346,7 @@
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 该工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -2374,7 +2374,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -2382,7 +2382,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 工具搜索输出的状态。
+ 该工具搜索输出的状态。
- `"in_progress"`
@@ -2400,15 +2400,15 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在此项中可用的额外工具列表。
+ 在此条目中可用的额外工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 定义你自己代码中模型可以选择调用的函数。了解有关 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -2420,7 +2420,7 @@
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型,恒为 `function`.
- `"function"`
@@ -2434,37 +2434,37 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载,并通过工具搜索加载。
+ 该函数是否被延迟加载,并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述。模型使用此描述来决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数在字符串输出中所编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索 工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,恒为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于在指定的比较运算下,将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定属性键与给定值按定义比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -2472,7 +2472,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数量应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -2480,7 +2480,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -2500,7 +2500,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1,尝试返回的结果越相关,但返回的结果数量可能更少。
- `Computer object { type }`
@@ -2508,7 +2508,7 @@
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer 工具的类型,始终为 `computer`.
- `"computer"`
@@ -2546,12 +2546,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解网页搜索工具
+ 通过互联网搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为以下之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -2559,7 +2559,7 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。如果省略,默认值为 true。当值为 false 时,网页搜索工具将以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。省略时默认为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -2567,14 +2567,14 @@
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 同时允许所提供域名的子域名。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -2592,7 +2592,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2600,7 +2600,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -2615,7 +2615,7 @@
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 此 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -2633,21 +2633,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许的工具名称列表或过滤对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -2655,26 +2655,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合自定义 MCP
+ 服务器 URL 或服务连接器使用。你的应用
必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其
- `server_url`, `connector_id`,或 `tunnel_id` 中之一即可。详细了解
- 关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
+ 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持 `connector_id` 的值为:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -2698,28 +2698,28 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 头,用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 中哪些工具需要审批。
+ 指定 MCP 服务器的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选对象
- 需要审批的工具。
+ 指定 MCP 服务器的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤对象
+ 。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -2727,13 +2727,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -2741,7 +2741,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
+ 为所有工具指定单个审批策略。其一为 `always` 或
`never`. 当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -2755,23 +2755,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下之一 `server_url`, `connector_id`,或
- `tunnel_id` 。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ `tunnel_id` 之一。
- `tunnel_id: optional string`
- 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一
- `server_url`, `connector_id`,或 `tunnel_id` 。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。必须提供
+ `server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 用于运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
- 可选 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 用于指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -2779,7 +2779,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可指定要运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -2789,7 +2789,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2829,7 +2829,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 该工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -2845,7 +2845,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 是否生成新图像或编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -2856,9 +2856,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于
+ 支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -2869,7 +2869,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,对于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -2877,20 +2877,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (字符串,可选)以及 `file_id` (字符串,可选)。
+ 用于修复(inpainting)的可选遮罩。包含 `image_url`
+ (string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -2899,7 +2899,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -2916,7 +2916,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -2928,7 +2928,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式,取值为以下之一: `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -2939,11 +2939,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量,取值为以下之一: `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -2956,13 +2956,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -3014,7 +3014,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -3032,7 +3032,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -3040,11 +3040,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -3052,11 +3052,11 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如 `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 此命名空间内可用的函数/自定义工具。
+ 该命名空间内可用的函数/自定义工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -3076,19 +3076,19 @@
- `defer_loading: optional boolean`
- 是否应延迟该函数并通过工具搜索来发现。
+ 该函数是否应被延迟并通过工具搜索被发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 一个 JSON Schema,用于描述此函数工具的字符串输出中所编码的 JSON 值。该描述不适用于 content 数组输出。
+ 描述该函数工具字符串输出中所编码 JSON 值的 JSON Schema。此项不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。若省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。若省略,当 响应接口 在 schema 兼容时会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -3096,7 +3096,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -3114,7 +3114,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -3122,11 +3122,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 该工具的类型。始终为 `namespace`.
- `"namespace"`
@@ -3136,17 +3136,17 @@
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 该工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 展示给模型的、用于客户端执行的工具搜索工具的描述。
+ 展示给模型、用于客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -3154,15 +3154,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网络上搜索用于回复的相关结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为以下之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -3176,7 +3176,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -3186,7 +3186,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -3200,7 +3200,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -3208,7 +3208,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -3216,7 +3216,7 @@
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 该工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -3236,13 +3236,13 @@
- `id: optional string or null`
- 此额外工具项的唯一 ID。
+ 该额外工具条目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 对推理模型在生成
- 回复时所使用的思路链的描述。请务必将这些项包含在你的 `input` 到 Responses API
- 用于对话的后续轮次,前提是你在手动
+ 推理模型在生成
+ 响应时所使用的思维链描述。请务必将这些条目包含在你的 `input` 到 Responses API
+ 用于对话的后续轮次,前提是你正在手动
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -3255,17 +3255,17 @@
- `text: string`
- 到目前为止模型推理输出的摘要。
+ 模型到目前为止的推理输出摘要。
- `type: "summary_text"`
- 对象的类型。始终为 `summary_text`.
+ 对象的类型,始终为 `summary_text`.
- `"summary_text"`
- `type: "reasoning"`
- 对象的类型。始终为 `reasoning`.
+ 对象的类型,始终为 `reasoning`.
- `"reasoning"`
@@ -3279,25 +3279,25 @@
- `type: "reasoning_text"`
- 推理文本的类型。始终为 `reasoning_text`.
+ 推理文本的类型,始终为 `reasoning_text`.
- `"reasoning_text"`
- `encrypted_content: optional string or null`
- 推理条目的加密内容。默认情况下会填充此字段,
- 用于由 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理条目。
+ 推理项的加密内容。默认情况下会填充该字段
+ ,适用于通过 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求返回的推理项。
- 在流式传输时,使用已完成的推理条目及其
- `encrypted_content` ,来自 `response.output_item.done` 事件,
- 用于后续请求。 `encrypted_content` 中的
- `response.output_item.added` 可能不完整。这一点尤其
- 在以下情况下很重要: `store` 是 `false` 或者使用 Zero Data Retention 时。
+ 流式传输时,请在后续请求中使用已完成的推理项及其
+ `encrypted_content` 事件中的 `response.output_item.done` 字段。
+ 后续请求中的 `encrypted_content` 可能
+ `response.output_item.added` 不完整。这种情况在
+ 在以下情况时尤其重要 `store` : `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -3308,7 +3308,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由以下内容生成的压缩项: [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -3316,7 +3316,7 @@
- `type: "compaction"`
- 项的类型。始终为 `compaction`.
+ 该项的类型。始终为 `compaction`.
- `"compaction"`
@@ -3326,7 +3326,7 @@
- `ImageGenerationCall object { id, result, status, type }`
- 模型发出的图像生成请求。
+ 由模型发起的图像生成请求。
- `id: string`
@@ -3356,7 +3356,7 @@
- `CodeInterpreterCall object { id, code, container_id, 3 more }`
- 运行代码的工具调用。
+ 用于运行代码的工具调用。
- `id: string`
@@ -3372,8 +3372,8 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
- 代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,则可以为 null。
+ 由代码解释器生成的输出,例如日志或图像。
+ 如果没有可用输出则可为 null。
- `Logs object { logs, type }`
@@ -3391,7 +3391,7 @@
- `Image object { type, url }`
- 代码解释器的图片输出。
+ 来自代码解释器的图像输出。
- `type: "image"`
@@ -3401,11 +3401,11 @@
- `url: string`
- 代码解释器图片输出的 URL。
+ 来自代码解释器的图像输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -3425,7 +3425,7 @@
- `LocalShellCall object { id, action, call_id, 2 more }`
- 在本地 shell 上运行命令的工具调用。
+ 用于在本地 shell 上运行命令的工具调用。
- `id: string`
@@ -3441,7 +3441,7 @@
- `env: map[string]`
- 为命令设置的环境变量。
+ 为该命令设置的环境变量。
- `type: "exec"`
@@ -3455,15 +3455,15 @@
- `user: optional string or null`
- 运行命令时使用的可选用户。
+ 运行该命令所使用的可选用户。
- `working_directory: optional string or null`
- 运行命令时使用的可选工作目录。
+ 运行该命令所使用的可选工作目录。
- `call_id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -3487,7 +3487,7 @@
- `id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -3501,7 +3501,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
+ 该条目的状态。值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3511,7 +3511,7 @@
- `ShellCall object { action, call_id, type, 4 more }`
- 表示请求执行一个或多个 shell 命令的工具。
+ 表示执行一条或多条 shell 命令请求的工具。
- `action: object { commands, max_output_length, timeout_ms }`
@@ -3523,25 +3523,25 @@
- `max_output_length: optional number or null`
- 从合并的 stdout 和 stderr 输出中捕获的最大 UTF-8 字符数。
+ 从合并后的 stdout 和 stderr 输出中捕获的最大 UTF-8 字符数。
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的最大挂钟时间(毫秒)。
+ 允许 shell 命令运行的最长挂钟时间(毫秒)。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `type: "shell_call"`
- 项的类型。始终为 `shell_call`.
+ 该项的类型。始终为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3559,7 +3559,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3577,7 +3577,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。可选值之一: `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3587,15 +3587,15 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- shell 工具调用发出的流式输出条目。
+ 由 shell 工具调用发出的流式输出条目。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 和 stderr 输出块,以及它们关联的结果。
+ 捕获的 stdout 和 stderr 输出块及其关联的结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -3603,7 +3603,7 @@
- `Timeout object { type }`
- 表示 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -3613,7 +3613,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已结束并返回了退出码。
+ 表示 shell 命令已执行完毕并返回了退出码。
- `exit_code: number`
@@ -3635,13 +3635,13 @@
- `type: "shell_call_output"`
- 项的类型。始终为 `shell_call_output`.
+ 该项的类型。始终为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3659,7 +3659,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3683,7 +3683,7 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示使用 diff 补丁创建、删除或更新文件的工具调用。
+ 表示通过 diff 补丁创建、删除或更新文件请求的工具调用。
- `call_id: string`
@@ -3691,7 +3691,7 @@
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
- apply_patch 工具调用的具体创建、删除或更新指令。
+ 针对 apply_patch 工具调用的具体创建、删除或更新指令。
- `CreateFile object { diff, path, type }`
@@ -3699,7 +3699,7 @@
- `diff: string`
- 创建文件时应用的统一 diff 内容。
+ 创建文件时要应用的统一 diff 内容。
- `path: string`
@@ -3731,7 +3731,7 @@
- `diff: string`
- 应用到现有文件的统一 diff 内容。
+ 要应用到现有文件的统一 diff 内容。
- `path: string`
@@ -3745,7 +3745,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。值为以下之一: `in_progress` 或 `completed`.
- `"in_progress"`
@@ -3753,13 +3753,13 @@
- `type: "apply_patch_call"`
- 项的类型。始终为 `apply_patch_call`.
+ 该项的类型。始终为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当此 item 通过 API 返回时被填充。
+ apply patch 工具调用的唯一 ID。当该条目通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3777,7 +3777,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3795,7 +3795,7 @@
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。值为以下之一: `completed` 或 `failed`.
- `"completed"`
@@ -3803,13 +3803,13 @@
- `type: "apply_patch_call_output"`
- 项的类型。始终为 `apply_patch_call_output`.
+ 该项的类型。始终为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当此 item 通过 API 返回时被填充。
+ apply patch 工具调用输出的唯一 ID。当该条目通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3827,7 +3827,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3837,15 +3837,15 @@
- `output: optional string or null`
- 来自 apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具返回的可选人类可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用的工具列表。
+ MCP 服务器上可用工具的列表。
- `id: string`
- 列表的唯一 ID。
+ 该列表的唯一 ID。
- `server_label: string`
@@ -3861,11 +3861,11 @@
- `name: string`
- 工具的名称。
+ 该工具的名称。
- `annotations: optional unknown or null`
- 有关该工具的附加注解。
+ 有关该工具的其他注释。
- `description: optional string or null`
@@ -3873,13 +3873,13 @@
- `type: "mcp_list_tools"`
- 项的类型。始终为 `mcp_list_tools`.
+ 该项的类型。始终为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 当服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具,则返回错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
@@ -3891,7 +3891,7 @@
- `arguments: string`
- 工具参数的 JSON 字符串。
+ 该工具参数的 JSON 字符串。
- `name: string`
@@ -3903,7 +3903,7 @@
- `type: "mcp_approval_request"`
- 项的类型。始终为 `mcp_approval_request`.
+ 该项的类型。始终为 `mcp_approval_request`.
- `"mcp_approval_request"`
@@ -3913,25 +3913,25 @@
- `approval_request_id: string`
- 正在回答的审批请求的 ID。
+ 正在响应的审批请求的 ID。
- `approve: boolean`
- 请求是否已被批准。
+ 该请求是否已获批准。
- `type: "mcp_approval_response"`
- 项的类型。始终为 `mcp_approval_response`.
+ 该项的类型。始终为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `id: optional string or null`
- 审批响应的唯一 ID
+ 审批响应的唯一 ID。
- `reason: optional string or null`
- 可选的决策原因。
+ 作出该决定的可选原因。
- `McpCall object { id, arguments, name, 6 more }`
@@ -3939,11 +3939,11 @@
- `id: string`
- 工具调用的唯一 ID。
+ 该工具调用的唯一 ID。
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给工具的参数的 JSON 字符串。
- `name: string`
@@ -3955,18 +3955,18 @@
- `type: "mcp_call"`
- 项的类型。始终为 `mcp_call`.
+ 该项的类型。始终为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用产生的错误(如果有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -4002,7 +4002,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态,取以下值之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -4016,7 +4016,7 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 由你的代码生成的自定义工具调用的输出,将被发送回模型。
+ 来自你的代码的自定义工具调用的输出,正在发送回模型。
- `call_id: string`
@@ -4025,7 +4025,7 @@
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
由你的代码生成的自定义工具调用的输出。
- 可以是字符串或输出内容的列表。
+ 可以是字符串或输出内容列表。
- `StringOutput = string`
@@ -4049,13 +4049,13 @@
- `type: "custom_tool_call_output"`
- 自定义工具调用输出的类型,始终为 `custom_tool_call_output`.
+ 自定义工具调用输出的类型。始终为 `custom_tool_call_output`.
- `"custom_tool_call_output"`
- `id: optional string`
- 在 OpenAI 平台中自定义工具调用输出的唯一 ID。
+ 该自定义工具调用输出在 OpenAI 平台中的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4073,7 +4073,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4083,7 +4083,7 @@
- `CustomToolCall object { call_id, input, name, 4 more }`
- 由模型创建的自定义工具的调用。
+ 模型创建的对自定义工具的调用。
- `call_id: string`
@@ -4105,7 +4105,7 @@
- `id: optional string`
- 自定义工具调用在OpenAI平台中的唯一 ID。
+ OpenAI 平台上此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4121,7 +4121,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4137,7 +4137,7 @@
- `type: "compaction_trigger"`
- 项的类型。始终为 `compaction_trigger`.
+ 该项的类型。始终为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -4147,7 +4147,7 @@
- `ItemReference object { id, type }`
- 供项引用的内部标识符。
+ 用于引用某个项的内部标识符。
- `id: string`
@@ -4167,15 +4167,15 @@
- `call_id: string`
- 程序项的稳定调用 ID。
+ 此程序项的稳定调用 ID。
- `code: string`
- 通过编程工具调用执行的 JavaScript 源代码。
+ 由程序化工具调用执行的 JavaScript 源代码。
- `fingerprint: string`
- 必须往返传输的不透明程序重放指纹。
+ 必须往返透传的不透明程序重放指纹。
- `type: "program"`
@@ -4191,11 +4191,11 @@
- `call_id: string`
- 程序项的调用 ID。
+ 此程序项的调用 ID。
- `result: string`
- 程序项生成的结果。
+ 程序项产生的结果。
- `status: "completed" or "incomplete"`
@@ -4213,19 +4213,19 @@
- `metadata: Metadata or null`
- 可附加到对象的 16 组键值对。可用于以结构化格式存储有关对象的附加信息,
- 并通过 API 或仪表板查询对象。键为长度不超过 64 个字符
- 格式化,以及通过API或控制面板查询对象。
+ 可附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储关于对象的附加信息,并通过 API 或仪表板查询对象。键为字符串
+ format,以及通过 API 或控制台查询对象。
- 键是字符串,最大长度为 64 个字符。值是字符串
+ 键为字符串,最大长度为 64 个字符。值为字符串
最大长度为 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
- 提供各种能力、性能
- 特性和价格档位各异的模型。请参阅 [模型指南](/docs/models)
- 以浏览和比较可用模型。
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`. OpenAI
+ 提供了多种具有不同能力、性能
+ 特性和价位的模型。请参阅 [模型指南](/docs/models)
+ 以浏览和比较可用的模型。
- `string`
@@ -4439,7 +4439,7 @@
- `object: "response"`
- 此资源的对象类型 - 始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -4447,12 +4447,12 @@
由模型生成的内容项数组。
- - 其中项的长度和顺序取决于 `output` 模型响应。你不应依赖
- 数组的首项,而应使用。
- - 请勿直接访问数组中的第一项并 `output` 假定它是一个
- 消息,其内容由模型生成; `assistant` 模型生成的内容。你可以考虑使用
- 属性,在受支持的 `output_text` SDK 中使用
- 属性。
+ - 数组中项的长度和顺序取决于 `output` 模型的响应。
+ 与其访问数组中的第一项并。
+ - 假设它是一 `output` 条包含由
+ 模型生成的内容的消 `assistant` 息,你可以考虑使用
+ 属性(在受支持的 SDK 中),其中 `output_text` 包含模型的输出文本。
+ 如 开发工具包 支持。
- `ResponseOutputMessage object { id, content, role, 3 more }`
@@ -4460,7 +4460,7 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。详见
+ 文件搜索 工具调用的结果。参见
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -4469,11 +4469,11 @@
- `queries: array of string`
- 用于搜索文件的查询语句。
+ 用于搜索文件的查询。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。取值之一 `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -4498,11 +4498,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 组键值对。可用于以结构化格式存储有关对象的附加信息,
- 并通过 API 或仪表板查询对象。键为长度不超过 64 个字符
- 的字符串。值为长度不超过 512 个字符的字符串、布尔值或数字。
- 的字符串。值为长度不超过 512 个字符的字符串、布尔值或数字。
- 的字符串、布尔值或数字。
+ 可附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储关于对象的附加信息,并通过 API 或仪表板查询对象。键为字符串
+ 格式,以及通过 接口 或仪表板查询对象。键为字符串
+ 最大长度为 64 个字符。值是字符串、
+ 长度为 512 个字符以内的字符串、布尔值或数字。
- `string`
@@ -4528,16 +4528,16 @@
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 用于运行函数的工具调用。详见
+ 用于运行函数的工具调用。请参阅
[函数调用指南](/docs/guides/function-calling) 了解更多信息。
- `arguments: string`
- 传递给该函数的参数的 JSON 字符串。
+ 传递给函数的参数的 JSON 字符串。
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -4567,7 +4567,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4579,7 +4579,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4596,12 +4596,12 @@
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 你的代码生成的函数调用输出。
- 可以是字符串或输出内容的列表。
+ 由你的代码生成的函数调用的输出。
+ 可以是字符串或输出内容列表。
- `StringOutput = string`
- 函数调用输出的字符串。
+ 函数调用的输出字符串。
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
@@ -4621,7 +4621,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4638,7 +4638,7 @@
- `call_id: optional string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4656,7 +4656,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4666,33 +4666,33 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `name: optional string`
- 产生该输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 产生该输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。请参阅
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。请参阅
+ [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 网页搜索 工具调用的唯一 ID。
+ 网页搜索工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
- 包含模型如何使用网页(搜索、open_page、find_in_page)的详细信息。
+ 描述本次 网页搜索调用中所执行具体操作的对象。
+ 包含模型使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行一次 网页搜索 查询。
+ 操作类型 "search" - 执行一次 网页搜索查询。
- `type: "search"`
@@ -4702,11 +4702,11 @@
- `queries: optional array of string`
- 搜索查询语句。
+ 搜索查询。
- `query: optional string`
- 搜索查询语句。
+ 搜索查询。
- `sources: optional array of object { type, url }`
@@ -4724,7 +4724,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" —— 打开搜索结果中的指定 URL。
+ 操作类型 "open_page" - 打开搜索结果中的特定 URL。
- `type: "open_page"`
@@ -4738,11 +4738,11 @@
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 操作类型 "find_in_page":在已加载页面中搜索某个模式。
- `pattern: string`
- 要在页面中搜索的模式或文本。
+ 在页面内搜索的模式或文本。
- `type: "find_in_page"`
@@ -4752,7 +4752,7 @@
- `url: string`
- 在该 URL 的页面中搜索该模式。
+ 搜索该模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -4774,20 +4774,20 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。详见
- [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
+ 对计算机使用工具的工具调用。参见
+ [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
- 计算机调用的唯一 ID。
+ 该计算机调用的唯一 ID。
- `call_id: string`
- 使用输出响应该工具调用时所使用的标识符。
+ 使用输出响应工具调用时所用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
- 计算机调用的待处理安全检查。
+ 该计算机调用的待处理安全检查。
- `id: string`
@@ -4799,11 +4799,11 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 有关待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4814,18 +4814,18 @@
- `type: "computer_call"`
- 计算机调用的类型。始终为 `computer_call`.
+ 电脑调用的类型。始终为 `computer_call`.
- `"computer_call"`
- `action: optional ComputerAction`
- 单击操作。
+ 一次点击动作。
- `actions: optional ComputerActionList`
扁平化批处理操作,用于 `computer_use`。每个操作包含一个
- `type` 判别字段以及操作特有的字段。
+ `type` 判别字段和操作专属字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -4835,16 +4835,16 @@
- `call_id: string`
- 生成该输出的计算机工具调用的 ID。
+ 产生该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
- 与计算机使用工具配合使用的计算机屏幕截图图像。
+ 与计算机使用工具一起使用的计算机截图图像。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。取值之一 `in_progress`, `completed`,或
- `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"completed"`
@@ -4862,7 +4862,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告的、已被
+ 由 API 报告的、且已被
开发者确认的安全检查。
- `id: string`
@@ -4875,17 +4875,17 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 有关待处理安全检查的详细信息。
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 对推理模型在生成
- 回复时所使用的思路链的描述。请务必将这些项包含在你的 `input` 到 Responses API
- 用于对话的后续轮次,前提是你在手动
+ 推理模型在生成
+ 响应时所使用的思维链描述。请务必将这些条目包含在你的 `input` 到 Responses API
+ 用于对话的后续轮次,前提是你正在手动
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -4898,15 +4898,15 @@
- `text: string`
- 到目前为止模型推理输出的摘要。
+ 模型到目前为止的推理输出摘要。
- `type: "summary_text"`
- 对象的类型。始终为 `summary_text`.
+ 对象的类型,始终为 `summary_text`.
- `type: "reasoning"`
- 对象的类型。始终为 `reasoning`.
+ 对象的类型,始终为 `reasoning`.
- `"reasoning"`
@@ -4920,25 +4920,25 @@
- `type: "reasoning_text"`
- 推理文本的类型。始终为 `reasoning_text`.
+ 推理文本的类型,始终为 `reasoning_text`.
- `"reasoning_text"`
- `encrypted_content: optional string or null`
- 推理条目的加密内容。默认情况下会填充此字段,
- 用于由 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理条目。
+ 推理项的加密内容。默认情况下会填充该字段
+ ,适用于通过 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求返回的推理项。
- 在流式传输时,使用已完成的推理条目及其
- `encrypted_content` ,来自 `response.output_item.done` 事件,
- 用于后续请求。 `encrypted_content` 中的
- `response.output_item.added` 可能不完整。这一点尤其
- 在以下情况下很重要: `store` 是 `false` 或者使用 Zero Data Retention 时。
+ 流式传输时,请在后续请求中使用已完成的推理项及其
+ `encrypted_content` 事件中的 `response.output_item.done` 字段。
+ 后续请求中的 `encrypted_content` 可能
+ `response.output_item.added` 不完整。这种情况在
+ 在以下情况时尤其重要 `store` : `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4951,23 +4951,23 @@
- `id: string`
- 程序条目的唯一 ID。
+ 该程序条目的唯一 ID。
- `call_id: string`
- 程序项的稳定调用 ID。
+ 此程序项的稳定调用 ID。
- `code: string`
- 通过编程工具调用执行的 JavaScript 源代码。
+ 由程序化工具调用执行的 JavaScript 源代码。
- `fingerprint: string`
- 必须往返传输的不透明程序重放指纹。
+ 必须往返透传的不透明程序重放指纹。
- `type: "program"`
- 项的类型。始终为 `program`.
+ 该项的类型。始终为 `program`.
- `"program"`
@@ -4979,15 +4979,15 @@
- `call_id: string`
- 程序项的调用 ID。
+ 此程序项的调用 ID。
- `result: string`
- 程序项生成的结果。
+ 程序项产生的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终止状态。
+ 程序输出条目的最终状态。
- `"completed"`
@@ -4995,7 +4995,7 @@
- `type: "program_output"`
- 项的类型。始终为 `program_output`.
+ 该项的类型。始终为 `program_output`.
- `"program_output"`
@@ -5015,7 +5015,7 @@
- `execution: "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -5033,13 +5033,13 @@
- `type: "tool_search_call"`
- 项的类型。始终为 `tool_search_call`.
+ 该项的类型。始终为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -5053,7 +5053,7 @@
- `execution: "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -5071,15 +5071,15 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 工具搜索返回的已加载工具定义。
+ 由工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 定义你自己代码中模型可以选择调用的函数。了解有关 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -5091,7 +5091,7 @@
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型,恒为 `function`.
- `"function"`
@@ -5105,37 +5105,37 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载,并通过工具搜索加载。
+ 该函数是否被延迟加载,并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述。模型使用此描述来决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数在字符串输出中所编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索 工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,恒为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于在指定的比较运算下,将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定属性键与给定值按定义比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -5143,7 +5143,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数量应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -5151,7 +5151,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -5171,7 +5171,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1,尝试返回的结果越相关,但返回的结果数量可能更少。
- `Computer object { type }`
@@ -5179,7 +5179,7 @@
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer 工具的类型,始终为 `computer`.
- `"computer"`
@@ -5217,12 +5217,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解网页搜索工具
+ 通过互联网搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为以下之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -5230,7 +5230,7 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。如果省略,默认值为 true。当值为 false 时,网页搜索工具将以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。省略时默认为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -5238,14 +5238,14 @@
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 同时允许所提供域名的子域名。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -5263,7 +5263,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5271,7 +5271,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -5286,7 +5286,7 @@
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 此 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -5304,21 +5304,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许的工具名称列表或过滤对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -5326,26 +5326,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合自定义 MCP
+ 服务器 URL 或服务连接器使用。你的应用
必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其
- `server_url`, `connector_id`,或 `tunnel_id` 中之一即可。详细了解
- 关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
+ 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持 `connector_id` 的值为:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -5369,28 +5369,28 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 头,用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 中哪些工具需要审批。
+ 指定 MCP 服务器的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选对象
- 需要审批的工具。
+ 指定 MCP 服务器的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤对象
+ 。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -5398,13 +5398,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -5412,7 +5412,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
+ 为所有工具指定单个审批策略。其一为 `always` 或
`never`. 当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -5426,23 +5426,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下之一 `server_url`, `connector_id`,或
- `tunnel_id` 。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ `tunnel_id` 之一。
- `tunnel_id: optional string`
- 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一
- `server_url`, `connector_id`,或 `tunnel_id` 。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。必须提供
+ `server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 用于运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
- 可选 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 用于指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -5450,7 +5450,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可指定要运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -5460,7 +5460,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -5500,7 +5500,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 该工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -5516,7 +5516,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 是否生成新图像或编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -5527,9 +5527,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于
+ 支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5540,7 +5540,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,对于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -5548,20 +5548,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (字符串,可选)以及 `file_id` (字符串,可选)。
+ 用于修复(inpainting)的可选遮罩。包含 `image_url`
+ (string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -5570,7 +5570,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -5587,7 +5587,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -5599,7 +5599,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式,取值为以下之一: `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -5610,11 +5610,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量,取值为以下之一: `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -5627,13 +5627,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -5685,7 +5685,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -5703,7 +5703,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -5711,11 +5711,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -5723,11 +5723,11 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如 `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 此命名空间内可用的函数/自定义工具。
+ 该命名空间内可用的函数/自定义工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -5747,19 +5747,19 @@
- `defer_loading: optional boolean`
- 是否应延迟该函数并通过工具搜索来发现。
+ 该函数是否应被延迟并通过工具搜索被发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 一个 JSON Schema,用于描述此函数工具的字符串输出中所编码的 JSON 值。该描述不适用于 content 数组输出。
+ 描述该函数工具字符串输出中所编码 JSON 值的 JSON Schema。此项不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。若省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。若省略,当 响应接口 在 schema 兼容时会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -5767,7 +5767,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -5785,7 +5785,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -5793,11 +5793,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 该工具的类型。始终为 `namespace`.
- `"namespace"`
@@ -5807,17 +5807,17 @@
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 该工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 展示给模型的、用于客户端执行的工具搜索工具的描述。
+ 展示给模型、用于客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -5825,15 +5825,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网络上搜索用于回复的相关结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为以下之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -5847,7 +5847,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -5857,7 +5857,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -5871,7 +5871,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5879,7 +5879,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -5887,7 +5887,7 @@
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 该工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -5901,23 +5901,23 @@
- `type: "tool_search_output"`
- 项的类型。始终为 `tool_search_output`.
+ 该项的类型。始终为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 其他工具条目的唯一 ID。
+ 额外工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供其他工具的角色。
+ 提供额外工具的角色。
- `"unknown"`
@@ -5937,15 +5937,15 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目下可用的其他工具定义。
+ 在该条目下可用的额外工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 定义你自己代码中模型可以选择调用的函数。了解有关 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -5957,7 +5957,7 @@
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型,恒为 `function`.
- `"function"`
@@ -5971,37 +5971,37 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载,并通过工具搜索加载。
+ 该函数是否被延迟加载,并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述。模型使用此描述来决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数在字符串输出中所编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索 工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,恒为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于在指定的比较运算下,将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定属性键与给定值按定义比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -6009,7 +6009,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数量应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -6017,7 +6017,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -6037,7 +6037,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1,尝试返回的结果越相关,但返回的结果数量可能更少。
- `Computer object { type }`
@@ -6045,7 +6045,7 @@
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer 工具的类型,始终为 `computer`.
- `"computer"`
@@ -6083,12 +6083,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解网页搜索工具
+ 通过互联网搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为以下之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -6096,7 +6096,7 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。如果省略,默认值为 true。当值为 false 时,网页搜索工具将以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。省略时默认为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -6104,14 +6104,14 @@
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 同时允许所提供域名的子域名。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6129,7 +6129,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6137,7 +6137,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -6152,7 +6152,7 @@
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 此 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -6170,21 +6170,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许的工具名称列表或过滤对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -6192,26 +6192,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合自定义 MCP
+ 服务器 URL 或服务连接器使用。你的应用
必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其
- `server_url`, `connector_id`,或 `tunnel_id` 中之一即可。详细了解
- 关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
+ 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持 `connector_id` 的值为:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -6235,28 +6235,28 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 头,用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 中哪些工具需要审批。
+ 指定 MCP 服务器的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选对象
- 需要审批的工具。
+ 指定 MCP 服务器的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤对象
+ 。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -6264,13 +6264,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -6278,7 +6278,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
+ 为所有工具指定单个审批策略。其一为 `always` 或
`never`. 当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -6292,23 +6292,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下之一 `server_url`, `connector_id`,或
- `tunnel_id` 。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ `tunnel_id` 之一。
- `tunnel_id: optional string`
- 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一
- `server_url`, `connector_id`,或 `tunnel_id` 。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。必须提供
+ `server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 用于运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
- 可选 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 用于指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -6316,7 +6316,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可指定要运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -6326,7 +6326,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -6366,7 +6366,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 该工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -6382,7 +6382,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 是否生成新图像或编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -6393,9 +6393,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于
+ 支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -6406,7 +6406,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,对于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -6414,20 +6414,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (字符串,可选)以及 `file_id` (字符串,可选)。
+ 用于修复(inpainting)的可选遮罩。包含 `image_url`
+ (string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -6436,7 +6436,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -6453,7 +6453,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -6465,7 +6465,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式,取值为以下之一: `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -6476,11 +6476,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量,取值为以下之一: `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -6493,13 +6493,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -6551,7 +6551,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -6569,7 +6569,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -6577,11 +6577,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -6589,11 +6589,11 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如 `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 此命名空间内可用的函数/自定义工具。
+ 该命名空间内可用的函数/自定义工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -6613,19 +6613,19 @@
- `defer_loading: optional boolean`
- 是否应延迟该函数并通过工具搜索来发现。
+ 该函数是否应被延迟并通过工具搜索被发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 一个 JSON Schema,用于描述此函数工具的字符串输出中所编码的 JSON 值。该描述不适用于 content 数组输出。
+ 描述该函数工具字符串输出中所编码 JSON 值的 JSON Schema。此项不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。若省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。若省略,当 响应接口 在 schema 兼容时会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -6633,7 +6633,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -6651,7 +6651,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -6659,11 +6659,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 该工具的类型。始终为 `namespace`.
- `"namespace"`
@@ -6673,17 +6673,17 @@
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 该工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 展示给模型的、用于客户端执行的工具搜索工具的描述。
+ 展示给模型、用于客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -6691,15 +6691,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网络上搜索用于回复的相关结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为以下之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -6713,7 +6713,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6723,7 +6723,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -6737,7 +6737,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6745,7 +6745,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -6753,7 +6753,7 @@
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 该工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -6767,13 +6767,13 @@
- `type: "additional_tools"`
- 项的类型。始终为 `additional_tools`.
+ 该项的类型。始终为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下内容生成的压缩项: [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -6785,17 +6785,17 @@
- `type: "compaction"`
- 项的类型。始终为 `compaction`.
+ 该项的类型。始终为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `ImageGenerationCall object { id, result, status, type }`
- 模型发出的图像生成请求。
+ 由模型发起的图像生成请求。
- `id: string`
@@ -6825,7 +6825,7 @@
- `CodeInterpreterCall object { id, code, container_id, 3 more }`
- 运行代码的工具调用。
+ 用于运行代码的工具调用。
- `id: string`
@@ -6841,8 +6841,8 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
- 代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,则可以为 null。
+ 由代码解释器生成的输出,例如日志或图像。
+ 如果没有可用输出则可为 null。
- `Logs object { logs, type }`
@@ -6860,7 +6860,7 @@
- `Image object { type, url }`
- 代码解释器的图片输出。
+ 来自代码解释器的图像输出。
- `type: "image"`
@@ -6870,11 +6870,11 @@
- `url: string`
- 代码解释器图片输出的 URL。
+ 来自代码解释器的图像输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
+ 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -6894,7 +6894,7 @@
- `LocalShellCall object { id, action, call_id, 2 more }`
- 在本地 shell 上运行命令的工具调用。
+ 用于在本地 shell 上运行命令的工具调用。
- `id: string`
@@ -6910,7 +6910,7 @@
- `env: map[string]`
- 为命令设置的环境变量。
+ 为该命令设置的环境变量。
- `type: "exec"`
@@ -6924,15 +6924,15 @@
- `user: optional string or null`
- 运行命令时使用的可选用户。
+ 运行该命令所使用的可选用户。
- `working_directory: optional string or null`
- 运行命令时使用的可选工作目录。
+ 运行该命令所使用的可选工作目录。
- `call_id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -6956,7 +6956,7 @@
- `id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -6970,7 +6970,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
+ 该条目的状态。值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -6980,11 +6980,11 @@
- `ShellCall object { id, action, call_id, 5 more }`
- 一个在托管环境中执行一条或多条 shell 命令的工具调用。
+ 在托管环境中执行一个或多个 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。通过 API 返回此条目时填充。
- `action: object { commands, max_output_length, timeout_ms }`
@@ -6994,7 +6994,7 @@
- `max_output_length: number or null`
- 每个命令返回结果的可选最大字符数。
+ 每个命令返回内容的可选最大字符数。
- `timeout_ms: number or null`
@@ -7002,7 +7002,7 @@
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `environment: ResponseLocalEnvironment or ResponseContainerReference or null`
@@ -7020,7 +7020,7 @@
- `ResponseContainerReference object { container_id, type }`
- 表示通过 /v1/containers 创建的容器。
+ 表示使用 /v1/containers 创建的容器。
- `container_id: string`
@@ -7032,7 +7032,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。可选值之一: `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7042,7 +7042,7 @@
- `type: "shell_call"`
- 项的类型。始终为 `shell_call`.
+ 该项的类型。始终为 `shell_call`.
- `"shell_call"`
@@ -7060,7 +7060,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7068,7 +7068,7 @@
- `created_by: optional string`
- 创建此工具调用的实体 ID。
+ 创建此工具调用的实体的 ID。
- `ShellCallOutput object { id, call_id, max_output_length, 5 more }`
@@ -7076,11 +7076,11 @@
- `id: string`
- shell 调用的输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `max_output_length: number or null`
@@ -7092,11 +7092,11 @@
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块的退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的退出结果(带退出码)或超时结果之一。
- `Timeout object { type }`
- 表示 shell 调用超过了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -7106,7 +7106,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已结束并返回了退出码。
+ 表示 shell 命令已执行完毕并返回了退出码。
- `exit_code: number`
@@ -7128,7 +7128,7 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -7160,7 +7160,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7168,15 +7168,15 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
- 一个通过创建、删除或更新文件来应用文件差异的工具调用。
+ 通过创建、删除或更新文件来应用文件差异的工具调用。
- `id: string`
- apply patch 工具调用的唯一 ID。当此 item 通过 API 返回时被填充。
+ apply patch 工具调用的唯一 ID。当该条目通过 API 返回时填充。
- `call_id: string`
@@ -7192,53 +7192,53 @@
- `diff: string`
- Diff to apply.
+ 要应用的差异。
- `path: string`
- Path of the file to create.
+ 要创建的文件的路径。
- `type: "create_file"`
- Create a new file with the provided diff.
+ 使用提供的差异创建一个新文件。
- `"create_file"`
- `DeleteFile object { path, type }`
- Instruction describing how to delete a file via the apply_patch tool.
+ 描述如何通过 apply_patch 工具删除文件的说明。
- `path: string`
- Path of the file to delete.
+ 要删除的文件的路径。
- `type: "delete_file"`
- Delete the specified file.
+ 删除指定的文件。
- `"delete_file"`
- `UpdateFile object { diff, path, type }`
- Instruction describing how to update a file via the apply_patch tool.
+ 描述如何通过 apply_patch 工具更新文件的说明。
- `diff: string`
- Diff to apply.
+ 要应用的差异。
- `path: string`
- Path of the file to update.
+ 要更新的文件的路径。
- `type: "update_file"`
- Update an existing file with the provided diff.
+ 使用提供的差异更新现有文件。
- `"update_file"`
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。值为以下之一: `in_progress` 或 `completed`.
- `"in_progress"`
@@ -7246,7 +7246,7 @@
- `type: "apply_patch_call"`
- 项的类型。始终为 `apply_patch_call`.
+ 该项的类型。始终为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -7264,7 +7264,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7272,15 +7272,15 @@
- `created_by: optional string`
- 创建此工具调用的实体 ID。
+ 创建此工具调用的实体的 ID。
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- The output emitted by an apply patch tool call.
+ apply patch 工具调用发出的输出。
- `id: string`
- apply patch 工具调用输出的唯一 ID。当此 item 通过 API 返回时被填充。
+ apply patch 工具调用输出的唯一 ID。当该条目通过 API 返回时填充。
- `call_id: string`
@@ -7288,7 +7288,7 @@
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。值为以下之一: `completed` 或 `failed`.
- `"completed"`
@@ -7296,7 +7296,7 @@
- `type: "apply_patch_call_output"`
- 项的类型。始终为 `apply_patch_call_output`.
+ 该项的类型。始终为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -7314,7 +7314,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7322,11 +7322,11 @@
- `created_by: optional string`
- The ID of the entity that created this tool call output.
+ 创建此工具调用输出的实体 ID。
- `output: optional string or null`
- Optional textual output returned by the apply patch tool.
+ 由 apply patch 工具返回的可选文本输出。
- `McpCall object { id, arguments, name, 6 more }`
@@ -7334,11 +7334,11 @@
- `id: string`
- 工具调用的唯一 ID。
+ 该工具调用的唯一 ID。
- `arguments: string`
- 传递给该工具的参数的 JSON 字符串。
+ 传递给工具的参数的 JSON 字符串。
- `name: string`
@@ -7350,18 +7350,18 @@
- `type: "mcp_call"`
- 项的类型。始终为 `mcp_call`.
+ 该项的类型。始终为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用产生的错误(如果有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -7369,7 +7369,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态,取以下值之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -7383,11 +7383,11 @@
- `McpListTools object { id, server_label, tools, 2 more }`
- MCP 服务器上可用的工具列表。
+ MCP 服务器上可用工具的列表。
- `id: string`
- 列表的唯一 ID。
+ 该列表的唯一 ID。
- `server_label: string`
@@ -7403,11 +7403,11 @@
- `name: string`
- 工具的名称。
+ 该工具的名称。
- `annotations: optional unknown or null`
- 有关该工具的附加注解。
+ 有关该工具的其他注释。
- `description: optional string or null`
@@ -7415,13 +7415,13 @@
- `type: "mcp_list_tools"`
- 项的类型。始终为 `mcp_list_tools`.
+ 该项的类型。始终为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 当服务器无法列出工具时的错误信息。
+ 如果服务器无法列出工具,则返回错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
@@ -7433,7 +7433,7 @@
- `arguments: string`
- 工具参数的 JSON 字符串。
+ 该工具参数的 JSON 字符串。
- `name: string`
@@ -7445,7 +7445,7 @@
- `type: "mcp_approval_request"`
- 项的类型。始终为 `mcp_approval_request`.
+ 该项的类型。始终为 `mcp_approval_request`.
- `"mcp_approval_request"`
@@ -7455,29 +7455,29 @@
- `id: string`
- 审批响应的唯一 ID
+ 审批响应的唯一 ID。
- `approval_request_id: string`
- 正在回答的审批请求的 ID。
+ 正在响应的审批请求的 ID。
- `approve: boolean`
- 请求是否已被批准。
+ 该请求是否已获批准。
- `type: "mcp_approval_response"`
- 项的类型。始终为 `mcp_approval_response`.
+ 该项的类型。始终为 `mcp_approval_response`.
- `"mcp_approval_response"`
- `reason: optional string or null`
- 可选的决策原因。
+ 作出该决定的可选原因。
- `CustomToolCall object { call_id, input, name, 4 more }`
- 由模型创建的自定义工具的调用。
+ 模型创建的对自定义工具的调用。
- `call_id: string`
@@ -7499,7 +7499,7 @@
- `id: optional string`
- 自定义工具调用在OpenAI平台中的唯一 ID。
+ OpenAI 平台上此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -7515,7 +7515,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7529,7 +7529,7 @@
- `id: string`
- The unique ID of the custom tool call output item.
+ 自定义工具调用输出项的唯一 ID。
- `call_id: string`
@@ -7538,7 +7538,7 @@
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
由你的代码生成的自定义工具调用的输出。
- 可以是字符串或输出内容的列表。
+ 可以是字符串或输出内容列表。
- `StringOutput = string`
@@ -7562,7 +7562,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。可选值为 `in_progress`, `completed`,或
+ 该条目的状态。值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -7573,7 +7573,7 @@
- `type: "custom_tool_call_output"`
- 自定义工具调用输出的类型,始终为 `custom_tool_call_output`.
+ 自定义工具调用输出的类型。始终为 `custom_tool_call_output`.
- `"custom_tool_call_output"`
@@ -7593,7 +7593,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7603,30 +7603,30 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与方的标识符。
- `parallel_tool_calls: boolean`
- Whether to allow the model to run tool calls in parallel.
+ 是否允许模型并行运行工具调用。
- `temperature: number or null`
- What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
- We generally recommend altering this or `top_p` but not both.
+ 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定。
+ 我们通常建议更改此设置或 `top_p` ,但不要同时更改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- How the model should select which tool (or tools) to use when generating
- a response. See the `tools` parameter to see how to specify which tools
- 模型可以调用的工具。
+ 模型在生成时应如何选择要使用的工具
+ 响应。请参阅 `tools` 参数以了解如何指定要使用的工具
+ 模型可以调用。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有的话)。
- `none` 表示模型将不调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
- `auto` 表示模型可以在生成一条消息或调用一个或
+ `auto` 表示模型可以在生成消息和调用一个或
多个工具之间进行选择。
`required` 表示模型必须调用一个或多个工具。
@@ -7639,16 +7639,16 @@
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一个预定义集合。
+ 将模型可用的工具限制为预定义集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一个预定义集合。
+ 将模型可用的工具限制为预定义集合。
- `auto` 允许模型从允许的工具中进行选择并生成一条
+ `auto` 允许模型从允许的工具中选择并生成一条
消息。
- `required` 要求模型调用一个或多个允许的工具。
+ `required` 要求模型调用允许的工具中的一个或多个。
- `"auto"`
@@ -7656,7 +7656,7 @@
- `tools: array of map[unknown]`
- 模型应被允许调用的工具定义列表。
+ 允许模型调用的工具定义列表。
对于 Responses API,工具定义列表可能如下所示:
@@ -7677,11 +7677,11 @@
- `ToolChoiceTypes object { type }`
指示模型应使用内置工具生成响应。
- [了解更多关于内置工具的信息](/docs/guides/tools).
+ [了解有关内置工具的更多信息](/docs/guides/tools).
- `type: "file_search" or "web_search_preview" or "computer" or 5 more`
- 模型应使用的 托管工具 类型。了解更多关于
+ 模型应使用的 托管工具 类型。了解有关
[内置工具](/docs/guides/tools).
允许的值为:
@@ -7716,7 +7716,7 @@
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `type: "function"`
@@ -7740,7 +7740,7 @@
- `name: optional string or null`
- 要在服务器上调用的工具的名称。
+ 要在服务器上调用的工具名称。
- `ToolChoiceCustom object { name, type }`
@@ -7793,24 +7793,24 @@
- **内置工具**:由 OpenAI 提供的工具,用于扩展
模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。详细了解
+ 或 [文件搜索](/docs/guides/tools-file-search)。了解有关
[内置工具](/docs/guides/tools).
- - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
- 或预定义连接器(如 Google Drive 和 SharePoint)进行集成。详细了解
- [MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够使用强类型参数和输出调用你自己的代码。
- 详细了解
+ - **MCP Tools**: 通过自定义 MCP 服务器与第三方系统集成
+ 或 Google Drive、SharePoint 等预定义连接器。了解有关
+ [MCP Tools](/docs/guides/tools-connectors-mcp).
+ - **Function calls (custom tools)**: 由你定义的函数,
+ 使模型能够使用强类型参数调用你自己的代码
+ 并返回输出。了解有关
[function calling](/docs/guides/function-calling)。你也可以使用
自定义工具来调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 定义你自己代码中模型可以选择调用的函数。了解有关 [function calling](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。了解更多关于 [function calling](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
@@ -7822,7 +7822,7 @@
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型,恒为 `function`.
- `"function"`
@@ -7836,37 +7836,37 @@
- `defer_loading: optional boolean`
- 此函数是否被延迟加载,并通过工具搜索加载。
+ 该函数是否被延迟加载,并通过工具搜索加载。
- `description: optional string or null`
- 函数的描述。模型使用此描述来决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数在字符串输出中所编码的 JSON 值的 JSON schema 对象。
+ 描述该函数在字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索 工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,恒为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于在指定的比较运算下,将指定的属性键与给定值进行比较的筛选器。
+ 用于将指定属性键与给定值按定义比较运算进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
@@ -7874,7 +7874,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应介于 1 到 50 之间(含两端)。
+ 返回结果的最大数量。该数量应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -7882,7 +7882,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -7902,7 +7902,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1,尝试返回的结果越相关,但返回的结果数量可能更少。
- `Computer object { type }`
@@ -7910,7 +7910,7 @@
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ computer 工具的类型,始终为 `computer`.
- `"computer"`
@@ -7948,12 +7948,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解网页搜索工具
+ 通过互联网搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为以下之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -7961,7 +7961,7 @@
- `external_web_access: optional boolean`
- 允许 网页搜索进行实时互联网访问。如果省略,默认值为 true。当值为 false 时,网页搜索工具将以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 访问实时互联网。省略时默认为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -7969,14 +7969,14 @@
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 同时允许所提供域名的子域名。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -7994,7 +7994,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -8002,7 +8002,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -8017,7 +8017,7 @@
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 此 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -8035,21 +8035,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许的工具名称列表或过滤对象。
- `McpAllowedTools = array of string`
- 一个字符串数组,包含允许的工具名称
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -8057,26 +8057,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,配合自定义 MCP
+ 服务器 URL 或服务连接器使用。你的应用
必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其
- `server_url`, `connector_id`,或 `tunnel_id` 中之一即可。详细了解
- 关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
+ 关于服务连接器 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持 `connector_id` 的值为:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -8100,28 +8100,28 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 头,用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 中哪些工具需要审批。
+ 指定 MCP 服务器的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选对象
- 需要审批的工具。
+ 指定 MCP 服务器的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤对象
+ 。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -8129,13 +8129,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的过滤对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据或是否为只读。如果一个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此筛选条件。
+ 指示工具是否修改数据或为只读。如果某个
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ ,它将匹配此过滤器。
- `tool_names: optional array of string`
@@ -8143,7 +8143,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
+ 为所有工具指定单个审批策略。其一为 `always` 或
`never`. 当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -8157,23 +8157,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下之一 `server_url`, `connector_id`,或
- `tunnel_id` 。
+ MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ `tunnel_id` 之一。
- `tunnel_id: optional string`
- 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一
- `server_url`, `connector_id`,或 `tunnel_id` 。
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。必须提供
+ `server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回复的工具。
+ 用于运行 Python 代码以帮助生成对提示词回应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是用于指定
- 可供代码使用的已上传文件 ID 以及一个
- 可选 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 用于指定可供你代码使用的已上传文件 ID 的对象,以及一个
+ 可选的 `memory_limit` 设置。
- `string`
@@ -8181,7 +8181,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可指定要运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -8191,7 +8191,7 @@
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你代码使用的已上传文件的可选列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -8231,7 +8231,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 该工具的类型。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -8247,7 +8247,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 是否生成新图像或编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -8258,9 +8258,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于
+ 支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -8271,7 +8271,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,对于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所需的投入程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -8279,20 +8279,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (字符串,可选)以及 `file_id` (字符串,可选)。
+ 用于修复(inpainting)的可选遮罩。包含 `image_url`
+ (string,可选)和 `file_id` (string,可选)。
- `file_id: optional string`
- 蒙版图像的文件 ID。
+ 遮罩图像的文件 ID。
- `image_url: optional string`
- Base64 编码的蒙版图像。
+ Base64 编码的遮罩图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -8301,7 +8301,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型,取值为以下之一: `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -8318,7 +8318,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的审核级别。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -8330,7 +8330,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式,取值为以下之一: `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -8341,11 +8341,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
+ 在流式模式下要生成的中间图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图像的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量,取值为以下之一: `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -8358,13 +8358,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且所请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受 GPT 图像模型支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定的任意分辨率,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率属于实验性功能,且最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 适用于允许自动调整大小的模型。对于 `dall-e-2`,使用其中之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -8416,7 +8416,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -8434,7 +8434,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -8442,11 +8442,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -8454,11 +8454,11 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如 `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 此命名空间内可用的函数/自定义工具。
+ 该命名空间内可用的函数/自定义工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -8478,19 +8478,19 @@
- `defer_loading: optional boolean`
- 是否应延迟该函数并通过工具搜索来发现。
+ 该函数是否应被延迟并通过工具搜索被发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 一个 JSON Schema,用于描述此函数工具的字符串输出中所编码的 JSON 值。该描述不适用于 content 数组输出。
+ 描述该函数工具字符串输出中所编码 JSON 值的 JSON Schema。此项不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。若省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。若省略,当 响应接口 在 schema 兼容时会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -8498,7 +8498,7 @@
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -8516,7 +8516,7 @@
- `defer_loading: optional boolean`
- 该工具是否应被延迟,并通过工具搜索被发现。
+ 是否应延迟此工具,并通过工具搜索发现它。
- `description: optional string`
@@ -8524,11 +8524,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 该工具的类型。始终为 `namespace`.
- `"namespace"`
@@ -8538,17 +8538,17 @@
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 该工具的类型。始终为 `tool_search`.
- `"tool_search"`
- `description: optional string or null`
- 展示给模型的、用于客户端执行的工具搜索工具的描述。
+ 展示给模型、用于客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -8556,15 +8556,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网络上搜索用于回复的相关结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为以下之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -8578,7 +8578,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 搜索使用的上下文窗口空间的高级指导。取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指导。取值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -8588,7 +8588,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -8602,7 +8602,7 @@
- `country: optional string or null`
- 用户所在国家/地区的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 用户的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -8610,7 +8610,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
+ 该 [IANA timezone](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -8618,7 +8618,7 @@
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 该工具的类型。始终为 `apply_patch`.
- `"apply_patch"`
@@ -8632,12 +8632,12 @@
- `top_p: number or null`
- 一种替代带温度采样的方法,称为核采样,
- 在该方法中,模型会考虑概率质量排名前 top_p 的标记的结果。
- 因此 0.1 表示仅考虑概率质量排名前 10% 的标记。
- 包含的标记。
+ 一种温度采样的替代方法,称为核采样,
+ 模型只考虑 top_p 概率质量所对应的 token 结果。
+ 因此 0.1 表示只考虑组成前 10% 概率质量的 token。
+ 。
- We generally recommend altering this or `temperature` but not both.
+ 我们通常建议更改此设置或 `temperature` ,但不要同时更改两者。
- `background: optional boolean or null`
@@ -8646,32 +8646,32 @@
- `completed_at: optional number or null`
- 此次 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅当状态为 `completed`.
+ 此 Response 完成时的 Unix 时间戳(以秒为单位)。
+ 仅在状态为 `completed`.
- `conversation: optional object { id } or null`
- 该响应所属的对话。此次响应中的输入项和输出项已自动添加到该对话中。
+ 此 Response 所属的对话。该 Response 的输入项和输出项已自动添加到此对话中。
- `id: string`
- 与此响应关联的对话的唯一 ID。
+ 与此 Response 关联的对话的唯一 ID。
- `max_output_tokens: optional number or null`
- 响应可生成的 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
+ 响应可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 一次响应中可以处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型后续尝试调用工具的请求将被忽略。
+ 响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非单个工具。模型任何进一步调用工具的尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入和输出的审核结果(如果请求了已审核的补全)。
+ 响应输入和输出的审核结果(如果请求了被审核的补全)。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 针对响应输入的审核。
+ 响应输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -8679,7 +8679,7 @@
- `categories: map[boolean]`
- 从审核类别到布尔值的字典;如果输入被标记为属于该类别,则为 True。
+ 一个将审核类别映射到布尔值的字典,如果输入在该类别下被标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
@@ -8691,19 +8691,19 @@
- `category_scores: map[number]`
- 从审核类别到分数的字典。
+ 一个将审核类别映射到分数的字典。
- `flagged: boolean`
- 指示内容是否被任何类别标记的布尔值。
+ 一个布尔值,指示内容是否被任何类别标记。
- `model: string`
- 生成此结果所用的审核模型。
+ 生成此结果的审核模型。
- `type: "moderation_result"`
- 对象类型,始终为 `moderation_result` ,表示成功的审核结果。
+ 对象类型,始终为 `moderation_result` (针对成功的审核结果)。
- `"moderation_result"`
@@ -8721,13 +8721,13 @@
- `type: "error"`
- 对象类型,始终为 `error` ,表示审核失败。
+ 对象类型,始终为 `error` (针对审核失败)。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 针对响应输出的审核。
+ 响应输出的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
@@ -8735,7 +8735,7 @@
- `categories: map[boolean]`
- 从审核类别到布尔值的字典;如果输入被标记为属于该类别,则为 True。
+ 一个将审核类别映射到布尔值的字典,如果输入在该类别下被标记则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
@@ -8747,19 +8747,19 @@
- `category_scores: map[number]`
- 从审核类别到分数的字典。
+ 一个将审核类别映射到分数的字典。
- `flagged: boolean`
- 指示内容是否被任何类别标记的布尔值。
+ 一个布尔值,指示内容是否被任何类别标记。
- `model: string`
- 生成此结果所用的审核模型。
+ 生成此结果的审核模型。
- `type: "moderation_result"`
- 对象类型,始终为 `moderation_result` ,表示成功的审核结果。
+ 对象类型,始终为 `moderation_result` (针对成功的审核结果)。
- `"moderation_result"`
@@ -8777,21 +8777,21 @@
- `type: "error"`
- 对象类型,始终为 `error` ,表示审核失败。
+ 对象类型,始终为 `error` (针对审核失败)。
- `"error"`
- `output_text: optional string or null`
- SDK-only convenience property that contains the aggregated text output
- from all `output_text` 数组中的 `output` 项,如果存在的话。
+ SDK 专属的便捷属性,包含汇总后的文本输出
+ 来自所有 `output_text` items in the `output` 数组中的项(如果有的话)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。使用它来
+ 模型上一次响应的唯一 ID。使用它可以
创建多轮对话。详细了解
- [对话状态](/docs/guides/conversation-state)。不能与 `conversation`.
+ [conversation state](/docs/guides/conversation-state)。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
@@ -8804,9 +8804,9 @@
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的映射值,用于替换你
- 提示中的变量。替换值可以是字符串,也可以是其他
- 响应输入类型,例如图片或文件。
+ 用于在你的
+ 提示中替换变量的值映射。替换值可以是字符串,也可以是其他
+ 响应输入类型,例如图像或文件。
- `string`
@@ -8850,18 +8850,18 @@
- `prompt_cache_retention: optional "in_memory" or "24h" or null`
- 已弃用。请使用 `prompt_cache_options.ttl` instead.
+ 已弃用。请使用 `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` 。
+ 字段相互独立,不会相互影响。
+ 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来模型,仅 `24h` 。
- 对于同时支持 `in_memory` 和 `24h`,的旧模型,默认值取决于你的组织的数据保留策略:
+ 对于同时支持两者的较旧模型 `in_memory` 和 `24h`,默认值取决于你所在组织的数据保留策略:
- - 未启用 ZDR 的组织默认为 `24h`.
- - 启用 ZDR 的组织默认为 `in_memory` 当 `prompt_cache_retention` 未指定时。
+ - 未启用 ZDR 的组织默认使用 `24h`.
+ - 已启用 ZDR 的组织默认使用 `in_memory` 当 `prompt_cache_retention` 未指定时。
- `"in_memory"`
@@ -8869,20 +8869,18 @@
- `reasoning: optional Reasoning or null`
- **gpt-5 和 o 系列模型仅**
-
- 针对
+ 的配置选项
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续轮次中哪些推理项会被回传给模型。
- 如果省略或设置为 `auto`,则由模型决定上下文模式。
+ 控制在后续轮次中哪些推理项会被渲染回模型。
+ 如果省略或设置为 `auto`,模型将自行决定上下文模式。
`gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
`current_turn`.
- 当在响应中返回时,这是该响应使用的有效推理上下文模式
- 。
+ 在响应中返回时,这是该响应所使用的有效推理上下文模式
+ 用于该响应。
- `"auto"`
@@ -8892,13 +8890,13 @@
- `effort: optional ReasoningEffort or null`
- 对推理模型在推理上的投入程度进行约束。目前支持
- 的取值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入程度可以使响应更快,并减少在响应中用于推理的 token 数量。并非所有推理模型都支持每个
+ 约束推理模型在推理上的投入程度。当前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以让响应更快,并减少响应中用于推理的
+ token 数量。并非所有推理模型都支持每个
取值。请参阅
- 推理指南
- [了解针对具体模型的支持情况。](https://platform.openai.com/docs/guides/reasoning)
- 以获取模型特定的支持信息。
+ [推理指南](https://platform.openai.com/docs/guides/reasoning)
+ 了解特定模型的支持情况。
- `"none"`
@@ -8916,11 +8914,11 @@
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已弃用:** 请使用 `summary` instead.
+ **已弃用:** 请使用 `summary` 。
- 模型执行的推理摘要。这可以用于
- 调试和理解模型的推理过程。
- 以下之一: `auto`, `concise`,或 `detailed`.
+ 模型执行推理的摘要。这可以
+ 有助于调试和理解模型的推理过程。
+ 以下之一 `auto`, `concise`,或 `detailed`.
- `"auto"`
@@ -8932,7 +8930,7 @@
控制请求的推理执行模式。
- 当在响应中返回时,这是有效的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
@@ -8940,7 +8938,7 @@
控制请求的推理执行模式。
- 当在响应中返回时,这是有效的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -8948,11 +8946,11 @@
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型执行的推理摘要。这可以用于
- 调试和理解模型的推理过程。
- 以下之一: `auto`, `concise`,或 `detailed`.
+ 模型执行推理的摘要。这可以
+ 有助于调试和理解模型的推理过程。
+ 以下之一 `auto`, `concise`,或 `detailed`.
- `concise` 支持 `computer-use-preview` 模型以及之后的全部推理模型 `gpt-5`.
+ `concise` 受支持 `computer-use-preview` 模型以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -8962,21 +8960,21 @@
- `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).
- `service_tier: optional ServiceTier or null`
- 指定用于处理请求的处理类型。
+ 指定用于处理该请求的处理类型。
- - 如果设置为 '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` 。
- - 如果设置为 'ultrafast',则请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过其服务的响应将显示 `service_tier=ultrafast`.
- - 当未设置时,默认行为为 'auto'。
+ - 如果设置为 '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` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级提供服务的响应将显示 `service_tier=ultrafast`.
+ - 未设置时,默认行为为 'auto'。
- 当 `service_tier` 参数被设置时,响应体中将包含基于实际用于处理请求的处理模式的 `service_tier` 值。此响应值可能与参数中设置的值不同。
+ 当设置了 `service_tier` 参数时,响应体将包含基于实际用于处理该请求的处理模式所得到的 `service_tier` 值。该响应值可能与参数中设置的值不同。
- `"auto"`
@@ -8994,7 +8992,7 @@
- `status: optional ResponseStatus`
- 响应生成的状态。取值之一 `completed`, `failed`,
+ 响应生成的状态。取值为 `completed`, `failed`,
`in_progress`, `cancelled`, `queued`,或 `incomplete`.
- `"completed"`
@@ -9011,10 +9009,10 @@
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯文本
- 或结构化 JSON 数据。了解更多:
+ 模型文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多:
- - [文本输入与输出](/docs/guides/text)
+ - [文本输入和输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
@@ -9022,16 +9020,16 @@
用于指定模型必须输出的格式的对象。
配置 `{ "type": "json_schema" }` 可启用结构化输出,
- 从而确保模型匹配你提供的 JSON schema。详见
+ 从而确保模型匹配你提供的 JSON schema。更多信息请参阅
[结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含任何额外选项。
+ 默认格式为 `{ "type": "text" }` ,不包含其他选项。
- **不建议在 gpt-4o 及更新模型上使用:**
+ **不建议用于 gpt-4o 及更新模型:**
- 将值设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
- 可确保模型生成的消息是合法 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该字段。
+ 设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用它。
- `ResponseFormatText object { type }`
@@ -9046,7 +9044,7 @@
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ 详细了解 [结构化输出](/docs/guides/structured-outputs).
- `name: string`
@@ -9055,8 +9053,8 @@
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象形式描述。
- 了解如何构建 JSON 架构 [此处](https://json-schema.org/).
+ 响应格式的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON schema [此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -9066,23 +9064,23 @@
- `description: optional string`
- 对响应格式用途的描述,供模型用于
- 确定如何按该格式进行响应。
+ A description of what the response format is for, used by the model to
+ determine how to respond in the format.
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循在
- 字段中定义的 `schema` 确切架构。当使用
- `strict` 是 `true`。时,仅支持 JSON Schema 的一个子集。要了解更多信息,请阅读 [结构化输出
+ Whether to enable strict schema adherence when generating the output.
+ If set to true, the model will always follow the exact schema defined
+ in the `schema` 字段。仅支持 JSON Schema 的一个子集,
+ `strict` : `true`。有关详情,请参阅 [结构化输出
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 建议对支持 `json_schema` 的模型使用。建议对支持它的模型使用。注意,
- 模型在没有系统或用户消息指示的情况下不会生成 JSON
- 响应。
+ JSON 对象响应格式。一种较旧的生成 JSON 响应的方式。
+ 使用 `json_schema` 推荐用于支持它的模型。注意,
+ 在没有系统或用户消息指示的情况下,模型不会生成 JSON,
+ 。
- `type: "json_object"`
@@ -9092,8 +9090,8 @@
- `verbosity: optional "low" or "medium" or "high" or null`
- 限制模型响应的详细程度。较低的值将导致
- 值越小,回复越简洁;值越大,回复越冗长。
+ 约束模型响应的详细程度。较低的值将导致
+ 更简洁的响应,而较高的值将导致更详细的响应。
当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
@@ -9105,8 +9103,8 @@
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最大最可能
- token 数量,每个 token 都有一个对应的对数
+ 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最可能
+ token 的最大数量,每个 token 都附带对应的对数
概率。在某些情况下,返回的 token 数量可能少于
请求的数量。
@@ -9114,10 +9112,10 @@
用于模型响应的截断策略。
- - `auto`:如果此 Response 的输入超过
+ - `auto`:如果此 Response 的输入超出
模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小将超过模型的上下文窗口
+ 响应,以适配上下文窗口。
+ - `disabled` (默认):如果输入大小将超出模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -9126,8 +9124,8 @@
- `usage: optional ResponseUsage`
- 表示 token 使用情况的详细信息,包括输入 token、输出 token、
- 输出 token 的细分以及所使用的 token 总数。
+ 表示 token 使用详情,包括输入 token、输出 token、
+ 输出 token 的细分,以及使用的 token 总数。
- `input_tokens: number`
@@ -9139,12 +9137,12 @@
- `cache_write_tokens: number`
- 已写入缓存的输入 token 数量。
+ 写入缓存的输入 token 数量。
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [详细了解提示词缓存](/docs/guides/prompt-caching).
+ [详细了解 prompt 缓存](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -9164,13 +9162,13 @@
- `compute_units: optional number or null`
- 请求的计算单元。当前可用时为 null。
+ 本次请求的计算单元。当前可用时为 null。
- `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).
+ 用于通过更精细地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
### 示例
@@ -9197,7 +9195,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID/cancel \
"metadata": {
"foo": "string"
},
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"object": "response",
"output": [
{
@@ -9375,7 +9373,7 @@ curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-4o-2024-08-06",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
diff --git a/docs/zh/api/reference/resources/responses/methods/compact.md b/docs/zh/api/reference/resources/responses/methods/compact.md
index 9f4e666..1034c3a 100644
--- a/docs/zh/api/reference/resources/responses/methods/compact.md
+++ b/docs/zh/api/reference/resources/responses/methods/compact.md
@@ -1,22 +1,22 @@
-> 完整文档索引请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。
+> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 来获取文档页面的 Markdown 版本。
## 压缩响应
**post** `/responses/compact`
-压缩一段对话。返回一个压缩后的响应对象。
+压缩对话。返回一个压缩后的响应对象。
-了解在 [对话状态指南](/docs/guides/conversation-state#managing-the-context-window)。中何时以及如何压缩长时间运行的对话。有关兼容 ZDR 的压缩详情,请参阅 [压缩(高级)](/docs/guides/conversation-state#compaction-advanced).
+了解在何时以及如何压缩长时间运行的对话,请参阅 [对话状态指南](/docs/guides/conversation-state#managing-the-context-window).关于兼容 ZDR 的压缩细节,请参阅 [压缩(高级)](/docs/guides/conversation-state#compaction-advanced).
-### 正文参数
+### 请求体参数
- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string or null`
- 用于生成响应的模型 ID,例如 `gpt-5` 或 `o3`。OpenAI 提供种类丰富的模型,在能力、性能特征和价格上各有不同。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI 提供多种具有不同能力、性能特征和价格区间的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用模型。
- `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`
- 用于生成响应的模型 ID,例如 `gpt-5` 或 `o3`。OpenAI 提供种类丰富的模型,在能力、性能特征和价格上各有不同。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`。OpenAI 提供多种具有不同能力、性能特征和价格区间的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用模型。
- `"gpt-5.6-sol"`
@@ -226,41 +226,41 @@
- `input: optional string or array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more or null`
- 输入到模型的文本、图像或文件,用于生成响应
+ 提供给模型的文本、图像或文件输入,用于生成响应
- `string`
- 输入到模型的文本,相当于一个带有 `user` 角色的文本输入。
+ 提供给模型的文本输入,等同于带有 `user` 角色的文本输入。
- `array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 由一个或多个输入项组成的列表,包含不同的内容类型,输入到模型中。
+ 提供给模型的一个或多个输入项的列表,包含不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
- 带有角色的消息输入到模型中,角色指示指令遵循的
- 优先级。使用 `developer` 或 `system` 角色给出的指令优先于使用
- 角色给出的指令。使用 `user` 角色的消息假定为模型在先前
- `assistant` 交互中生成的内容。
- 。
+ 提供给模型的消息输入,带有表示指令遵循
+ 层级的角色。使用 `developer` 或 `system` 角色给出的指令优先级高于使用
+ 角色给出的指令。带有 `user` 角色的消息被假定为在之前的
+ `assistant` 交互中由模型生成。
+ 中由模型生成。
- `content: string or ResponseInputMessageContentList`
- 输入到模型的文本、图像或音频,用于生成响应。
- 也可以包含先前助手生成的响应。
+ 提供给模型的文本、图像或音频输入,用于生成响应。
+ 也可以包含之前的助手响应。
- `TextInput = string`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 由一个或多个输入项组成的列表,包含不同的内容,输入到模型中
+ 提供给模型的一个或多个输入项的列表,包含不同的内容
类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `text: string`
@@ -274,7 +274,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -284,11 +284,11 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解关于 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的图像细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `"low"`
@@ -306,15 +306,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -334,7 +334,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 会使用高质量渲染,可能会增加输入 token 消耗。使用 `low` 进行低成本渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -348,7 +348,7 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string`
@@ -360,7 +360,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -370,7 +370,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值之一 `user`, `assistant`, `system`,或
+ 消息输入的角色。取值之一为 `user`, `assistant`, `system`,或
`developer`.
- `"user"`
@@ -383,9 +383,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- 对于 `gpt-5.3-codex` 及更高模型,在发送后续请求时,请保留并重新发送
- 阶段在所有助手消息上 —— 省略它可能会降低性能。不用于用户消息。
+ 将消息标记为 `assistant` 中间评论(`commentary`)或最终回答(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,保留并重新发送
+ 阶段到所有助手消息上 —— 丢弃它可能会降低性能。不用于用户消息。
- `"commentary"`
@@ -393,24 +393,24 @@
- `type: optional "message"`
- 消息输入的类型,恒为 `message`.
+ 消息输入的类型。始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 带有角色的消息输入到模型中,角色指示指令遵循的
- 优先级。使用 `developer` 或 `system` 角色给出的指令优先于使用
- 角色给出的指令。使用 `user` 角色的文本输入。
+ 提供给模型的消息输入,带有表示指令遵循
+ 层级的角色。使用 `developer` 或 `system` 角色给出的指令优先级高于使用
+ 角色给出的指令。带有 `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 由一个或多个输入项组成的列表,包含不同的内容,输入到模型中
+ 提供给模型的一个或多个输入项的列表,包含不同的内容
类型。
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值之一 `user`, `system`,或 `developer`.
+ 消息输入的角色。取值之一为 `user`, `system`,或 `developer`.
- `"user"`
@@ -420,8 +420,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 条目的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -431,7 +431,7 @@
- `type: optional "message"`
- 消息输入的类型,恒设为 `message`.
+ 消息输入的类型。始终设置为 `message`.
- `"message"`
@@ -449,7 +449,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的一段文本输出。
+ 模型的一条文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -457,7 +457,7 @@
- `FileCitation object { file_id, filename, index, type }`
- 对某个文件的引用。
+ 对一个文件的引用。
- `file_id: string`
@@ -465,11 +465,11 @@
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 文件列表中该文件的索引。
- `type: "file_citation"`
@@ -479,15 +479,15 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网页资源引用。
+ 用于生成模型回复的网页资源引用。
- `end_index: number`
- 消息中 URL 引用的最后一个字符的索引。
+ 消息中 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用的第一个字符的索引。
+ 消息中 URL 引用第一个字符的索引。
- `title: string`
@@ -505,7 +505,7 @@
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
- 用于生成模型响应的容器文件引用。
+ 用于生成模型回复的容器文件引用。
- `container_id: string`
@@ -513,7 +513,7 @@
- `end_index: number`
- 消息中容器文件引用的最后一个字符的索引。
+ 消息中容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -521,11 +521,11 @@
- `filename: string`
- 被引用的容器文件的文件名。
+ 所引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的第一个字符的索引。
+ 消息中容器文件引用第一个字符的索引。
- `type: "container_file_citation"`
@@ -543,7 +543,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 文件列表中该文件的索引。
- `type: "file_path"`
@@ -579,11 +579,11 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型给出的拒绝回答。
+ 模型的拒绝回复。
- `refusal: string`
- 来自模型的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
@@ -599,8 +599,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。其值为 `in_progress`, `completed`,或
- `incomplete`。之一。当输入项通过 API 返回时填充。
+ 输入消息的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回输入项时填充。
- `"in_progress"`
@@ -616,9 +616,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
- 对于 `gpt-5.3-codex` 及更高模型,在发送后续请求时,请保留并重新发送
- 阶段在所有助手消息上 —— 省略它可能会降低性能。不用于用户消息。
+ 将消息标记为 `assistant` 中间评论(`commentary`)或最终回答(`final_answer`).
+ 对于类似 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,保留并重新发送
+ 阶段到所有助手消息上 —— 丢弃它可能会降低性能。不用于用户消息。
- `"commentary"`
@@ -635,11 +635,11 @@
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。其值为 `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -664,11 +664,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 个键值对集合。这可以
- 用于以结构化格式存储有关对象的额外信息,
- 并通过 API 或控制台查询对象。键为字符串,
- 最大长度为 64 个字符。值为字符串,最大长度
- 为 512 个字符,或为布尔值或数字。
+ 可以附加到对象的 16 组键值对。这对于以结构化
+ 格式存储对象的附加信息,以及通过 API 或仪表板查询对象非常有用。键为字符串,
+ 最大长度为 64 个字符。值为字符串,最大
+ 长度为 512 个字符、布尔值或数字。
+ 长度为 512 个字符、布尔值或数字。
- `string`
@@ -686,7 +686,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,取值在 0 到 1 之间。
- `text: optional string`
@@ -694,8 +694,8 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。参阅
- [computer use 指南](/docs/guides/tools-computer-use) 了解更多信息。
+ 对计算机使用工具的工具调用。参见
+ [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
@@ -703,7 +703,7 @@
- `call_id: string`
- 用于在响应工具调用时携带输出的标识符。
+ 在向工具调用返回输出时所使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -719,12 +719,12 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -734,7 +734,7 @@
- `type: "computer_call"`
- 计算机调用的类型,始终为 `computer_call`.
+ 计算机调用的类型。始终为 `computer_call`.
- `"computer_call"`
@@ -748,7 +748,7 @@
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在点击时按下了哪个鼠标按键,取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示在点击时按下了哪个鼠标按钮。取值之一为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -762,17 +762,17 @@
- `type: "click"`
- 指定事件类型。对于点击操作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,该属性始终为 `click`.
- `"click"`
- `x: number`
- 点击发生位置的 x 坐标。
+ 发生点击的 x 坐标。
- `y: number`
- 点击发生位置的 y 坐标。
+ 发生点击的 y 坐标。
- `keys: optional array of string or null`
@@ -835,7 +835,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的按键集合。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
@@ -859,11 +859,11 @@
- `x: number`
- 要移动到的 x 坐标。
+ 要移至的 x 坐标。
- `y: number`
- 要移动到的 y 坐标。
+ 要移至的 y 坐标。
- `keys: optional array of string or null`
@@ -935,8 +935,8 @@
- `actions: optional ComputerActionList`
- 的扁平化批量操作 `computer_use`。每个操作都包含一个
- `type` 鉴别器字段以及操作特有的字段。
+ 针对 `computer_use`。的扁平化批量操作。每个操作都包含一个
+ `type` 鉴别字段以及操作专属字段。
- `Click object { button, type, x, 2 more }`
@@ -952,7 +952,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的按键集合。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -980,7 +980,7 @@
- `call_id: string`
- 产生该输出的计算机工具调用的 ID。
+ 生成该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
@@ -995,7 +995,7 @@
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -1013,7 +1013,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 报告的安全检查。
+ 已被开发者确认的 API 报告的安全检查。
- `id: string`
@@ -1025,11 +1025,11 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 待处理安全检查的详细信息。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。其值为 `in_progress`, `completed`,或 `incomplete`。之一。当输入项通过 API 返回时填充。
+ 输入消息的状态。取值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回输入项时填充。
- `"in_progress"`
@@ -1039,21 +1039,21 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。请参阅
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参阅
+ [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 网页搜索 工具调用的唯一 ID。
+ 网页搜索工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
- 包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
+ 描述此次 网页搜索调用中所执行的具体操作的对象。
+ 包含模型使用网页方式的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索 查询。
+ 操作类型 "search" - 执行 网页搜索查询。
- `type: "search"`
@@ -1075,7 +1075,7 @@
- `type: "url"`
- 来源的类型。始终为 `url`.
+ 来源类型。始终为 `url`.
- `"url"`
@@ -1085,7 +1085,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的某个特定 URL。
+ 操作类型 "open_page" - 从搜索结果中打开特定 URL。
- `type: "open_page"`
@@ -1099,11 +1099,11 @@
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 操作类型 "find_in_page":在已加载页面内搜索匹配模式。
- `pattern: string`
- 要在页面内搜索的匹配模式或文本。
+ 在页面中要搜索的模式或文本。
- `type: "find_in_page"`
@@ -1113,7 +1113,7 @@
- `url: string`
- 搜索该匹配模式对应的页面 URL。
+ 搜索该模式的页面的 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -1135,7 +1135,7 @@
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 用于运行函数的工具调用。详见
+ 用于运行函数的工具调用。请参阅
[函数调用指南](/docs/guides/function-calling) 了解更多信息。
- `arguments: string`
@@ -1186,8 +1186,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1201,7 +1201,7 @@
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -1209,11 +1209,11 @@
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `text: string`
@@ -1227,7 +1227,7 @@
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -1237,7 +1237,7 @@
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发送给模型的图像输入。了解关于 [图像输入](/docs/guides/vision)
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision)
- `type: "input_image"`
@@ -1247,19 +1247,19 @@
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的图像细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -1279,7 +1279,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 会使用高质量渲染,可能会增加输入 token 消耗。使用 `low` 进行低成本渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -1293,7 +1293,7 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string or null`
@@ -1305,7 +1305,7 @@
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -1321,7 +1321,7 @@
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ 函数工具调用的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: optional string or null`
@@ -1353,15 +1353,15 @@
- `name: optional string or null`
- 生成该输出的工具的名称。
+ 生成该输出的工具名称。
- `namespace: optional string or null`
- 生成该输出的工具的命名空间。
+ 生成该输出的工具命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 该条目的状态,取值为 `in_progress`, `completed`,或 `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1391,7 +1391,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -1415,19 +1415,19 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 用于描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 此函数工具是否启用严格的参数校验。
- `type: "function"`
@@ -1445,23 +1445,23 @@
- `defer_loading: optional boolean`
- 此函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否被延迟并通过工具搜索加载。
- `description: optional string or null`
- 对该函数的描述。供模型用于判断是否调用该函数。
+ 函数的描述,供模型用来决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。通常为 `file_search`.
- `"file_search"`
@@ -1471,11 +1471,11 @@
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用指定的比较运算将指定的属性键与给定值进行比较的筛选器。
+ 用于通过定义的比较操作将指定的属性键与给定值进行比较的筛选条件。
- `key: string`
@@ -1485,14 +1485,14 @@
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`: 等于
- - `ne`: 不等于
- - `gt`: 大于
- - `gte`: 大于或等于
- - `lt`: 小于
- - `lte`: 小于或等于
- - `in`: 属于
- - `nin`: 不属于
+ - `eq`:等于
+ - `ne`:不等于
+ - `gt`:大于
+ - `gte`:大于或等于
+ - `lt`:小于
+ - `lte`:小于或等于
+ - `in`:包含于
+ - `nin`:不包含于
- `"eq"`
@@ -1528,15 +1528,15 @@
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。各项可以为 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用指定的比较运算将指定的属性键与给定值进行比较的筛选器。
+ 用于通过定义的比较操作将指定的属性键与给定值进行比较的筛选条件。
- `unknown`
@@ -1550,7 +1550,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应在 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -1558,15 +1558,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,互逆排序融合(reciprocal rank fusion)中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于控制互逆排名融合(reciprocal rank fusion)在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
- `embedding_weight: number`
- 互逆排序融合中嵌入的权重。
+ 互逆排名融合中嵌入的权重。
- `text_weight: number`
- 互逆排序融合中文本的权重。
+ 互逆排名融合中文本匹配的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -1578,29 +1578,29 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试只返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,取值范围为 0 到 1。越接近 1 的数值会尝试仅返回相关性最高的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示屏的高度。
- `display_width: number`
- 计算机显示器的宽度。
+ 计算机显示屏的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -1618,18 +1618,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型,取值之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1637,7 +1637,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
+ 允许网页搜索实时访问互联网。省略时默认值为 true。当值为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -1645,14 +1645,14 @@
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样允许。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -1662,7 +1662,7 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
@@ -1670,7 +1670,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -1678,22 +1678,22 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程模型上下文协议
- (MCP)服务器为模型提供对其他工具的访问。 [了解有关 MCP 的更多信息](/docs/guides/tools-remote-mcp).
+ (MCP)服务器,为模型提供对其他工具的访问能力。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -1715,35 +1715,35 @@
- `McpAllowedTools = array of string`
- 允许的工具名称组成的字符串数组
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 可与远程 MCP 服务器配合使用的 OAuth 访问令牌,可用于
- 自定义 MCP 服务器 URL 或服务连接器。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可搭配
+ 自定义 MCP 服务器 URL 或服务连接器使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
- 服务连接器 [请参见此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些连接器。必须提供其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 。了解更多
+ 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持的 `connector_id` 值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -1776,52 +1776,52 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 的哪些工具需要批准。
+ 指定 MCP 服务器中哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选对象
- 需要批准的。
+ 指定 MCP 服务器中哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的筛选器对象
+ ,这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单个批准策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要批准。当设置为
- 设置为 `never`,时,所有工具都不需要批准。
+ 为所有工具指定统一的审批策略。可选值之一 `always` 或
+ `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -1829,21 +1829,21 @@
- `server_description: optional string`
- MCP server 的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP server 的 URL。以下之一 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。以下之一 `server_url`, `connector_id`,或
`tunnel_id` 必须提供。
- `tunnel_id: optional string`
- 用于代替直接 server URL 的安全 MCP 隧道 ID。以下之一
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。以下之一
`server_url`, `connector_id`,或 `tunnel_id` 必须提供。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示词响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
@@ -1857,7 +1857,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要用于运行代码的文件 ID。
- `type: "auto"`
@@ -1897,17 +1897,17 @@
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当类型为时允许访问的域名列表 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域发出站网络访问。始终为 `allowlist`.
+ 仅允许向指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 针对允许列表中域的可选域作用域密钥。
+ 用于已加入白名单域的可选域范围密钥。
- `domain: string`
@@ -1955,7 +1955,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑已有图像。默认值: `auto`.
- `"generate"`
@@ -1966,9 +1966,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持功能处于预览阶段。当使用
+ `opaque`,或 `auto`。之一。受支持的 GPT Image 模型可使用透明背景。对于
+ 受支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1979,7 +1979,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不受支持于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型中受支持,在 `gpt-image-1-mini`。中不受支持。支持的值包括 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -2049,7 +2049,7 @@
- `partial_images: optional number`
- 流式模式下要生成的中间图像数量,范围从 0(默认值)到 3。
+ 在流式模式下要生成的中间图片数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -2066,13 +2066,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -2116,7 +2116,7 @@
- `type: "container_auto"`
- 自动为本次请求创建一个容器
+ 为此请求自动创建一个容器
- `"container_auto"`
@@ -2146,13 +2146,13 @@
- `skills: optional array of SkillReference or InlineSkill`
- 一个可选的技能列表,按 ID 或内联数据引用。
+ 通过 ID 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
- `skill_id: string`
- 被引用技能的 ID。
+ 所引用技能的 ID。
- `type: "skill_reference"`
@@ -2176,7 +2176,7 @@
- `source: InlineSkillSource`
- 内联技能载荷
+ 内联技能负载
- `data: string`
@@ -2184,13 +2184,13 @@
- `media_type: "application/zip"`
- 内联技能载荷的媒体类型。必须为 `application/zip`.
+ 内联技能负载的媒体类型,必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能源的类型。必须为 `base64`.
+ 内联技能来源的类型,必须为 `base64`.
- `"base64"`
@@ -2210,7 +2210,7 @@
- `skills: optional array of LocalSkill`
- 一个可选的技能列表。
+ 可选的技能列表。
- `description: string`
@@ -2228,21 +2228,21 @@
- `container_id: string`
- 被引用容器的 ID。
+ 所引用容器的 ID。
- `type: "container_reference"`
- 引用通过 /v1/containers 端点创建的容器
+ 引用通过 /v1/containers 端点创建的容器。
- `"container_reference"`
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -2260,7 +2260,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -2268,7 +2268,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Text object { type }`
@@ -2290,7 +2290,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。其中之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -2312,7 +2312,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 用于工具调用中的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -2336,27 +2336,27 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这并不描述 content 数组输出。
+ 用于描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。该字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在架构兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,对于兼容的 schema,Responses 会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -2374,7 +2374,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -2382,7 +2382,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -2402,11 +2402,11 @@
- `description: optional string or null`
- 为客户端执行的工具搜索工具展示给模型的描述。
+ 展示给模型的、由客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -2418,11 +2418,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 该工具会在网页中搜索相关结果,用于在回复中使用。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索可在响应中使用的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型,取值之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -2436,7 +2436,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -2446,11 +2446,11 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
@@ -2460,7 +2460,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2468,7 +2468,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -2504,7 +2504,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -2534,19 +2534,19 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 用于描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 此函数工具是否启用严格的参数校验。
- `type: "function"`
@@ -2564,23 +2564,23 @@
- `defer_loading: optional boolean`
- 此函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否被延迟并通过工具搜索加载。
- `description: optional string or null`
- 对该函数的描述。供模型用于判断是否调用该函数。
+ 函数的描述,供模型用来决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。通常为 `file_search`.
- `"file_search"`
@@ -2590,19 +2590,19 @@
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用指定的比较运算将指定的属性键与给定值进行比较的筛选器。
+ 用于通过定义的比较操作将指定的属性键与给定值进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应在 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -2610,15 +2610,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,互逆排序融合(reciprocal rank fusion)中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于控制互逆排名融合(reciprocal rank fusion)在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
- `embedding_weight: number`
- 互逆排序融合中嵌入的权重。
+ 互逆排名融合中嵌入的权重。
- `text_weight: number`
- 互逆排序融合中文本的权重。
+ 互逆排名融合中文本匹配的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -2630,29 +2630,29 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试只返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,取值范围为 0 到 1。越接近 1 的数值会尝试仅返回相关性最高的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示屏的高度。
- `display_width: number`
- 计算机显示器的宽度。
+ 计算机显示屏的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -2670,18 +2670,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型,取值之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -2689,7 +2689,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
+ 允许网页搜索实时访问互联网。省略时默认值为 true。当值为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -2697,14 +2697,14 @@
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样允许。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -2714,7 +2714,7 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
@@ -2722,7 +2722,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2730,22 +2730,22 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程模型上下文协议
- (MCP)服务器为模型提供对其他工具的访问。 [了解有关 MCP 的更多信息](/docs/guides/tools-remote-mcp).
+ (MCP)服务器,为模型提供对其他工具的访问能力。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -2767,35 +2767,35 @@
- `McpAllowedTools = array of string`
- 允许的工具名称组成的字符串数组
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 可与远程 MCP 服务器配合使用的 OAuth 访问令牌,可用于
- 自定义 MCP 服务器 URL 或服务连接器。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可搭配
+ 自定义 MCP 服务器 URL 或服务连接器使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
- 服务连接器 [请参见此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些连接器。必须提供其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 。了解更多
+ 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持的 `connector_id` 值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -2828,52 +2828,52 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 的哪些工具需要批准。
+ 指定 MCP 服务器中哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选对象
- 需要批准的。
+ 指定 MCP 服务器中哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的筛选器对象
+ ,这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单个批准策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要批准。当设置为
- 设置为 `never`,时,所有工具都不需要批准。
+ 为所有工具指定统一的审批策略。可选值之一 `always` 或
+ `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -2881,21 +2881,21 @@
- `server_description: optional string`
- MCP server 的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP server 的 URL。以下之一 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。以下之一 `server_url`, `connector_id`,或
`tunnel_id` 必须提供。
- `tunnel_id: optional string`
- 用于代替直接 server URL 的安全 MCP 隧道 ID。以下之一
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。以下之一
`server_url`, `connector_id`,或 `tunnel_id` 必须提供。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示词响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
@@ -2909,7 +2909,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要用于运行代码的文件 ID。
- `type: "auto"`
@@ -2975,7 +2975,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑已有图像。默认值: `auto`.
- `"generate"`
@@ -2986,9 +2986,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持功能处于预览阶段。当使用
+ `opaque`,或 `auto`。之一。受支持的 GPT Image 模型可使用透明背景。对于
+ 受支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -2999,7 +2999,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不受支持于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型中受支持,在 `gpt-image-1-mini`。中不受支持。支持的值包括 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -3069,7 +3069,7 @@
- `partial_images: optional number`
- 流式模式下要生成的中间图像数量,范围从 0(默认值)到 3。
+ 在流式模式下要生成的中间图片数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -3086,13 +3086,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -3140,11 +3140,11 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -3162,7 +3162,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -3170,7 +3170,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
@@ -3182,7 +3182,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 用于工具调用中的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -3206,27 +3206,27 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这并不描述 content 数组输出。
+ 用于描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。该字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在架构兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,对于兼容的 schema,Responses 会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -3244,7 +3244,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -3252,7 +3252,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -3272,11 +3272,11 @@
- `description: optional string or null`
- 为客户端执行的工具搜索工具展示给模型的描述。
+ 展示给模型的、由客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -3288,11 +3288,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 该工具会在网页中搜索相关结果,用于在回复中使用。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索可在响应中使用的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型,取值之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -3306,7 +3306,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -3316,11 +3316,11 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
@@ -3330,7 +3330,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -3338,7 +3338,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -3370,10 +3370,10 @@
- `Reasoning object { id, summary, type, 3 more }`
- 对推理模型在生成回复时所使用的思维链的描述。
- 请确保在手动管理 `input` 时把这些项传给 Responses API
- 上下文的对话后续轮次中,
- [上下文](/docs/guides/conversation-state).
+ 推理模型在生成响应时使用的思维链描述。请务必将这些项包含在
+ 传回给 Responses API `input` 的输入中,以便在手动管理
+ 上下文时用于对话的后续轮次。
+ [管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -3385,7 +3385,7 @@
- `text: string`
- 模型截至目前的推理输出摘要。
+ 到目前为止模型推理输出的摘要。
- `type: "summary_text"`
@@ -3405,7 +3405,7 @@
- `text: string`
- 模型输出的推理文本。
+ 来自模型的推理文本。
- `type: "reasoning_text"`
@@ -3415,20 +3415,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此项,
- 针对由 `POST /v1/responses` 和 WebSocket
+ 推理项的加密内容。默认情况下会填充该字段
+ 用于通过 `POST /v1/responses` 和 WebSocket
`response.create` 请求返回的推理项。
- 在流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` (来自 `response.output_item.done` 事件)。
- 中的 `encrypted_content` 可能不完整。当使用
- `response.output_item.added` 或启用 Zero Data Retention 时,这一点尤其
- 重要。如果 `store` 是 `false` ,或使用 Zero Data Retention,这一点尤其重要。
+ 流式传输时,请在后续请求中使用已完成的推理项及其
+ `encrypted_content` 中的 `response.output_item.done` 事件。
+ 后续请求。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。这一点尤其
+ 重要,当 `store` 为 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -3438,7 +3438,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由该模型生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -3456,7 +3456,7 @@
- `ImageGenerationCall object { id, result, status, type }`
- 由模型发起的图像生成请求。
+ 模型发起的图像生成请求。
- `id: string`
@@ -3531,11 +3531,11 @@
- `url: string`
- 代码解释器输出的图像的 URL。
+ 代码解释器输出图像的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,以及 `failed`.
- `"in_progress"`
@@ -3555,7 +3555,7 @@
- `LocalShellCall object { id, action, call_id, 2 more }`
- 用于在本地 shell 上运行命令的工具调用。
+ 在本地 shell 上运行命令的工具调用。
- `id: string`
@@ -3571,29 +3571,29 @@
- `env: map[string]`
- 为命令设置的环境变量。
+ 为该命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型,始终为 `exec`.
+ 本地 shell 操作的类型。始终为 `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 命令的可选超时时间(毫秒)。
+ 该命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行命令时使用的可选用户。
+ 运行该命令所使用的可选用户。
- `working_directory: optional string or null`
- 在其中运行命令的可选工作目录。
+ 运行该命令的可选工作目录。
- `call_id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -3607,7 +3607,7 @@
- `type: "local_shell_call"`
- 本地 shell 调用的类型,始终为 `local_shell_call`.
+ 本地 shell 调用的类型。始终为 `local_shell_call`.
- `"local_shell_call"`
@@ -3617,7 +3617,7 @@
- `id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -3625,13 +3625,13 @@
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型,始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 该条目的状态,取值为 `in_progress`, `completed`,或 `incomplete`.
+ 该项的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3641,27 +3641,27 @@
- `ShellCall object { action, call_id, type, 4 more }`
- 表示执行一条或多条 shell 命令请求的工具。
+ 表示执行一个或多个 shell 命令请求的工具。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行该工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境运行的、有序的 shell 命令。
+ 由执行环境按顺序运行的 shell 命令。
- `max_output_length: optional number or null`
- 从合并后的 stdout 和 stderr 输出中捕获的最大 UTF-8 字符数。
+ 从合并的 stdout 和 stderr 输出中捕获的最大 UTF-8 字符数。
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的最长挂钟时间(毫秒)。
+ 允许 shell 命令运行的最大挂钟时间(毫秒)。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `type: "shell_call"`
@@ -3671,7 +3671,7 @@
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当此项通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3699,7 +3699,7 @@
- `environment: optional LocalEnvironment or ContainerReference or null`
- 用于执行 shell 命令的环境。
+ 执行 shell 命令的环境。
- `LocalEnvironment object { type, skills }`
@@ -3707,7 +3707,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。可选值包括 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。取值之一 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3717,15 +3717,15 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用流式输出的输出项。
+ 由 shell 工具调用发出的流式输出项。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 和 stderr 输出块,以及它们关联的结果。
+ 捕获的 stdout 和 stderr 输出块及其相关结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -3733,7 +3733,7 @@
- `Timeout object { type }`
- 表示该 shell 调用超出了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -3743,7 +3743,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已结束并返回了退出码。
+ 表示 shell 命令已执行完毕并返回了退出码。
- `exit_code: number`
@@ -3771,7 +3771,7 @@
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当该输出项通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当通过 API 返回此项时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3799,7 +3799,7 @@
- `max_output_length: optional number or null`
- 为该 shell 调用的合并输出捕获的最大 UTF-8 字符数。
+ 为此 shell 调用的 combined output 捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -3813,11 +3813,11 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示使用 diff 补丁创建、删除或更新文件的工具调用请求。
+ 表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 由模型生成的 apply patch 工具调用的唯一 ID。
+ 模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -3833,7 +3833,7 @@
- `path: string`
- 相对于工作区根目录的要创建的文件的路径。
+ 相对于工作区根目录的要创建文件的路径。
- `type: "create_file"`
@@ -3847,7 +3847,7 @@
- `path: string`
- 相对于工作区根目录的要删除文件的路径。
+ 相对于工作区根目录的要删除的文件路径。
- `type: "delete_file"`
@@ -3865,7 +3865,7 @@
- `path: string`
- 相对于工作区根目录的要更新文件的路径。
+ 相对于工作区根目录的要更新的文件路径。
- `type: "update_file"`
@@ -3875,7 +3875,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。值为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。取值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -3889,7 +3889,7 @@
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3917,15 +3917,15 @@
- `ApplyPatchCallOutput object { call_id, status, type, 3 more }`
- apply patch 工具调用产生的流式输出。
+ apply patch 工具调用发出的流式输出。
- `call_id: string`
- 由模型生成的 apply patch 工具调用的唯一 ID。
+ 模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。值为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。取值为 `completed` 或 `failed`.
- `"completed"`
@@ -3939,7 +3939,7 @@
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -3967,7 +3967,7 @@
- `output: optional string or null`
- 来自 apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
@@ -3975,7 +3975,7 @@
- `id: string`
- 此列表的唯一 ID。
+ 该列表的唯一 ID。
- `server_label: string`
@@ -3995,7 +3995,7 @@
- `annotations: optional unknown or null`
- 有关该工具的附加注释。
+ 关于该工具的附加注解。
- `description: optional string or null`
@@ -4009,11 +4009,11 @@
- `error: optional string or null`
- 当服务器无法列出工具时的错误消息。
+ 服务器无法列出工具时的错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 针对工具调用的人工审批请求。
+ 对工具调用的人工审批请求。
- `id: string`
@@ -4021,7 +4021,7 @@
- `arguments: string`
- 工具参数的 JSON 字符串。
+ 该工具的参数 JSON 字符串。
- `name: string`
@@ -4043,7 +4043,7 @@
- `approval_request_id: string`
- 正在答复的审批请求的 ID。
+ 正在回复的审批请求的 ID。
- `approve: boolean`
@@ -4065,7 +4065,7 @@
- `McpCall object { id, arguments, name, 6 more }`
- 对 MCP 服务器上某个工具的调用。
+ 对 MCP 服务器上工具的调用。
- `id: string`
@@ -4073,11 +4073,11 @@
- `arguments: string`
- 传递给工具的参数的 JSON 字符串。
+ 传递给该工具的参数 JSON 字符串。
- `name: string`
- 已运行的工具名称。
+ 已运行工具的名称。
- `server_label: string`
@@ -4092,11 +4092,11 @@
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(如有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -4132,7 +4132,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值为以下之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -4146,15 +4146,15 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,正被发回给模型。
+ 你代码中自定义工具调用的输出,被发回给模型。
- `call_id: string`
- 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
+ 调用 ID,用于将此自定义工具调用输出映射到自定义工具调用。
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 由你的代码生成的自定义工具调用输出。
+ 由你的代码产生的自定义工具调用的输出。
可以是字符串或输出内容列表。
- `StringOutput = string`
@@ -4163,15 +4163,15 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解关于 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -4185,7 +4185,7 @@
- `id: optional string`
- 该自定义工具调用输出在 OpenAI 平台中的唯一 ID。
+ 在 OpenAI 平台上自定义工具调用输出的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4221,11 +4221,11 @@
- `input: string`
- 模型生成的自定义工具调用的输入。
+ 由模型生成的自定义工具调用的输入。
- `name: string`
- 被调用的自定义工具的名称。
+ 正在调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -4235,7 +4235,7 @@
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台中的唯一 ID。
+ 在 OpenAI 平台上自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -4259,7 +4259,7 @@
- `namespace: optional string`
- 被调用的自定义工具的命名空间。
+ 正在调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
@@ -4285,7 +4285,7 @@
- `type: optional "item_reference" or null`
- 要引用的条目类型。始终 `item_reference`.
+ 要引用的条目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -4293,19 +4293,19 @@
- `id: string`
- 此程序条目的唯一 ID。
+ 该程序条目的唯一 ID。
- `call_id: string`
- 程序条目的稳定调用 ID。
+ 该程序条目的稳定调用 ID。
- `code: string`
- 由程序化工具调用执行的 JavaScript 源码。
+ 由程序化工具调用执行的 JavaScript 源代码。
- `fingerprint: string`
- 必须往返回传的不透明程序重放指纹。
+ 必须原样回传的不透明程序重放指纹。
- `type: "program"`
@@ -4317,15 +4317,15 @@
- `id: string`
- 此程序输出条目的唯一 ID。
+ 该程序输出条目的唯一 ID。
- `call_id: string`
- 程序条目的调用 ID。
+ 该程序条目的调用 ID。
- `result: string`
- 程序条目产生的结果。
+ 该程序条目生成的结果。
- `status: "completed" or "incomplete"`
@@ -4344,23 +4344,23 @@
- `instructions: optional string or null`
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一次响应中的指令不会延续到下一次响应。这让你可以在新响应中简单地替换系统(或开发者)消息。
+ 。当与 `previous_response_id`,一起使用时,上一次响应中的指令不会延续到下一次响应。这样可以方便地在新响应中替换系统(或开发者)消息。
- `previous_response_id: optional string or null`
- 上一次模型响应的唯一 ID。使用它来创建多轮对话。详细了解 [对话状态](/docs/guides/conversation-state)。无法与 `conversation`.
+ 上一次模型响应的唯一 ID。使用它来创建多轮对话。详细了解 [对话状态](/docs/guides/conversation-state)。不能与 `conversation`.
- `prompt_cache_key: optional string or null`
- 从提示缓存读取或写入时使用的键。
+ 读取或写入提示缓存时使用的密钥。
- `prompt_cache_options: optional object { mode, ttl } or null`
- 提示缓存的选项。支持 `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"`
@@ -4368,13 +4368,13 @@
- `ttl: optional "30m"`
- 应用于该请求所写入的每个隐式和显式缓存断点的最短生命周期。默认为 `30m`,这是当前唯一支持的值。后端可能会保留缓存条目更长时间。
+ 应用于该请求所写入的每个隐式和显式缓存断点的最短生存时间。默认为 `30m`,这是当前唯一支持的值。后端可能会将缓存条目保留更长时间。
- `"30m"`
- `prompt_cache_retention: optional "in_memory" or "24h" or null`
- 由该请求创建的提示缓存条目的保留时长。
+ 本次请求所创建的提示缓存条目的保留时长。
- `"in_memory"`
@@ -4382,8 +4382,8 @@
- `service_tier: optional "auto" or "default" or "fast" or 2 more or null`
- 指定用于处理该请求的处理类型。 - 若设置为 'auto',则请求将按照项目设置中配置的服务层级进行处理。除非另行配置,项目将使用 'default'。 - 若设置为 'default',则请求将按照所选模型的标准定价和性能进行处理。 - 若设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - 若要在请求级别启用 [Fast 模式](/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` 值。此响应值可能与该参数中设置的值不同。
+ 指定用于处理该请求的处理类型。 - 若设置为 'auto',则请求将使用项目设置中配置的服务层级。除非另行配置,项目将使用 'default'。 - 若设置为 'default',则请求将按所选模型的标准定价和性能进行处理。 - 若设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - 若要在请求级别启用 [Fast 模式](/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` 值。此响应值可能与参数中设置的值不同。
- `"auto"`
@@ -4395,7 +4395,7 @@
- `"priority"`
-### 返回
+### Returns
- `CompactedResponse object { id, created_at, object, 2 more }`
@@ -4405,7 +4405,7 @@
- `created_at: number`
- 创建压缩对话时的 Unix 时间戳(单位:秒)。
+ 创建压缩对话时的 Unix 时间戳(以秒为单位)。
- `object: "response.compaction"`
@@ -4419,7 +4419,7 @@
- `Message object { id, content, role, 3 more }`
- 与模型之间的消息。
+ 与模型之间发送或接收的消息。
- `id: string`
@@ -4427,11 +4427,11 @@
- `content: array of ResponseInputText or ResponseOutputText or TextContent or 6 more`
- 消息的内容
+ 消息内容
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `text: string`
@@ -4445,7 +4445,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -4455,7 +4455,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 模型的一段文本输出。
+ 模型的一条文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -4463,7 +4463,7 @@
- `FileCitation object { file_id, filename, index, type }`
- 对某个文件的引用。
+ 对一个文件的引用。
- `file_id: string`
@@ -4471,11 +4471,11 @@
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 文件在文件列表中的索引。
+ 文件列表中该文件的索引。
- `type: "file_citation"`
@@ -4485,15 +4485,15 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网页资源引用。
+ 用于生成模型回复的网页资源引用。
- `end_index: number`
- 消息中 URL 引用的最后一个字符的索引。
+ 消息中 URL 引用最后一个字符的索引。
- `start_index: number`
- 消息中 URL 引用的第一个字符的索引。
+ 消息中 URL 引用第一个字符的索引。
- `title: string`
@@ -4511,7 +4511,7 @@
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
- 用于生成模型响应的容器文件引用。
+ 用于生成模型回复的容器文件引用。
- `container_id: string`
@@ -4519,7 +4519,7 @@
- `end_index: number`
- 消息中容器文件引用的最后一个字符的索引。
+ 消息中容器文件引用最后一个字符的索引。
- `file_id: string`
@@ -4527,11 +4527,11 @@
- `filename: string`
- 被引用的容器文件的文件名。
+ 所引用容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的第一个字符的索引。
+ 消息中容器文件引用第一个字符的索引。
- `type: "container_file_citation"`
@@ -4549,7 +4549,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 文件列表中该文件的索引。
- `type: "file_path"`
@@ -4595,11 +4595,11 @@
- `SummaryTextContent object { text, type }`
- 来自模型的摘要文本。
+ 模型生成的摘要文本。
- `text: string`
- 模型截至目前的推理输出摘要。
+ 到目前为止模型推理输出的摘要。
- `type: "summary_text"`
@@ -4609,11 +4609,11 @@
- `ReasoningText object { text, type }`
- 来自模型的推理文本。
+ 模型生成的推理文本。
- `text: string`
- 模型输出的推理文本。
+ 来自模型的推理文本。
- `type: "reasoning_text"`
@@ -4623,11 +4623,11 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型给出的拒绝回答。
+ 模型的拒绝回复。
- `refusal: string`
- 来自模型的拒绝解释。
+ 模型给出的拒绝说明。
- `type: "refusal"`
@@ -4637,11 +4637,11 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解关于 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的图像细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `"low"`
@@ -4659,15 +4659,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -4681,11 +4681,11 @@
- `detail: ImageDetail`
- 发送给模型的屏幕截图图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
+ 发送给模型的截图图像的细节级别。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `file_id: string or null`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: string or null`
@@ -4693,13 +4693,13 @@
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机屏幕截图,此属性始终设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,此属性始终设置为 `computer_screenshot`.
- `"computer_screenshot"`
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -4719,7 +4719,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 会使用高质量渲染,可能会增加输入 token 消耗。使用 `low` 进行低成本渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 用量。使用 `low` 可获得更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -4733,7 +4733,7 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string`
@@ -4745,7 +4745,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点会继承请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
- `mode: "explicit"`
@@ -4775,7 +4775,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态,取值之一 `in_progress`, `completed`,或 `incomplete`。通过 API 返回条目时填充。
+ 条目的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4791,7 +4791,7 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`)。对于类似 `gpt-5.3-codex` 及更高版本,在发送后续请求时,请在所有助手消息上保留并重新发送 phase —— 丢弃它可能会降低性能。用户消息不使用此字段。
+ 将消息标记为 `assistant` 中间评论(`commentary`)或最终回答(`final_answer`)。对于类似 `gpt-5.3-codex` 等模型,在发送后续请求时,请在所有助手消息上保留并重新发送 phase 参数——省略它可能会降低性能。该参数不用于用户消息。
- `"commentary"`
@@ -4805,15 +4805,15 @@
- `call_id: string`
- 程序条目的稳定调用 ID。
+ 该程序条目的稳定调用 ID。
- `code: string`
- 由程序化工具调用执行的 JavaScript 源码。
+ 由程序化工具调用执行的 JavaScript 源代码。
- `fingerprint: string`
- 必须往返回传的不透明程序重放指纹。
+ 必须原样回传的不透明程序重放指纹。
- `type: "program"`
@@ -4829,11 +4829,11 @@
- `call_id: string`
- 程序条目的调用 ID。
+ 该程序条目的调用 ID。
- `result: string`
- 程序条目产生的结果。
+ 该程序条目生成的结果。
- `status: "completed" or "incomplete"`
@@ -4851,7 +4851,7 @@
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 用于运行函数的工具调用。详见
+ 用于运行函数的工具调用。请参阅
[函数调用指南](/docs/guides/function-calling) 了解更多信息。
- `arguments: string`
@@ -4902,8 +4902,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -4915,7 +4915,7 @@
- `id: string`
- 工具搜索调用项的唯一 ID。
+ 工具搜索调用条目的唯一 ID。
- `arguments: unknown`
@@ -4927,7 +4927,7 @@
- `execution: "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -4935,7 +4935,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 已记录的工具搜索调用项的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -4951,13 +4951,13 @@
- `created_by: optional string`
- 创建该项的行为者的标识符。
+ 创建该条目的行为者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
- `id: string`
- 工具搜索输出项的唯一 ID。
+ 工具搜索输出条目的唯一 ID。
- `call_id: string or null`
@@ -4965,7 +4965,7 @@
- `execution: "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -4973,7 +4973,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 已记录的工具搜索输出项的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -4983,23 +4983,23 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 由工具搜索返回的已加载工具定义。
+ 工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 用于描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 此函数工具是否启用严格的参数校验。
- `type: "function"`
@@ -5017,23 +5017,23 @@
- `defer_loading: optional boolean`
- 此函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否被延迟并通过工具搜索加载。
- `description: optional string or null`
- 对该函数的描述。供模型用于判断是否调用该函数。
+ 函数的描述,供模型用来决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。通常为 `file_search`.
- `"file_search"`
@@ -5043,11 +5043,11 @@
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用指定的比较运算将指定的属性键与给定值进行比较的筛选器。
+ 用于通过定义的比较操作将指定的属性键与给定值进行比较的筛选条件。
- `key: string`
@@ -5057,14 +5057,14 @@
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`: 等于
- - `ne`: 不等于
- - `gt`: 大于
- - `gte`: 大于或等于
- - `lt`: 小于
- - `lte`: 小于或等于
- - `in`: 属于
- - `nin`: 不属于
+ - `eq`:等于
+ - `ne`:不等于
+ - `gt`:大于
+ - `gte`:大于或等于
+ - `lt`:小于
+ - `lte`:小于或等于
+ - `in`:包含于
+ - `nin`:不包含于
- `"eq"`
@@ -5100,15 +5100,15 @@
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的筛选条件数组。各项可以为 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于使用指定的比较运算将指定的属性键与给定值进行比较的筛选器。
+ 用于通过定义的比较操作将指定的属性键与给定值进行比较的筛选条件。
- `unknown`
@@ -5122,7 +5122,7 @@
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应在 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -5130,15 +5130,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,互逆排序融合(reciprocal rank fusion)中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于控制互逆排名融合(reciprocal rank fusion)在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
- `embedding_weight: number`
- 互逆排序融合中嵌入的权重。
+ 互逆排名融合中嵌入的权重。
- `text_weight: number`
- 互逆排序融合中文本的权重。
+ 互逆排名融合中文本匹配的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -5150,29 +5150,29 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试只返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,取值范围为 0 到 1。越接近 1 的数值会尝试仅返回相关性最高的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示屏的高度。
- `display_width: number`
- 计算机显示器的宽度。
+ 计算机显示屏的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -5190,18 +5190,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型,取值之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -5209,7 +5209,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
+ 允许网页搜索实时访问互联网。省略时默认值为 true。当值为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -5217,14 +5217,14 @@
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样允许。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -5234,7 +5234,7 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
@@ -5242,7 +5242,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5250,22 +5250,22 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程模型上下文协议
- (MCP)服务器为模型提供对其他工具的访问。 [了解有关 MCP 的更多信息](/docs/guides/tools-remote-mcp).
+ (MCP)服务器,为模型提供对其他工具的访问能力。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -5287,35 +5287,35 @@
- `McpAllowedTools = array of string`
- 允许的工具名称组成的字符串数组
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 可与远程 MCP 服务器配合使用的 OAuth 访问令牌,可用于
- 自定义 MCP 服务器 URL 或服务连接器。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可搭配
+ 自定义 MCP 服务器 URL 或服务连接器使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
- 服务连接器 [请参见此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些连接器。必须提供其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 。了解更多
+ 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持的 `connector_id` 值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -5348,52 +5348,52 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 的哪些工具需要批准。
+ 指定 MCP 服务器中哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选对象
- 需要批准的。
+ 指定 MCP 服务器中哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的筛选器对象
+ ,这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单个批准策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要批准。当设置为
- 设置为 `never`,时,所有工具都不需要批准。
+ 为所有工具指定统一的审批策略。可选值之一 `always` 或
+ `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -5401,21 +5401,21 @@
- `server_description: optional string`
- MCP server 的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP server 的 URL。以下之一 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。以下之一 `server_url`, `connector_id`,或
`tunnel_id` 必须提供。
- `tunnel_id: optional string`
- 用于代替直接 server URL 的安全 MCP 隧道 ID。以下之一
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。以下之一
`server_url`, `connector_id`,或 `tunnel_id` 必须提供。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示词响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
@@ -5429,7 +5429,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要用于运行代码的文件 ID。
- `type: "auto"`
@@ -5469,17 +5469,17 @@
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当类型为时允许访问的域名列表 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域发出站网络访问。始终为 `allowlist`.
+ 仅允许向指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 针对允许列表中域的可选域作用域密钥。
+ 用于已加入白名单域的可选域范围密钥。
- `domain: string`
@@ -5527,7 +5527,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑已有图像。默认值: `auto`.
- `"generate"`
@@ -5538,9 +5538,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持功能处于预览阶段。当使用
+ `opaque`,或 `auto`。之一。受支持的 GPT Image 模型可使用透明背景。对于
+ 受支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5551,7 +5551,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不受支持于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型中受支持,在 `gpt-image-1-mini`。中不受支持。支持的值包括 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -5621,7 +5621,7 @@
- `partial_images: optional number`
- 流式模式下要生成的中间图像数量,范围从 0(默认值)到 3。
+ 在流式模式下要生成的中间图片数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -5638,13 +5638,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -5688,7 +5688,7 @@
- `type: "container_auto"`
- 自动为本次请求创建一个容器
+ 为此请求自动创建一个容器
- `"container_auto"`
@@ -5718,13 +5718,13 @@
- `skills: optional array of SkillReference or InlineSkill`
- 一个可选的技能列表,按 ID 或内联数据引用。
+ 通过 ID 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
- `skill_id: string`
- 被引用技能的 ID。
+ 所引用技能的 ID。
- `type: "skill_reference"`
@@ -5748,7 +5748,7 @@
- `source: InlineSkillSource`
- 内联技能载荷
+ 内联技能负载
- `data: string`
@@ -5756,13 +5756,13 @@
- `media_type: "application/zip"`
- 内联技能载荷的媒体类型。必须为 `application/zip`.
+ 内联技能负载的媒体类型,必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能源的类型。必须为 `base64`.
+ 内联技能来源的类型,必须为 `base64`.
- `"base64"`
@@ -5782,7 +5782,7 @@
- `skills: optional array of LocalSkill`
- 一个可选的技能列表。
+ 可选的技能列表。
- `description: string`
@@ -5800,21 +5800,21 @@
- `container_id: string`
- 被引用容器的 ID。
+ 所引用容器的 ID。
- `type: "container_reference"`
- 引用通过 /v1/containers 端点创建的容器
+ 引用通过 /v1/containers 端点创建的容器。
- `"container_reference"`
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -5832,7 +5832,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -5840,7 +5840,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Text object { type }`
@@ -5862,7 +5862,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。其中之一 `lark` 或 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -5884,7 +5884,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 用于工具调用中的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -5908,27 +5908,27 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这并不描述 content 数组输出。
+ 用于描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。该字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在架构兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,对于兼容的 schema,Responses 会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -5946,7 +5946,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -5954,7 +5954,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -5974,11 +5974,11 @@
- `description: optional string or null`
- 为客户端执行的工具搜索工具展示给模型的描述。
+ 展示给模型的、由客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -5990,11 +5990,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 该工具会在网页中搜索相关结果,用于在回复中使用。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索可在响应中使用的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型,取值之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -6008,7 +6008,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6018,11 +6018,11 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
@@ -6032,7 +6032,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6040,7 +6040,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -6068,13 +6068,13 @@
- `created_by: optional string`
- 创建该项的行为者的标识符。
+ 创建该条目的行为者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 附加工具项的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
@@ -6098,23 +6098,23 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在此项中可用的附加工具定义。
+ 在此条目中可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
- 要调用的函数的名称。
+ 要调用的函数名称。
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 用于描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 此函数工具是否启用严格的参数校验。
- `type: "function"`
@@ -6132,23 +6132,23 @@
- `defer_loading: optional boolean`
- 此函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否被延迟并通过工具搜索加载。
- `description: optional string or null`
- 对该函数的描述。供模型用于判断是否调用该函数。
+ 函数的描述,供模型用来决定是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型。通常为 `file_search`.
- `"file_search"`
@@ -6158,19 +6158,19 @@
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的筛选条件。
- `ComparisonFilter object { key, type, value }`
- 用于使用指定的比较运算将指定的属性键与给定值进行比较的筛选器。
+ 用于通过定义的比较操作将指定的属性键与给定值进行比较的筛选条件。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式组合多个筛选条件 `and` 或 `or`.
- `max_num_results: optional number`
- 返回结果的最大数量。该数值应在 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -6178,15 +6178,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,互逆排序融合(reciprocal rank fusion)中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于控制互逆排名融合(reciprocal rank fusion)在语义嵌入匹配与稀疏关键词匹配之间平衡程度的权重。
- `embedding_weight: number`
- 互逆排序融合中嵌入的权重。
+ 互逆排名融合中嵌入的权重。
- `text_weight: number`
- 互逆排序融合中文本的权重。
+ 互逆排名融合中文本匹配的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -6198,29 +6198,29 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,取值介于 0 到 1 之间。越接近 1 的数值会尝试只返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,取值范围为 0 到 1。越接近 1 的数值会尝试仅返回相关性最高的结果,但返回的结果数量可能会更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
- 计算机显示器的高度。
+ 计算机显示屏的高度。
- `display_width: number`
- 计算机显示器的宽度。
+ 计算机显示屏的宽度。
- `environment: "windows" or "mac" or "linux" or 2 more`
@@ -6238,18 +6238,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示词相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型,取值之一 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -6257,7 +6257,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索进行实时互联网访问。省略时默认为 true。当为 false 时,网页搜索工具将以离线/仅缓存模式运行,并且不会获取新的外部内容。
+ 允许网页搜索实时访问互联网。省略时默认值为 true。当值为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -6265,14 +6265,14 @@
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名同样允许。
+ 允许搜索的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6282,7 +6282,7 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
@@ -6290,7 +6290,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6298,22 +6298,22 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程模型上下文协议
- (MCP)服务器为模型提供对其他工具的访问。 [了解有关 MCP 的更多信息](/docs/guides/tools-remote-mcp).
+ (MCP)服务器,为模型提供对其他工具的访问能力。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
@@ -6335,35 +6335,35 @@
- `McpAllowedTools = array of string`
- 允许的工具名称组成的字符串数组
+ 允许的工具名称的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `authorization: optional string`
- 可与远程 MCP 服务器配合使用的 OAuth 访问令牌,可用于
- 自定义 MCP 服务器 URL 或服务连接器。你的应用
- 必须处理 OAuth 授权流程,并在此处提供令牌。
+ 可与远程 MCP 服务器一起使用的 OAuth 访问令牌,可搭配
+ 自定义 MCP 服务器 URL 或服务连接器使用。你的应用
+ 必须处理 OAuth 授权流程并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 必须提供。详细了解
- 服务连接器 [请参见此处](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的那些连接器。必须提供其中之一
+ `server_url`, `connector_id`,或 `tunnel_id` 。了解更多
+ 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ 当前支持的 `connector_id` 值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -6396,52 +6396,52 @@
- `headers: optional map[string] or null`
- 发送到 MCP server 的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务器的可选 HTTP 头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP server 的哪些工具需要批准。
+ 指定 MCP 服务器中哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP server 的哪些工具需要批准。可以是
- `always`, `never`,或与需要批准的工具关联的筛选对象
- 需要批准的。
+ 指定 MCP 服务器中哪些工具需要审批。可以是
+ `always`, `never`,或与工具关联的筛选器对象
+ ,这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否会修改数据,还是只读。如果某个
- MCP 服务器被 [标记为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否会修改数据或为只读。如果某个
+ MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许使用的工具名称列表。
+ 允许的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定单个批准策略。可选值为 `always` 或
- `never`。当设置为 `always`,时,所有工具都需要批准。当设置为
- 设置为 `never`,时,所有工具都不需要批准。
+ 为所有工具指定统一的审批策略。可选值之一 `always` 或
+ `never`。当设置为 `always`,时,所有工具都需要审批。当
+ 设置为 `never`,时,所有工具都不需要审批。
- `"always"`
@@ -6449,21 +6449,21 @@
- `server_description: optional string`
- MCP server 的可选描述,用于提供更多上下文。
+ MCP 服务器的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP server 的 URL。以下之一 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。以下之一 `server_url`, `connector_id`,或
`tunnel_id` 必须提供。
- `tunnel_id: optional string`
- 用于代替直接 server URL 的安全 MCP 隧道 ID。以下之一
+ 用于替代直接服务器 URL 的安全 MCP 隧道 ID。以下之一
`server_url`, `connector_id`,或 `tunnel_id` 必须提供。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示词响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
@@ -6477,7 +6477,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选地指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要用于运行代码的文件 ID。
- `type: "auto"`
@@ -6543,7 +6543,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑已有图像。默认值: `auto`.
- `"generate"`
@@ -6554,9 +6554,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。透明背景可用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,此支持功能处于预览阶段。当使用
+ `opaque`,或 `auto`。之一。受支持的 GPT Image 模型可使用透明背景。对于
+ 受支持的 GPT Image 模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -6567,7 +6567,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不受支持于 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像风格和特征(尤其是面部特征)时所投入的精力。该参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型中受支持,在 `gpt-image-1-mini`。中不受支持。支持的值包括 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -6637,7 +6637,7 @@
- `partial_images: optional number`
- 流式模式下要生成的中间图像数量,范围从 0(默认值)到 3。
+ 在流式模式下要生成的中间图片数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -6654,13 +6654,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,可通过 `WIDTHxHEIGHT` 字符串指定,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用 `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性功能,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,以及 `1024x1536` 由 GPT 图像模型支持; `auto` 由允许自动调整尺寸的模型支持。对于 `dall-e-2`,使用以下值之一 `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下值之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -6708,11 +6708,11 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -6730,7 +6730,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -6738,7 +6738,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
@@ -6750,7 +6750,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 用于工具调用中的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -6774,27 +6774,27 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这并不描述 content 数组输出。
+ 用于描述此函数工具字符串输出中所编码 JSON 值的 JSON Schema。该字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在架构兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,对于兼容的 schema,Responses 会尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。了解更多关于 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
- 自定义工具的名称,用于在工具调用中标识它。
+ 自定义工具的名称,用于在工具调用中识别它。
- `type: "custom"`
@@ -6812,7 +6812,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -6820,7 +6820,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -6840,11 +6840,11 @@
- `description: optional string or null`
- 为客户端执行的工具搜索工具展示给模型的描述。
+ 展示给模型的、由客户端执行的工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -6856,11 +6856,11 @@
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 该工具会在网页中搜索相关结果,用于在回复中使用。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页中搜索可在响应中使用的相关结果。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型,取值之一 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -6874,7 +6874,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 之一,默认值为。
+ 搜索所使用的上下文窗口空间的高级指引。可选值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6884,11 +6884,11 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似值的类型。始终为 `approximate`.
+ 近似位置的类型。始终为 `approximate`.
- `"approximate"`
@@ -6898,7 +6898,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 用户所在国家/地区,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6906,7 +6906,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 用户所在国家/地区,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -6951,11 +6951,11 @@
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解关于 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -6969,8 +6969,8 @@
- `id: optional string`
- 函数工具调用输出的唯一 ID。当此项通过 API
- 返回时填充该字段。
+ 函数工具调用输出的唯一 ID。当此条目
+ 通过 API 返回时填充。
- `call_id: optional string`
@@ -7002,16 +7002,16 @@
- `name: optional string`
- 生成该输出的工具的名称。
+ 生成该输出的工具名称。
- `namespace: optional string`
- 生成该输出的工具的命名空间。
+ 生成该输出的工具命名空间。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -7030,11 +7030,11 @@
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。其值为 `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -7059,11 +7059,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 个键值对集合。这可以
- 用于以结构化格式存储有关对象的额外信息,
- 并通过 API 或控制台查询对象。键为字符串,
- 最大长度为 64 个字符。值为字符串,最大长度
- 为 512 个字符,或为布尔值或数字。
+ 可以附加到对象的 16 组键值对。这对于以结构化
+ 格式存储对象的附加信息,以及通过 API 或仪表板查询对象非常有用。键为字符串,
+ 最大长度为 64 个字符。值为字符串,最大
+ 长度为 512 个字符、布尔值或数字。
+ 长度为 512 个字符、布尔值或数字。
- `string`
@@ -7081,7 +7081,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,取值在 0 到 1 之间。
- `text: optional string`
@@ -7089,21 +7089,21 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。请参阅
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索工具调用的结果。参阅
+ [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 网页搜索 工具调用的唯一 ID。
+ 网页搜索工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
- 包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
+ 描述此次 网页搜索调用中所执行的具体操作的对象。
+ 包含模型使用网页方式的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 "search" - 执行 网页搜索 查询。
+ 操作类型 "search" - 执行 网页搜索查询。
- `type: "search"`
@@ -7125,7 +7125,7 @@
- `type: "url"`
- 来源的类型。始终为 `url`.
+ 来源类型。始终为 `url`.
- `"url"`
@@ -7135,7 +7135,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的某个特定 URL。
+ 操作类型 "open_page" - 从搜索结果中打开特定 URL。
- `type: "open_page"`
@@ -7149,11 +7149,11 @@
- `FindInPage object { pattern, type, url }`
- 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 操作类型 "find_in_page":在已加载页面内搜索匹配模式。
- `pattern: string`
- 要在页面内搜索的匹配模式或文本。
+ 在页面中要搜索的模式或文本。
- `type: "find_in_page"`
@@ -7163,7 +7163,7 @@
- `url: string`
- 搜索该匹配模式对应的页面 URL。
+ 搜索该模式的页面的 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -7185,7 +7185,7 @@
- `ImageGenerationCall object { id, result, status, type }`
- 由模型发起的图像生成请求。
+ 模型发起的图像生成请求。
- `id: string`
@@ -7215,8 +7215,8 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。参阅
- [computer use 指南](/docs/guides/tools-computer-use) 了解更多信息。
+ 对计算机使用工具的工具调用。参见
+ [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
@@ -7224,7 +7224,7 @@
- `call_id: string`
- 用于在响应工具调用时携带输出的标识符。
+ 在向工具调用返回输出时所使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -7240,12 +7240,12 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -7255,7 +7255,7 @@
- `type: "computer_call"`
- 计算机调用的类型,始终为 `computer_call`.
+ 计算机调用的类型。始终为 `computer_call`.
- `"computer_call"`
@@ -7269,7 +7269,7 @@
- `button: "left" or "right" or "wheel" or 2 more`
- 指示在点击时按下了哪个鼠标按键,取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示在点击时按下了哪个鼠标按钮。取值之一为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -7283,17 +7283,17 @@
- `type: "click"`
- 指定事件类型。对于点击操作,此属性始终为 `click`.
+ 指定事件类型。对于点击操作,该属性始终为 `click`.
- `"click"`
- `x: number`
- 点击发生位置的 x 坐标。
+ 发生点击的 x 坐标。
- `y: number`
- 点击发生位置的 y 坐标。
+ 发生点击的 y 坐标。
- `keys: optional array of string or null`
@@ -7356,7 +7356,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的按键集合。
+ 模型希望执行的一系列按键操作。
- `keys: array of string`
@@ -7380,11 +7380,11 @@
- `x: number`
- 要移动到的 x 坐标。
+ 要移至的 x 坐标。
- `y: number`
- 要移动到的 y 坐标。
+ 要移至的 y 坐标。
- `keys: optional array of string or null`
@@ -7456,8 +7456,8 @@
- `actions: optional ComputerActionList`
- 的扁平化批量操作 `computer_use`。每个操作都包含一个
- `type` 鉴别器字段以及操作特有的字段。
+ 针对 `computer_use`。的扁平化批量操作。每个操作都包含一个
+ `type` 鉴别字段以及操作专属字段。
- `Click object { button, type, x, 2 more }`
@@ -7473,7 +7473,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的按键集合。
+ 模型希望执行的一系列按键操作。
- `Move object { type, x, y, keys }`
@@ -7503,7 +7503,7 @@
- `call_id: string`
- 产生该输出的计算机工具调用的 ID。
+ 生成该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
@@ -7518,7 +7518,7 @@
- `file_id: optional string`
- 包含截图的上传文件的标识符。
+ 包含截图的已上传文件的标识符。
- `image_url: optional string`
@@ -7526,8 +7526,8 @@
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。其值为 `in_progress`, `completed`,或
- `incomplete`。之一。当输入项通过 API 返回时填充。
+ 输入消息的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回输入项时填充。
- `"completed"`
@@ -7545,8 +7545,8 @@
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告且已被开发者
- 确认的安全检查。
+ 由 API 上报的、已被
+ 开发者确认的安全检查。
- `id: string`
@@ -7558,18 +7558,18 @@
- `message: optional string or null`
- 关于待处理安全检查的详细信息。
+ 待处理安全检查的详细信息。
- `created_by: optional string`
- 创建该项的行为者的标识符。
+ 创建该条目的行为者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 对推理模型在生成回复时所使用的思维链的描述。
- 请确保在手动管理 `input` 时把这些项传给 Responses API
- 上下文的对话后续轮次中,
- [上下文](/docs/guides/conversation-state).
+ 推理模型在生成响应时使用的思维链描述。请务必将这些项包含在
+ 传回给 Responses API `input` 的输入中,以便在手动管理
+ 上下文时用于对话的后续轮次。
+ [管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -7581,7 +7581,7 @@
- `text: string`
- 模型截至目前的推理输出摘要。
+ 到目前为止模型推理输出的摘要。
- `type: "summary_text"`
@@ -7599,7 +7599,7 @@
- `text: string`
- 模型输出的推理文本。
+ 来自模型的推理文本。
- `type: "reasoning_text"`
@@ -7609,20 +7609,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此项,
- 针对由 `POST /v1/responses` 和 WebSocket
+ 推理项的加密内容。默认情况下会填充该字段
+ 用于通过 `POST /v1/responses` 和 WebSocket
`response.create` 请求返回的推理项。
- 在流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` (来自 `response.output_item.done` 事件)。
- 中的 `encrypted_content` 可能不完整。当使用
- `response.output_item.added` 或启用 Zero Data Retention 时,这一点尤其
- 重要。如果 `store` 是 `false` ,或使用 Zero Data Retention,这一点尤其重要。
+ 流式传输时,请在后续请求中使用已完成的推理项及其
+ `encrypted_content` 中的 `response.output_item.done` 事件。
+ 后续请求。该 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。这一点尤其
+ 重要,当 `store` 为 `false` 或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 该条目的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。通过 API 返回条目时填充。
+ 该项的状态。取值之一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -7632,11 +7632,11 @@
- `Compaction object { id, encrypted_content, type, created_by }`
- 由 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由该模型生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
- 压缩项的唯一 ID。
+ 压缩条目的唯一 ID。
- `encrypted_content: string`
@@ -7650,7 +7650,7 @@
- `created_by: optional string`
- 创建该项的行为者的标识符。
+ 创建该条目的行为者的标识符。
- `CodeInterpreterCall object { id, code, container_id, 3 more }`
@@ -7699,11 +7699,11 @@
- `url: string`
- 代码解释器输出的图像的 URL。
+ 代码解释器输出图像的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,以及 `failed`.
- `"in_progress"`
@@ -7723,7 +7723,7 @@
- `LocalShellCall object { id, action, call_id, 2 more }`
- 用于在本地 shell 上运行命令的工具调用。
+ 在本地 shell 上运行命令的工具调用。
- `id: string`
@@ -7739,29 +7739,29 @@
- `env: map[string]`
- 为命令设置的环境变量。
+ 为该命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型,始终为 `exec`.
+ 本地 shell 操作的类型。始终为 `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 命令的可选超时时间(毫秒)。
+ 该命令的可选超时时间(毫秒)。
- `user: optional string or null`
- 运行命令时使用的可选用户。
+ 运行该命令所使用的可选用户。
- `working_directory: optional string or null`
- 在其中运行命令的可选工作目录。
+ 运行该命令的可选工作目录。
- `call_id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `status: "in_progress" or "completed" or "incomplete"`
@@ -7775,7 +7775,7 @@
- `type: "local_shell_call"`
- 本地 shell 调用的类型,始终为 `local_shell_call`.
+ 本地 shell 调用的类型。始终为 `local_shell_call`.
- `"local_shell_call"`
@@ -7785,7 +7785,7 @@
- `id: string`
- 模型生成的本地 shell 工具调用的唯一 ID。
+ 由模型生成的本地 shell 工具调用的唯一 ID。
- `output: string`
@@ -7793,13 +7793,13 @@
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型,始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 该条目的状态,取值为 `in_progress`, `completed`,或 `incomplete`.
+ 该项的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7809,21 +7809,21 @@
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一条或多条 shell 命令的工具调用。
+ 在托管环境中执行一个或多个 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当此项通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令及限制。
+ 描述如何运行该工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回内容的可选最大字符数。
+ 每个命令返回结果的可选最大字符数。
- `timeout_ms: number or null`
@@ -7831,15 +7831,15 @@
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `environment: ResponseLocalEnvironment or ResponseContainerReference or null`
- 表示使用本地环境来执行 shell 操作。
+ 表示使用本地环境执行 shell 操作。
- `ResponseLocalEnvironment object { type }`
- 表示使用本地环境来执行 shell 操作。
+ 表示使用本地环境执行 shell 操作。
- `type: "local"`
@@ -7849,7 +7849,7 @@
- `ResponseContainerReference object { container_id, type }`
- 表示使用 /v1/containers 创建的容器。
+ 表示通过 /v1/containers 创建的容器。
- `container_id: string`
@@ -7861,7 +7861,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。可选值包括 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。取值之一 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7905,27 +7905,27 @@
- `id: string`
- shell 调用输出的唯一 ID。当通过 API 返回此条目时填充。
+ shell 调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `max_output_length: number or null`
- shell 命令输出的最大长度。该值由模型生成,应与原始输出一起回传。
+ shell 命令输出的最大长度。此值由模型生成,应与原始输出一起传回。
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容数组
+ shell 调用输出内容的数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出分块的退出结果(含退出码)或超时结果。
+ 表示 shell 调用输出块的结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示该 shell 调用超出了其配置的时间限制。
+ 表示 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -7935,7 +7935,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已结束并返回了退出码。
+ 表示 shell 命令已执行完毕并返回了退出码。
- `exit_code: number`
@@ -7949,19 +7949,19 @@
- `stderr: string`
- 已捕获的标准错误输出。
+ 捕获到的标准错误输出。
- `stdout: string`
- 已捕获的标准输出。
+ 捕获到的标准输出。
- `created_by: optional string`
- 创建该项的行为者的标识符。
+ 创建该条目的行为者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7997,7 +7997,7 @@
- `created_by: optional string`
- 创建该项的行为者的标识符。
+ 创建该条目的行为者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -8005,11 +8005,11 @@
- `id: string`
- apply patch 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: string`
- 由模型生成的 apply patch 工具调用的唯一 ID。
+ 模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -8021,53 +8021,53 @@
- `diff: string`
- 要应用的差异。
+ Diff to apply.
- `path: string`
- 要创建的文件的路径。
+ Path of the file to create.
- `type: "create_file"`
- 使用提供的差异创建新文件。
+ Create a new file with the provided diff.
- `"create_file"`
- `DeleteFile object { path, type }`
- 描述如何通过 apply_patch 工具删除文件的指令。
+ Instruction describing how to delete a file via the apply_patch tool.
- `path: string`
- 要删除的文件的路径。
+ Path of the file to delete.
- `type: "delete_file"`
- 删除指定文件。
+ Delete the specified file.
- `"delete_file"`
- `UpdateFile object { diff, path, type }`
- 描述如何通过 apply_patch 工具更新文件的指令。
+ Instruction describing how to update a file via the apply_patch tool.
- `diff: string`
- 要应用的差异。
+ Diff to apply.
- `path: string`
- 要更新的文件的路径。
+ Path of the file to update.
- `type: "update_file"`
- 使用提供的差异更新现有文件。
+ Update an existing file with the provided diff.
- `"update_file"`
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。值为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。取值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -8105,19 +8105,19 @@
- `ApplyPatchCallOutput object { id, call_id, status, 4 more }`
- apply patch 工具调用所输出的内容。
+ The output emitted by an apply patch tool call.
- `id: string`
- apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
- `call_id: string`
- 由模型生成的 apply patch 工具调用的唯一 ID。
+ 模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。值为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。取值为 `completed` 或 `failed`.
- `"completed"`
@@ -8151,11 +8151,11 @@
- `created_by: optional string`
- 创建此工具调用输出的实体 ID。
+ The ID of the entity that created this tool call output.
- `output: optional string or null`
- apply patch 工具返回的可选文本输出。
+ Optional textual output returned by the apply patch tool.
- `McpListTools object { id, server_label, tools, 2 more }`
@@ -8163,7 +8163,7 @@
- `id: string`
- 此列表的唯一 ID。
+ 该列表的唯一 ID。
- `server_label: string`
@@ -8183,7 +8183,7 @@
- `annotations: optional unknown or null`
- 有关该工具的附加注释。
+ 关于该工具的附加注解。
- `description: optional string or null`
@@ -8197,11 +8197,11 @@
- `error: optional string or null`
- 当服务器无法列出工具时的错误消息。
+ 服务器无法列出工具时的错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 针对工具调用的人工审批请求。
+ 对工具调用的人工审批请求。
- `id: string`
@@ -8209,7 +8209,7 @@
- `arguments: string`
- 工具参数的 JSON 字符串。
+ 该工具的参数 JSON 字符串。
- `name: string`
@@ -8235,7 +8235,7 @@
- `approval_request_id: string`
- 正在答复的审批请求的 ID。
+ 正在回复的审批请求的 ID。
- `approve: boolean`
@@ -8253,7 +8253,7 @@
- `McpCall object { id, arguments, name, 6 more }`
- 对 MCP 服务器上某个工具的调用。
+ 对 MCP 服务器上工具的调用。
- `id: string`
@@ -8261,11 +8261,11 @@
- `arguments: string`
- 传递给工具的参数的 JSON 字符串。
+ 传递给该工具的参数 JSON 字符串。
- `name: string`
- 已运行的工具名称。
+ 已运行工具的名称。
- `server_label: string`
@@ -8280,11 +8280,11 @@
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中包含此值以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(如有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -8320,7 +8320,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。取值为以下之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -8342,11 +8342,11 @@
- `input: string`
- 模型生成的自定义工具调用的输入。
+ 由模型生成的自定义工具调用的输入。
- `name: string`
- 被调用的自定义工具的名称。
+ 正在调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -8356,7 +8356,7 @@
- `id: optional string`
- 该自定义工具调用在 OpenAI 平台中的唯一 ID。
+ 在 OpenAI 平台上自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -8380,19 +8380,19 @@
- `namespace: optional string`
- 被调用的自定义工具的命名空间。
+ 正在调用的自定义工具的命名空间。
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 来自你代码的自定义工具调用输出,正被发回给模型。
+ 你代码中自定义工具调用的输出,被发回给模型。
- `call_id: string`
- 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
+ 调用 ID,用于将此自定义工具调用输出映射到自定义工具调用。
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 由你的代码生成的自定义工具调用输出。
+ 由你的代码产生的自定义工具调用的输出。
可以是字符串或输出内容列表。
- `StringOutput = string`
@@ -8401,15 +8401,15 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 输入到模型的文本。
+ 提供给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解关于 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
@@ -8423,7 +8423,7 @@
- `id: optional string`
- 该自定义工具调用输出在 OpenAI 平台中的唯一 ID。
+ 在 OpenAI 平台上自定义工具调用输出的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
@@ -8451,36 +8451,36 @@
- `usage: ResponseUsage`
- 压缩处理的 token 统计,包括缓存、推理和总 token。
+ Token accounting for the compaction pass, including cached, reasoning, and total tokens.
- `input_tokens: number`
- 输入 token 数。
+ The number of input tokens.
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入 token 的详细明细。
+ A detailed breakdown of the input tokens.
- `cache_write_tokens: number`
- 已写入缓存的输入 token 数。
+ The number of input tokens that were written to the cache.
- `cached_tokens: number`
- 从缓存中检索到的 token 数。
- [关于提示缓存的更多信息](/docs/guides/prompt-caching).
+ The number of tokens that were retrieved from the cache.
+ [More on prompt caching](/docs/guides/prompt-caching).
- `output_tokens: number`
- 输出 token 数。
+ The number of output tokens.
- `output_tokens_details: object { reasoning_tokens }`
- 输出 token 的详细明细。
+ A detailed breakdown of the output tokens.
- `reasoning_tokens: number`
- 推理 tokens 的数量。
+ 推理 token 的数量。
- `total_tokens: number`
@@ -8488,7 +8488,7 @@
- `compute_units: optional number or null`
- 请求的计算单元。当前可用时为 null。
+ 本次请求的计算单元。在可用时,当前为 null。
### 示例
@@ -8550,7 +8550,7 @@ curl -X POST https://api.openai.com/v1/responses/compact \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.1-codex-max",
+ "model": "gpt-5.6-sol",
"input": [
{
"role": "user",
diff --git a/docs/zh/api/reference/resources/responses/methods/create.md b/docs/zh/api/reference/resources/responses/methods/create.md
index f7d4c10..9b7d067 100644
--- a/docs/zh/api/reference/resources/responses/methods/create.md
+++ b/docs/zh/api/reference/resources/responses/methods/create.md
@@ -1,18 +1,18 @@
-> 完整文档索引请参见 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 获取文档页面的 Markdown 版本。
+> 如需查看完整的文档索引,请参阅 [llms.txt](/llms.txt)。你可以在页面 URL 末尾追加 `.md` 以获取文档页面的 Markdown 版本。
## 创建模型响应
**post** `/responses`
创建模型响应。提供 [文本](/docs/guides/text) 或
-[图像](/docs/guides/images) 作为输入以生成 [文本](/docs/guides/text)
+[图像](/docs/guides/images) 输入以生成 [文本](/docs/guides/text)
或 [JSON](/docs/guides/structured-outputs) 输出。让模型调用
你自己的 [自定义代码](/docs/guides/function-calling) 或使用内置的
-[工具](/docs/guides/tools) ,例如 [网页搜索](/docs/guides/tools-web-search)
+[工具](/docs/guides/tools) 例如 [网页搜索](/docs/guides/tools-web-search)
或 [文件搜索](/docs/guides/tools-file-search) 以使用你自己的数据
作为模型响应的输入。
-### Body Parameters
+### 正文参数
- `background: optional boolean or null`
@@ -25,16 +25,16 @@
- `type: string`
- 上下文管理的条目类型。目前仅支持 'compaction'。
+ 上下文管理条目类型。目前仅支持 'compaction'。
- `compact_threshold: optional number or null`
- 触发此条目压缩的令牌阈值。
+ 触发此条目压缩操作的 token 阈值。
- `conversation: optional string or ResponseConversationParam or null`
- 此响应所属的对话。此对话中的项会前置到 `input_items` 本次响应请求。
- 此响应的输入项和输出项会在本次响应完成后自动添加到此对话中。
+ 此响应所属的对话。该对话中的条目会被前置到 `input_items` 用于本次响应请求。
+ 本次响应的输入条目和输出条目会在响应完成后自动添加到此对话中。
- `ConversationID = string`
@@ -50,7 +50,7 @@
- `include: optional array of ResponseIncludable or null`
- 指定要包含在模型响应中的附加输出数据。目前支持的值包括:
+ 指定要包含在模型响应中的其他输出数据。目前支持的值包括:
- `web_search_call.action.sources`:包含 网页搜索 工具调用的来源。
- `code_interpreter_call.outputs`:在代码解释器工具调用项中包含 Python 代码执行的输出。
@@ -58,7 +58,7 @@
- `file_search_call.results`:包含 文件搜索 工具调用的搜索结果。
- `message.input_image.image_url`:包含来自输入消息的图像 URL。
- `message.output_text.logprobs`:在助手消息中包含 logprobs。
- - `reasoning.encrypted_content`:在推理项输出中包含加密版本的推理令牌。这样可以在无状态使用 Responses API 时(例如 `store` 参数设置为 `false`,或组织已加入零数据保留计划时)在多轮对话中使用推理项。
+ - `reasoning.encrypted_content`:在推理项输出中包含加密版本的推理 token。这使得在以无状态方式使用 Responses API 时(例如当 `store` 参数被设置为 `false`,或当组织已加入零数据保留计划时),推理项可在多轮对话中使用。
- `"file_search_call.results"`
@@ -78,51 +78,51 @@
- `input: optional string or array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 发送给模型的文本、图片或文件输入,用于生成响应。
+ 传递给模型的文本、图像或文件输入,用于生成响应。
了解更多:
- [文本输入与输出](/docs/guides/text)
- - [图片输入](/docs/guides/images)
+ - [图像输入](/docs/guides/images)
- [文件输入](/docs/guides/pdf-files)
- - [会话状态](/docs/guides/conversation-state)
+ - [对话状态](/docs/guides/conversation-state)
- [函数调用](/docs/guides/function-calling)
- `TextInput = string`
- 发送给模型的文本输入,等同于带有以下角色的文本输入:
- `user` 。
+ 传递给模型的文本输入,等同于带有
+ `user` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 发送给模型的一个或多个输入项列表,包含
- 不同的内容类型。
+ 包含一个或多个输入项的列表,传递给模型,这些输入项可
+ 包含不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示了指令的
- 优先级层次。使用 `developer` 或 `system` 角色给出的指令
- 优先于使用以下角色给出的指令 `user` 。带有
- `assistant` 角色的消息假定为模型在之前交互中
+ 传递给模型的消息输入,其角色用于指示指令优先级。通过
+ 层级角色给出的指令优先级,高于 `developer` 或 `system` 角色给出的指令。带有
+ 层级角色的指令优先于使用 `user` 角色给出的指令。带有
+ `assistant` 角色的消息被视为模型在之前的交互中
生成的内容。
- `content: string or ResponseInputMessageContentList`
- 发送给模型的文本、图片或音频输入,用于生成响应。
+ 传递给模型的文本、图像或音频输入,用于生成响应。
也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一条或多条输入项的列表,包含不同的内容
类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
@@ -136,7 +136,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -146,7 +146,7 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
@@ -168,15 +168,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像的 URL。可以是完整的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -186,7 +186,7 @@
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `type: "input_file"`
@@ -196,7 +196,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 的使用量。使用 `low` 用于降低渲染成本,或 `high` 以更高质量渲染文件。默认值为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 用于以更低成本进行渲染,或 `high` 以更高质量渲染文件时使用。默认为 `auto`.
- `"auto"`
@@ -206,23 +206,23 @@
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -245,9 +245,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将消息标记为 `assistant` 中间评论(`commentary`)或最终答案(`final_answer`).
- 对于类似 `gpt-5.3-codex` 及以上的模型,在发送后续请求时,请保留并重新发送
- 字段作用于所有助手消息——丢弃该字段可能导致性能下降。该字段不用于用户消息。
+ 将该 `assistant` 消息标记为中间说明性内容(`commentary`)或最终答复(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段在所有助手消息上——丢弃它可能导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -255,19 +255,19 @@
- `type: optional "message"`
- 消息输入的类型,始终为 `message`.
+ 消息输入的类型,始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示了指令的
- 优先级层次。使用 `developer` 或 `system` 角色给出的指令
- 优先于使用以下角色给出的指令 `user` 。
+ 传递给模型的消息输入,其角色用于指示指令优先级。通过
+ 层级角色给出的指令优先级,高于 `developer` 或 `system` 角色给出的指令。带有
+ 层级角色的指令优先于使用 `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 发送给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一条或多条输入项的列表,包含不同的内容
类型。
- `role: "user" or "system" or "developer"`
@@ -282,8 +282,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 项的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ 条目的状态,取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -299,7 +299,7 @@
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 来自模型的输出消息。
+ 模型输出的消息。
- `id: string`
@@ -311,7 +311,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 来自模型的文本输出。
+ 模型输出的文本。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -327,11 +327,11 @@
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 该文件在文件列表中的索引。
+ 文件在文件列表中的索引。
- `type: "file_citation"`
@@ -341,7 +341,7 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型回复的网页资源引用。
+ 用于生成模型回答的网页资源引用。
- `end_index: number`
@@ -367,7 +367,7 @@
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
- 用于生成模型回复的容器文件引用。
+ 用于生成模型回答的容器文件引用。
- `container_id: string`
@@ -383,7 +383,7 @@
- `filename: string`
- 被引用容器文件的文件名。
+ 所引用容器文件的文件名。
- `start_index: number`
@@ -405,7 +405,7 @@
- `index: number`
- 该文件在文件列表中的索引。
+ 文件在文件列表中的索引。
- `type: "file_path"`
@@ -431,7 +431,7 @@
- `text: string`
- 模型输出的文本内容。
+ 模型输出的文本。
- `type: "output_text"`
@@ -441,15 +441,15 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝响应。
+ 模型的拒绝回复。
- `refusal: string`
- 模型给出的拒绝原因说明。
+ 模型的拒绝解释。
- `type: "refusal"`
- 拒绝响应的类型。始终为 `refusal`.
+ 拒绝的类型。始终为 `refusal`.
- `"refusal"`
@@ -461,8 +461,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。可选值为以下之一: `in_progress`, `completed`,或
- `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。通过 API 返回输入项时填充。
- `"in_progress"`
@@ -478,9 +478,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将消息标记为 `assistant` 中间评论(`commentary`)或最终答案(`final_answer`).
- 对于类似 `gpt-5.3-codex` 及以上的模型,在发送后续请求时,请保留并重新发送
- 字段作用于所有助手消息——丢弃该字段可能导致性能下降。该字段不用于用户消息。
+ 将该 `assistant` 消息标记为中间说明性内容(`commentary`)或最终答复(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段在所有助手消息上——丢弃它可能导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -488,7 +488,7 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。请参阅
+ 文件搜索 工具调用的结果。参见
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -497,11 +497,11 @@
- `queries: array of string`
- 用于搜索文件的查询语句。
+ 用于搜索文件的查询。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。可选值为以下之一: `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -526,11 +526,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 个键值对集合。这可以
- 以结构化格式存储关于对象的附加信息,
- 并通过 API 或仪表板查询对象。键为字符串
- 最大长度为 64 个字符。值为最大长度
- 为 512 个字符的字符串、布尔值或数字。
+ 可以附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储有关对象的附加信息,并通过
+ API 或控制台查询对象。键为字符串
+ 最大长度为 64 个字符。值是最大
+ 长度为 512 个字符的字符串、布尔值或数字。
- `string`
@@ -548,7 +548,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,介于 0 和 1 之间。
- `text: optional string`
@@ -557,7 +557,7 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
对计算机使用工具的工具调用。参见
- [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
+ [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
@@ -565,11 +565,11 @@
- `call_id: string`
- 使用输出响应工具调用时所使用的标识符。
+ 在向工具调用提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
- 计算机调用中待处理的安全检查。
+ 计算机调用的待处理安全检查。
- `id: string`
@@ -586,7 +586,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -596,21 +596,21 @@
- `type: "computer_call"`
- 计算机调用的类型。始终为 `computer_call`.
+ 计算机调用的类型,恒为 `computer_call`.
- `"computer_call"`
- `action: optional ComputerAction`
- 点击操作。
+ 点击动作。
- `Click object { button, type, x, 2 more }`
- 点击操作。
+ 点击动作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示点击时按下的鼠标按键。取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指明点击时按下的鼠标按键。取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -624,13 +624,13 @@
- `type: "click"`
- 指定事件类型。对于点击操作,此属性始终为 `click`.
+ 指定事件类型。对于点击动作,该属性恒为 `click`.
- `"click"`
- `x: number`
- 发生点击的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
@@ -650,7 +650,7 @@
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击动作,该属性始终设置为 `double_click`.
- `"double_click"`
@@ -668,7 +668,7 @@
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式出现,例如
+ 一个由坐标构成的数组,表示拖动动作的路径。坐标将作为对象数组出现,例如
```
[
@@ -687,7 +687,7 @@
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动动作,该属性始终设置为 `drag`.
- `"drag"`
@@ -697,7 +697,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的按键操作的集合。
- `keys: array of string`
@@ -705,7 +705,7 @@
- `type: "keypress"`
- 指定事件类型。对于按键动作,此属性始终设置为 `keypress`.
+ 指定事件类型。对于按键动作,该属性始终设置为 `keypress`.
- `"keypress"`
@@ -715,17 +715,17 @@
- `type: "move"`
- 指定事件类型。对于移动动作,此属性始终设置为 `move`.
+ 指定事件类型。对于移动动作,该属性始终设置为 `move`.
- `"move"`
- `x: number`
- 要移至的 x 坐标。
+ 要移动到的 x 坐标。
- `y: number`
- 要移至的 y 坐标。
+ 要移动到的 y 坐标。
- `keys: optional array of string or null`
@@ -733,17 +733,17 @@
- `Screenshot object { type }`
- 截屏动作。
+ 截图操作。
- `type: "screenshot"`
- 指定事件类型。对于截屏动作,此属性始终设置为 `screenshot`.
+ 指定事件类型。对于截图操作,此属性始终设置为 `screenshot`.
- `"screenshot"`
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
- 滚动动作。
+ 滚动操作。
- `scroll_x: number`
@@ -755,17 +755,17 @@
- `type: "scroll"`
- 指定事件类型。对于滚动动作,此属性始终设置为 `scroll`.
+ 指定事件类型。对于滚动操作,此属性始终设置为 `scroll`.
- `"scroll"`
- `x: number`
- 发生滚动位置的 x 坐标。
+ 发生滚动事件的 x 坐标。
- `y: number`
- 发生滚动位置的 y 坐标。
+ 发生滚动事件的 y 坐标。
- `keys: optional array of string or null`
@@ -773,7 +773,7 @@
- `Type object { text, type }`
- 用于输入文本的动作。
+ 输入文本的操作。
- `text: string`
@@ -781,28 +781,28 @@
- `type: "type"`
- 指定事件类型。对于输入动作,此属性始终设置为 `type`.
+ 指定事件类型。对于输入操作,此属性始终设置为 `type`.
- `"type"`
- `Wait object { type }`
- 等待动作。
+ 等待操作。
- `type: "wait"`
- 指定事件类型。对于等待动作,此属性始终设置为 `wait`.
+ 指定事件类型。对于等待操作,此属性始终设置为 `wait`.
- `"wait"`
- `actions: optional ComputerActionList`
- 为 `computer_use`。扁平化后的批量动作。每个动作包含一个
- `type` 判别字段以及动作专属字段。
+ 针对的扁平化批处理操作 `computer_use`。每个操作都包含一个
+ `type` 判别字段以及操作特有的字段。
- `Click object { button, type, x, 2 more }`
- 点击操作。
+ 点击动作。
- `DoubleClick object { keys, type, x, y }`
@@ -814,7 +814,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的按键操作的集合。
- `Move object { type, x, y, keys }`
@@ -822,19 +822,19 @@
- `Screenshot object { type }`
- 截屏动作。
+ 截图操作。
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
- 滚动动作。
+ 滚动操作。
- `Type object { text, type }`
- 用于输入文本的动作。
+ 输入文本的操作。
- `Wait object { type }`
- 等待动作。
+ 等待操作。
- `ComputerCallOutput object { call_id, output, type, 3 more }`
@@ -842,7 +842,7 @@
- `call_id: string`
- 产生该输出的计算机工具调用的 ID。
+ 生成该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
@@ -875,7 +875,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 报告的安全检查。
+ 由 API 报告的、已被开发者确认的安全检查。
- `id: string`
@@ -891,7 +891,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。可选值为以下之一: `in_progress`, `completed`,或 `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。通过 API 返回输入项时填充。
- `"in_progress"`
@@ -901,21 +901,21 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索 工具调用的结果。请参阅
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 该 网页搜索 工具调用的唯一 ID。
+ 网页搜索 工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行具体操作的对象。
+ 描述本次 网页搜索 调用中所执行的具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 “search”——执行一次 网页搜索 查询。
+ 操作类型 "search" - 执行 网页搜索 查询。
- `type: "search"`
@@ -925,11 +925,11 @@
- `queries: optional array of string`
- 搜索查询语句。
+ 搜索查询。
- `query: optional string`
- 搜索查询语句。
+ 搜索查询。
- `sources: optional array of object { type, url }`
@@ -937,7 +937,7 @@
- `type: "url"`
- 来源的类型。始终为 `url`.
+ 来源类型。始终为 `url`.
- `"url"`
@@ -947,7 +947,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 操作类型 "open_page" —— 从搜索结果中打开指定的 URL。
- `type: "open_page"`
@@ -965,7 +965,7 @@
- `pattern: string`
- 要在页面内搜索的模式或文本。
+ 要在页面中搜索的模式或文本。
- `type: "find_in_page"`
@@ -975,7 +975,7 @@
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -1024,7 +1024,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -1036,7 +1036,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -1049,7 +1049,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1075,7 +1075,7 @@
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
@@ -1089,7 +1089,7 @@
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1099,7 +1099,7 @@
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision)
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision)
- `type: "input_image"`
@@ -1113,15 +1113,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像的 URL。可以是完整的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1131,7 +1131,7 @@
- `ResponseInputFileContent object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `type: "input_file"`
@@ -1141,7 +1141,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 的使用量。使用 `low` 用于降低渲染成本,或 `high` 以更高质量渲染文件。默认值为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 用于以更低成本进行渲染,或 `high` 以更高质量渲染文件时使用。默认为 `auto`.
- `"auto"`
@@ -1155,19 +1155,19 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1183,7 +1183,7 @@
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此条目通过 API 返回时会填充该字段。
+ 函数工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: optional string or null`
@@ -1191,7 +1191,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -1205,7 +1205,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -1215,15 +1215,15 @@
- `name: optional string or null`
- 产生该输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 产生该输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回项时会填充。
+ 条目的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1253,7 +1253,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -1277,7 +1277,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -1289,7 +1289,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -1307,37 +1307,37 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `key: string`
@@ -1350,11 +1350,11 @@
- `eq`: 等于
- `ne`: 不等于
- `gt`: 大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
- - `in`: 包含于
- - `nin`: 不包含于
+ - `lte`: 小于或等于
+ - `in`: 包含
+ - `nin`: 不包含
- `"eq"`
@@ -1374,7 +1374,7 @@
- `value: string or number or boolean or array of string or number`
- 与属性键进行比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -1390,15 +1390,15 @@
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的过滤器数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `unknown`
@@ -1412,7 +1412,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -1420,15 +1420,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -1440,21 +1440,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -1480,18 +1480,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1499,7 +1499,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -1507,14 +1507,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -1532,7 +1532,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -1540,7 +1540,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -1550,16 +1550,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -1573,21 +1573,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -1595,26 +1595,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -1634,32 +1634,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -1667,13 +1667,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -1681,9 +1681,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -1691,27 +1691,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -1719,7 +1719,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -1729,7 +1729,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1751,7 +1751,7 @@
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。Always `disabled`.
- `"disabled"`
@@ -1759,17 +1759,17 @@
- `allowed_domains: array of string`
- 当 type 为 `allowlist`.
+ 当类型为 allowed_domains 时允许访问的域名列表。 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域进行出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出出站网络访问。Always `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 针对已加入允许列表的域的可选域作用域密钥。
+ 用于白名单域的可选域作用域密钥。
- `domain: string`
@@ -1828,9 +1828,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1841,7 +1841,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -1858,7 +1858,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -1888,7 +1888,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -1911,7 +1911,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -1928,13 +1928,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -1978,13 +1978,13 @@
- `type: "container_auto"`
- 自动为本次请求创建一个容器
+ 自动为该请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2024,7 +2024,7 @@
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略以使用默认值。
+ 可选的技能版本。使用正整数或 'latest'。省略时使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -2072,7 +2072,7 @@
- `skills: optional array of LocalSkill`
- 一个可选的技能列表。
+ 可选的技能列表。
- `description: string`
@@ -2100,7 +2100,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -2122,7 +2122,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -2130,7 +2130,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Text object { type }`
@@ -2152,7 +2152,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法。取值之一为 `lark` 或 `regex`.
+ 语法定义的语法。取值为以下之一 `lark` 或 `regex`.
- `"lark"`
@@ -2166,7 +2166,7 @@
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -2174,7 +2174,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -2198,23 +2198,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -2236,7 +2236,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -2244,7 +2244,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -2264,11 +2264,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -2276,15 +2276,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -2298,7 +2298,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -2322,7 +2322,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2330,7 +2330,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -2366,7 +2366,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -2396,7 +2396,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -2408,7 +2408,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -2426,45 +2426,45 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -2472,15 +2472,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -2492,21 +2492,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -2532,18 +2532,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -2551,7 +2551,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -2559,14 +2559,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -2584,7 +2584,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2592,7 +2592,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -2602,16 +2602,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -2625,21 +2625,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -2647,26 +2647,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -2686,32 +2686,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -2719,13 +2719,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -2733,9 +2733,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -2743,27 +2743,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -2771,7 +2771,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -2781,7 +2781,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2848,9 +2848,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -2861,7 +2861,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -2878,7 +2878,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -2908,7 +2908,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -2931,7 +2931,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -2948,13 +2948,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -3002,7 +3002,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -3024,7 +3024,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -3032,11 +3032,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -3044,7 +3044,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -3068,23 +3068,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -3106,7 +3106,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -3114,7 +3114,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -3134,11 +3134,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -3146,15 +3146,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -3168,7 +3168,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -3192,7 +3192,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -3200,7 +3200,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -3232,10 +3232,10 @@
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成回复时所使用的思维链描述。请务必将这些条目包含在你的
- 中,以便在后续对话轮次中传递给 Responses API `input` 至 响应接口
- ,如果你正在手动管理
- [上下文](/docs/guides/conversation-state).
+ 对推理模型在生成回复时所使用的思维链的描述。如果你手动管理上下文,请务必在后续对话轮次中将这些条目包含在提交给 响应接口 的
+ 中。 `input` 请求里
+ 。
+ [管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -3277,20 +3277,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。该字段默认填充
- 用于由 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充
+ 由 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求返回的推理条目。
- 在流式传输时,使用已完成的推理项及其
+ 在流式传输时,请使用已完成的推理条目及其
`encrypted_content` 从 `response.output_item.done` 事件中
- 后续请求。该 `encrypted_content` 中
- `response.output_item.added` 可能不完整。这一点尤其
- 重要,在 `store` 被 `false` 截断,或者使用 Zero Data Retention 时。
+ 后续请求中获取。由于 `encrypted_content` 处于
+ `response.output_item.added` 中的数据可能不完整。尤其是在
+ important when `store` is `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -3300,7 +3300,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由 API 生成的压缩项 [`v1/responses/compact` 接口](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -3308,13 +3308,13 @@
- `type: "compaction"`
- 该项的类型。始终为 `compaction`.
+ 该 item 的类型。始终为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩条目的 ID。
+ 压缩项的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -3365,7 +3365,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 若没有可用输出,可能为 null。
- `Logs object { logs, type }`
@@ -3397,7 +3397,7 @@
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`、以及 `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -3451,7 +3451,7 @@
- `working_directory: optional string or null`
- 运行命令所在的可选工作目录。
+ 运行命令时所在的可选工作目录。
- `call_id: string`
@@ -3503,11 +3503,11 @@
- `ShellCall object { action, call_id, type, 4 more }`
- 表示执行一条或多条 shell 命令请求的工具。
+ 表示请求执行一个或多个 shell 命令的工具。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令和限制。
+ 描述如何运行该工具调用的 shell 命令及限制。
- `commands: array of string`
@@ -3519,25 +3519,25 @@
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的最大挂钟时间(毫秒)。
+ 允许 shell 命令运行的最长墙钟时间(毫秒)。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `type: "shell_call"`
- 该项的类型。始终为 `shell_call`.
+ 该 item 的类型。始终为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当通过 API 返回该条目时填充。
+ shell 工具调用的唯一 ID。在通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -3551,7 +3551,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3561,7 +3561,7 @@
- `environment: optional LocalEnvironment or ContainerReference or null`
- 执行 shell 命令的环境。
+ 用于执行 shell 命令的环境。
- `LocalEnvironment object { type, skills }`
@@ -3569,7 +3569,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3579,15 +3579,15 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- shell 工具调用发出的流式输出项。
+ shell 工具调用产生的流式输出条目。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 和 stderr 输出块及其关联结果。
+ 已捕获的 stdout 和 stderr 输出块及其关联的结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -3595,7 +3595,7 @@
- `Timeout object { type }`
- 表示 shell 调用超出了其配置的时间限制。
+ 表示该 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -3605,11 +3605,11 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已结束并返回了退出码。
- `exit_code: number`
- shell 进程返回的退出码。
+ 由 shell 进程返回的退出码。
- `type: "exit"`
@@ -3627,17 +3627,17 @@
- `type: "shell_call_output"`
- 该项的类型。始终为 `shell_call_output`.
+ 该 item 的类型。始终为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当通过 API 返回该条目时填充。
+ shell 工具调用输出的唯一 ID。在通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -3651,7 +3651,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3675,11 +3675,11 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示使用 diff 补丁创建、删除或更新文件的工具调用。
+ 一个表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -3691,11 +3691,11 @@
- `diff: string`
- 创建文件时要应用的统一差异内容。
+ 创建文件时要应用的 unified diff 内容。
- `path: string`
- 相对于工作区根目录要创建的文件的路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -3709,7 +3709,7 @@
- `path: string`
- 相对于工作区根目录要删除的文件的路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -3723,11 +3723,11 @@
- `diff: string`
- 要应用到现有文件的统一差异内容。
+ 要应用于现有文件的 unified diff 内容。
- `path: string`
- 相对于工作区根目录要更新的文件的路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -3737,7 +3737,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。取值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -3745,17 +3745,17 @@
- `type: "apply_patch_call"`
- 该项的类型。始终为 `apply_patch_call`.
+ 该 item 的类型。始终为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当该条目通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当此条目通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -3769,7 +3769,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3779,15 +3779,15 @@
- `ApplyPatchCallOutput object { call_id, status, type, 3 more }`
- apply patch 工具调用产生的流式输出。
+ apply patch 工具调用发出的流式输出。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。取值为 `completed` 或 `failed`.
- `"completed"`
@@ -3795,17 +3795,17 @@
- `type: "apply_patch_call_output"`
- 该项的类型。始终为 `apply_patch_call_output`.
+ 该 item 的类型。始终为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当该条目通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -3819,7 +3819,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3829,7 +3829,7 @@
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ 来自 apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
@@ -3857,15 +3857,15 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注释。
+ 有关该工具的其他注释。
- `description: optional string or null`
- 该工具的描述。
+ 工具的描述。
- `type: "mcp_list_tools"`
- 该项的类型。始终为 `mcp_list_tools`.
+ 该 item 的类型。始终为 `mcp_list_tools`.
- `"mcp_list_tools"`
@@ -3875,7 +3875,7 @@
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工审批某个工具调用。
- `id: string`
@@ -3883,7 +3883,7 @@
- `arguments: string`
- 用于该工具的参数的 JSON 字符串。
+ 工具参数的 JSON 字符串。
- `name: string`
@@ -3891,11 +3891,11 @@
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 该项的类型。始终为 `mcp_approval_request`.
+ 该 item 的类型。始终为 `mcp_approval_request`.
- `"mcp_approval_request"`
@@ -3905,15 +3905,15 @@
- `approval_request_id: string`
- 正在响应的审批请求的 ID。
+ 正在应答的审批请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已被批准。
- `type: "mcp_approval_response"`
- 该项的类型。始终为 `mcp_approval_response`.
+ 该 item 的类型。始终为 `mcp_approval_response`.
- `"mcp_approval_response"`
@@ -3927,7 +3927,7 @@
- `McpCall object { id, arguments, name, 6 more }`
- 对 MCP 服务器上某个工具的调用。
+ 在 MCP 服务器上对工具的一次调用。
- `id: string`
@@ -3947,14 +3947,14 @@
- `type: "mcp_call"`
- 该项的类型。始终为 `mcp_call`.
+ 该 item 的类型。始终为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 用于批准或拒绝相应工具调用的输入。
+ 在后续请求中包含此值 `mcp_approval_response` 用于批准或拒绝相应工具调用的输入。
- `error: optional McpToolCallError or null`
@@ -4008,11 +4008,11 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 由你的代码生成的自定义工具调用的输出,将被发送回模型。
+ 来自你代码的自定义工具调用输出,正在发回给模型。
- `call_id: string`
- 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
+ 调用 ID,用于将此自定义工具调用输出映射到自定义工具调用。
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
@@ -4025,19 +4025,19 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `type: "custom_tool_call_output"`
@@ -4047,11 +4047,11 @@
- `id: optional string`
- 自定义工具调用输出在 OpenAI 平台上的唯一 ID。
+ 在 OpenAI 平台中自定义工具调用输出的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -4065,7 +4065,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4083,11 +4083,11 @@
- `input: string`
- 由模型生成的自定义工具调用的输入。
+ 模型生成的自定义工具调用的输入。
- `name: string`
- 被调用的自定义工具的名称。
+ 正在调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -4097,11 +4097,11 @@
- `id: optional string`
- 自定义工具调用在 OpenAI 平台上的唯一 ID。
+ 在 OpenAI 平台中自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -4113,7 +4113,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4121,15 +4121,15 @@
- `namespace: optional string`
- 被调用的自定义工具的命名空间。
+ 正在调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
- 压缩当前上下文。必须是最后的输入项。
+ 压缩当前上下文。必须是最终的输入项。
- `type: "compaction_trigger"`
- 该项的类型。始终为 `compaction_trigger`.
+ 该 item 的类型。始终为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -4155,19 +4155,19 @@
- `id: string`
- 该程序条目的唯一 ID。
+ 此程序条目的唯一 ID。
- `call_id: string`
- 该程序条目的稳定调用 ID。
+ 程序条目的稳定调用 ID。
- `code: string`
- 由编程式工具调用执行的 JavaScript 源代码。
+ 通过程序化工具调用执行的 JavaScript 源码。
- `fingerprint: string`
- 必须来回透传的不透明程序回放指纹。
+ 必须往返传输的不透明程序回放指纹。
- `type: "program"`
@@ -4183,11 +4183,11 @@
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
@@ -4207,33 +4207,33 @@
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,来自上一次
- 响应的指令将不会延续到下一个响应。这样可以方便地
- 在新的响应中替换系统(或开发者)消息。
+ 在与 `previous_response_id`,一起使用时,前一次
+ response 中的指令不会延续到下一次 response。这使得在新的响应中替换系统(或开发者)消息变得简单
+ 。
- `max_output_tokens: optional number or null`
- 响应可生成 token 数量的上限,包括可见输出 token 以及 [推理 token](/docs/guides/reasoning).
+ 响应可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 在一次响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非按单个工具计算。模型后续任何进一步的工具调用尝试都将被忽略。
+ 单个响应中可处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `metadata: optional Metadata or null`
- 可附加到对象的 16 个键值对集合。这可以
- 以结构化格式存储关于对象的附加信息,
- 格式,以及通过 API 或仪表板查询对象。
+ 可以附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储有关对象的附加信息,并通过
+ format,以及通过 API 或控制台查询对象。
- 键为字符串,最大长度为 64 个字符。值为字符串
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: optional ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
+ 用于生成响应的模型 ID,如 `gpt-5.6-sol`。OpenAI
提供多种不同能力、性能
特征和价格的模型。请参阅 [模型指南](/docs/models)
- 以浏览和比较可用模型。
+ 以浏览和比较可用的模型。
- `string`
@@ -4447,11 +4447,11 @@
- `moderation: optional object { model, policy } or null`
- 用于对此响应的输入和输出运行审核的配置。
+ 用于对此响应的输入和输出运行内容安全审查的配置。
- `model: string`
- 用于已审核补全的审核模型,例如 'omni-moderation-latest'。
+ 用于已审核补全的内容安全审查模型,例如 'omni-moderation-latest'。
- `policy: optional object { input, output } or null`
@@ -4459,7 +4459,7 @@
- `input: optional object { mode } or null`
- 响应输入的审核策略。
+ 响应输入的内容安全审查策略。
- `mode: "score" or "block"`
@@ -4469,7 +4469,7 @@
- `output: optional object { mode } or null`
- 响应输出的审核策略。
+ 响应输出的内容安全审查策略。
- `mode: "score" or "block"`
@@ -4483,9 +4483,9 @@
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。使用此 ID 可
+ 上一次模型响应的唯一 ID。用它来
创建多轮对话。详细了解
- [对话状态](/docs/guides/conversation-state)。无法与 `conversation`.
+ [对话状态](/docs/guides/conversation-state)。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
@@ -4498,39 +4498,39 @@
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的值映射,用于替换你的
- 提示词中的变量。替换值可以是字符串,也可以是其他
+ 可选的映射,用于在你的
+ 提示词中替换变量。替换值可以是字符串,也可以是其他
Response 输入类型,例如图片或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `version: optional string or null`
- 可选的提示词模板版本。
+ 提示词模板的可选版本。
- `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"`
@@ -4538,24 +4538,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).
- 该字段表示最长保留策略,而
- `prompt_cache_options.ttl` 表示最短缓存生命周期。这两个字段彼此独立且互不影响。
- 字段彼此独立且互不影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,及未来模型,仅支持 `24h` 。
+ 提示缓存的保留策略。设置为 `24h` 以启用扩展提示缓存,使缓存的前缀保持更长时间的活跃状态,最长可达 24 小时。 [了解更多](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最大保留策略,而
+ `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 的组织默认为 `24h`.
+ - 已启用 ZDR 的组织默认为 `in_memory` 当 `prompt_cache_retention` 未指定时。
- `"in_memory"`
@@ -4563,20 +4563,18 @@
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o 系列模型**
-
- 用于
+ 针对
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续轮次中向模型回传的推理项。
- 如果省略或设置为 `auto`,则由模型决定上下文模式。该
- `gpt-5.6` 模型系列默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中哪些推理项会被重新渲染回模型。
+ 如果省略或设置为 `auto`,模型将自行决定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;较早的模型默认为
`current_turn`.
- 在响应中返回时,这是该响应实际使用的有效推理上下文模式。
- 用于该响应。
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
+ 。
- `"auto"`
@@ -4586,11 +4584,11 @@
- `effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`、以及 `max`.
- 降低推理投入程度可以带来更快的响应,并在响应中消耗更少的
- 推理 tokens 并非所有推理模型都支持每个
- 值。请参阅
+ 约束推理模型的推理力度。当前支持
+ 的取值有 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理力度可以让响应更快,并减少响应中用于推理的令牌数量。
+ 并非所有推理模型都支持每个
+ 取值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
了解特定模型的支持情况。
@@ -4610,11 +4608,11 @@
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已弃用:** 使用 `summary` 替代。
+ **已弃用:** 使用 `summary` 代替。
- 对模型所执行推理的摘要。这可以
- 有助于调试和理解模型的推理过程。
- 以下之一 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这对于调试和理解模型的推理过程
+ 很有用。
+ 取值之一 `auto`, `concise`,或 `detailed`.
- `"auto"`
@@ -4624,17 +4622,17 @@
- `mode: optional string or "standard" or "pro"`
- 控制该请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,这是实际生效的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 控制该请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,这是实际生效的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -4642,11 +4640,11 @@
- `summary: optional "auto" or "concise" or "detailed" or null`
- 对模型所执行推理的摘要。这可以
- 有助于调试和理解模型的推理过程。
- 以下之一 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这对于调试和理解模型的推理过程
+ 很有用。
+ 取值之一 `auto`, `concise`,或 `detailed`.
- `concise` 可用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型和之后的 `computer-use-preview` 推理模型 `gpt-5`.
- `"auto"`
@@ -4656,21 +4654,21 @@
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 'auto',则该请求将按照项目设置中配置的服务层级进行处理。除非另行配置,项目将使用 'default'。
+ - 如果设置为 'default',则该请求将按照所选模型的标准定价和性能进行处理。
- 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [快速模式](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。此层级当前可用于 `gpt-5.6-sol`;通过该层级提供的响应将显示 `service_tier=ultrafast`.
+ - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
- 未设置时,默认行为为 'auto'。
- 当 `service_tier` 参数被设置时,响应体将根据实际用于处理该请求的处理模式包含相应的 `service_tier` 值。此响应值可能与该参数中设置的值不同。
+ 当 `service_tier` 参数已设置,响应体将包含基于实际用于处理请求的 `service_tier` 处理模式所得到的值。该响应值可能与参数中设置的值不同。
- `"auto"`
@@ -4693,33 +4691,33 @@
- `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).
- 参见下文 [流式部分](/docs/api-reference/responses-streaming)
+ 如果设置为 true,模型响应数据将以流式方式在生成时
+ 发送到客户端,使用 [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+ 参见下方 [流式传输部分](/docs/api-reference/responses-streaming)
了解更多信息。
- `stream_options: optional object { include_obfuscation } or null`
- 流式响应的选项。仅当你设置 `stream: true`.
+ 流式响应的选项。仅当你设置了 `stream: true`.
- `include_obfuscation: optional boolean`
- 为 true 时启用流式混淆。流式混淆会向
- 字段添加 `obfuscation` 随机字符,以规范化流式增量事件上的载荷大小,从而缓解某些侧信道攻击。
- 这些混淆字段默认包含在内,但会增加数据流的一小部分开销。
- 如果你信任你的应用程序与
- 之间的网络链路,可以将 `include_obfuscation` 设置为
- 设置为 false 以优化带宽。
- OpenAI API。
+ 为 true 时,将启用流混淆。流混淆会向流式
+ 增量事件的某个字段添加 `obfuscation` 随机字符,以均衡负载大小,作为对某些侧信道
+ 攻击的缓解措施。这些混淆字段默认会被包含,但会给数据流带来少量。
+ 开销。如果你信任你的应用与 OpenAI API 之间的网络链路,可以将
+ 设置为 false 以优化带宽。 `include_obfuscation` 设置为
+ 为 false 以优化带宽,如果你信任你的应用与
+ 该公司 接口 之间的网络链路。
- `temperature: optional number or null`
- 使用的采样温度,介于 0 到 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加聚焦和确定性。
- 我们通常建议修改此设置或 `top_p` 但不要同时修改两者。
+ 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定性更强。
+ 我们通常建议修改此参数或 `top_p` 但不能同时使用两者。
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
+ 用于配置模型返回的文本响应格式。可以是纯文本或结构化的 JSON 数据。了解更多:
文本或结构化 JSON 数据。了解更多:
- [文本输入与输出](/docs/guides/text)
@@ -4727,19 +4725,19 @@
- `format: optional ResponseFormatTextConfig`
- 一个对象,用于指定模型必须输出的格式。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 会启用结构化输出,
- 从而确保模型与你提供的 JSON schema 匹配。详见
+ 配置 `{ "type": "json_schema" }` 可启用结构化输出,
+ 从而确保模型的输出与你提供的 JSON schema 完全匹配。更多信息请参阅
[结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` 且无其他选项。
+ 默认格式为 `{ "type": "text" }` ,不包含额外选项。
**不推荐用于 gpt-4o 及更新的模型:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
- 确保模型生成的消息是有效的 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该模式。
+ 设置为 `{ "type": "json_object" }` 可启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,推荐使用结构化输出。
- `ResponseFormatText object { type }`
@@ -4747,62 +4745,62 @@
- `type: "text"`
- 正在定义的响应格式的类型。始终为 `text`.
+ 正在定义的响应格式类型。始终为 `text`.
- `"text"`
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多信息 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [结构化输出](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON 架构对象描述。
- 了解如何构建 JSON 架构 [信息](https://json-schema.org/).
+ 响应格式所对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON schema [here](https://json-schema.org/).
- `type: "json_schema"`
- 正在定义的响应格式的类型。始终为 `json_schema`.
+ 正在定义的响应格式类型。始终为 `json_schema`.
- `"json_schema"`
- `description: optional string`
- 响应格式用途的描述,模型使用该描述
- 确定如何按该格式进行响应。
+ 对响应格式用途的描述,供模型用于
+ 确定如何在该格式中作出响应。
- `strict: optional boolean or null`
- 生成输出时是否启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循所定义的确切架构
- 中的 `schema` 字段。仅支持 JSON Schema 的一个子集,
- `strict` 被 `true`。要了解更多信息,请参阅 [结构化输出
+ 是否在生成输出时启用严格的 schema 遵从。
+ 若设为 true,模型将始终遵循在
+ 字段中定义的精确 schema。仅支持部分 JSON Schema, `schema` 当
+ `strict` is `true`。为 true 时。要了解更多信息,请参阅 [结构化输出
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 建议在支持的模型上使用 `json_schema` 。请注意,
- 模型在收到系统或用户消息明确指示前不会生成 JSON,
- 因此需要相应指令。
+ JSON 对象响应格式。一种较老的生成 JSON 响应的方法。
+ 建议使用 `json_schema` 以支持相关功能的模型。请注意,
+ 模型在没有系统或用户消息指示的情况下不会生成 JSON,
+ 指示它这样做。
- `type: "json_object"`
- 正在定义的响应格式的类型。始终为 `json_object`.
+ 正在定义的响应格式类型。始终为 `json_object`.
- `"json_object"`
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更高的值将生成更简洁的响应,而较低的值将生成更冗长的响应。
- 当前支持的值包括 `low`, `medium`、以及 `high`。默认值为
+ 限制模型响应的详细程度。较低的值会得到
+ 更简洁的响应,而较高的值会得到更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -4813,15 +4811,15 @@
- `tool_choice: optional ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成响应时应如何选择要使用的工具(一个或多个)。请参阅
- 参数,了解如何指定模型可以调用的工具。 `tools` 参数以了解如何指定哪些工具
- 模型可以调用。
+ 指定模型在生成响应时应如何选择使用哪个(或哪些)工具。
+ 有关如何指定可调用工具的信息,请参阅 `tools` 参数。
+ 模型可以调用的工具。
- `ToolChoiceOptions = "none" or "auto" or "required"`
- 控制模型调用哪个工具(如果有的话)。
+ 控制由模型调用哪个工具(如果有)。
- `none` 表示模型将不调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息与调用一个或
多个工具之间进行选择。
@@ -4836,16 +4834,16 @@
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为预定义的集合。
+ 将模型可使用的工具限制为一组预定义工具。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为预定义的集合。
+ 将模型可使用的工具限制为一组预定义工具。
- `auto` 允许模型从允许的工具中进行选择,并生成一条
+ `auto` 允许模型从允许的工具中进行选择并生成一条
消息。
- `required` 要求模型调用一个或多个允许的工具。
+ `required` 要求模型调用允许的工具中的一个或多个。
- `"auto"`
@@ -4853,7 +4851,7 @@
- `tools: array of map[unknown]`
- 模型应被允许调用的工具定义列表。
+ 模型可以调用的工具定义列表。
对于 Responses API,工具定义列表可能如下所示:
@@ -4873,15 +4871,15 @@
- `ToolChoiceTypes object { type }`
- 指示模型应使用内置工具生成响应。
- [了解有关内置工具的更多信息](/docs/guides/tools).
+ 指示模型应使用内置工具来生成响应。
+ [详细了解内置工具](/docs/guides/tools).
- `type: "file_search" or "web_search_preview" or "computer" or 5 more`
- 模型应使用的托管工具类型。了解有关
+ 模型应使用的托管工具类型。详细了解
[内置工具](/docs/guides/tools).
- 允许的值为:
+ 允许的取值为:
- `file_search`
- `web_search_preview`
@@ -4909,7 +4907,7 @@
- `ToolChoiceFunction object { name, type }`
- 使用此选项可强制模型调用特定函数。
+ 使用此选项可强制模型调用特定的函数。
- `name: string`
@@ -4923,7 +4921,7 @@
- `ToolChoiceMcp object { server_label, type, name }`
- 使用此选项可强制模型调用远程 MCP 服务器上的特定工具。
+ 使用此选项可以强制模型调用远程 MCP 服务器上的特定工具。
- `server_label: string`
@@ -4941,7 +4939,7 @@
- `ToolChoiceCustom object { name, type }`
- 使用此选项可强制模型调用特定的自定义工具。
+ 使用此选项可以强制模型调用特定的自定义工具。
- `name: string`
@@ -4957,53 +4955,53 @@
- `type: "programmatic_tool_calling"`
- 要调用的工具。始终 `programmatic_tool_calling`.
+ 要调用的工具。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
- `ToolChoiceApplyPatch object { type }`
- 在执行工具调用时强制模型调用 apply_patch 工具。
+ 强制模型在执行工具调用时调用 apply_patch 工具。
- `type: "apply_patch"`
- 要调用的工具。始终 `apply_patch`.
+ 要调用的工具。始终为 `apply_patch`.
- `"apply_patch"`
- `ToolChoiceShell object { type }`
- 在需要工具调用时强制模型调用 shell 工具。
+ 在需要工具调用时,强制模型调用 shell 工具。
- `type: "shell"`
- 要调用的工具。始终 `shell`.
+ 要调用的工具。始终为 `shell`.
- `"shell"`
- `tools: optional array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定要使用的工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供、可扩展模型能力的工具,例如
- 模型的各项能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多信息
+ - **内置工具**: 由 OpenAI 提供的可扩展模型能力的工具,例如
+ 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
[内置工具](/docs/guides/tools).
- - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。了解更多信息
- [MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够使用强类型参数和输出调用你自己的代码。了解更多信息
- 和输出。了解更多信息
+ - **MCP Tools**: 通过自定义 MCP 服务器或预定义连接器(如 Google Drive 和 SharePoint)与第三方系统集成。了解更多关于
+ 或 Google Drive 和 SharePoint 等预定义连接器与第三方系统集成。了解更多关于
+ [MCP Tools](/docs/guides/tools-connectors-mcp).
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码
+ 和输出。了解更多关于
[函数调用](/docs/guides/function-calling)。你也可以使用
- 自定义工具调用你自己的代码。
+ 自定义工具来调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -5015,7 +5013,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -5033,45 +5031,45 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -5079,15 +5077,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -5099,21 +5097,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -5139,18 +5137,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -5158,7 +5156,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -5166,14 +5164,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -5191,7 +5189,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5199,7 +5197,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -5209,16 +5207,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -5232,21 +5230,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -5254,26 +5252,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -5293,32 +5291,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -5326,13 +5324,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -5340,9 +5338,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -5350,27 +5348,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -5378,7 +5376,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -5388,7 +5386,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -5455,9 +5453,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5468,7 +5466,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -5485,7 +5483,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -5515,7 +5513,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -5538,7 +5536,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -5555,13 +5553,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -5609,7 +5607,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -5631,7 +5629,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -5639,11 +5637,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -5651,7 +5649,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -5675,23 +5673,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -5713,7 +5711,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -5721,7 +5719,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -5741,11 +5739,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -5753,15 +5751,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -5775,7 +5773,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -5799,7 +5797,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5807,7 +5805,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -5829,27 +5827,27 @@
- `top_logprobs: optional number or null`
- 一个介于 0 和 20 之间的整数,指定在每个词元位置最多返回的词元数量,每个词元都有一个关联的对数
- 词元,每个词元都有一个关联的对数概率
- 概率。在某些情况下,返回的词元数量可能少于
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的
+ 最大可能性 token 数量,每个 token 都带有对应的对数
+ 概率。在某些情况下,返回的 token 数量可能少于
请求的数量。
- `top_p: optional number or null`
- 一种温度采样的替代方法,称为核采样(nucleus sampling),
- 模型会考虑概率质量排名前 top_p 的词元的结果。
- 因此 0.1 表示仅考虑概率质量排名前 10% 的词元
+ 一种称为 nucleus 采样的温度采样替代方案,
+ 模型在此考虑 top_p 概率对应的 token 结果
+ 的位置。因此 0.1 表示仅考虑构成前 10% 概率质量的 token
。
- 我们通常建议修改此设置或 `temperature` 但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不能同时使用两者。
- `truncation: optional "auto" or "disabled" or null`
用于模型响应的截断策略。
- `auto`:如果此 Response 的输入超过
- 模型的上下文窗口大小,模型将通过丢弃对话开头的条目来
- 截断响应以适配上下文窗口。
+ 模型的上下文窗口大小,模型将通过从对话开头丢弃内容来截断
+ 响应以适配上下文窗口。
- `disabled` (默认):如果输入大小将超过模型的上下文窗口
大小,请求将失败并返回 400 错误。
@@ -5859,11 +5857,11 @@
- `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).
-### Returns
+### 返回值
- `Response object { id, created_at, error, 32 more }`
@@ -5925,11 +5923,11 @@
- `message: string`
- 错误的可读描述。
+ 易于阅读的错误描述。
- `incomplete_details: object { reason } or null`
- 关于响应为何未完成的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
@@ -5943,45 +5941,45 @@
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,来自上一次
- 响应的指令将不会延续到下一个响应。这样可以方便地
- 在新的响应中替换系统(或开发者)消息。
+ 在与 `previous_response_id`,一起使用时,前一次
+ response 中的指令不会延续到下一次 response。这使得在新的响应中替换系统(或开发者)消息变得简单
+ 。
- `string`
- 发送给模型的文本输入,等同于带有以下角色的文本输入:
- `developer` 。
+ 传递给模型的文本输入,等同于带有
+ `developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 发送给模型的一个或多个输入项列表,包含
- 不同的内容类型。
+ 包含一个或多个输入项的列表,传递给模型,这些输入项可
+ 包含不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,其角色指示了指令的
- 优先级层次。使用 `developer` 或 `system` 角色给出的指令
- 优先于使用以下角色给出的指令 `user` 。带有
- `assistant` 角色的消息假定为模型在之前交互中
+ 传递给模型的消息输入,其角色用于指示指令优先级。通过
+ 层级角色给出的指令优先级,高于 `developer` 或 `system` 角色给出的指令。带有
+ 层级角色的指令优先于使用 `user` 角色给出的指令。带有
+ `assistant` 角色的消息被视为模型在之前的交互中
生成的内容。
- `content: string or ResponseInputMessageContentList`
- 发送给模型的文本、图片或音频输入,用于生成响应。
+ 传递给模型的文本、图像或音频输入,用于生成响应。
也可以包含之前的助手响应。
- `TextInput = string`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 发送给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一条或多条输入项的列表,包含不同的内容
类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
@@ -5995,7 +5993,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -6005,7 +6003,7 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
@@ -6027,15 +6025,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像的 URL。可以是完整的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -6045,7 +6043,7 @@
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `type: "input_file"`
@@ -6055,7 +6053,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 的使用量。使用 `low` 用于降低渲染成本,或 `high` 以更高质量渲染文件。默认值为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 用于以更低成本进行渲染,或 `high` 以更高质量渲染文件时使用。默认为 `auto`.
- `"auto"`
@@ -6065,23 +6063,23 @@
- `file_data: optional string`
- 要发送给模型的文件内容。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string`
- 要发送给模型的文件名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -6104,9 +6102,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将消息标记为 `assistant` 中间评论(`commentary`)或最终答案(`final_answer`).
- 对于类似 `gpt-5.3-codex` 及以上的模型,在发送后续请求时,请保留并重新发送
- 字段作用于所有助手消息——丢弃该字段可能导致性能下降。该字段不用于用户消息。
+ 将该 `assistant` 消息标记为中间说明性内容(`commentary`)或最终答复(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段在所有助手消息上——丢弃它可能导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -6114,19 +6112,19 @@
- `type: optional "message"`
- 消息输入的类型,始终为 `message`.
+ 消息输入的类型,始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,其角色指示了指令的
- 优先级层次。使用 `developer` 或 `system` 角色给出的指令
- 优先于使用以下角色给出的指令 `user` 。
+ 传递给模型的消息输入,其角色用于指示指令优先级。通过
+ 层级角色给出的指令优先级,高于 `developer` 或 `system` 角色给出的指令。带有
+ 层级角色的指令优先于使用 `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 发送给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一条或多条输入项的列表,包含不同的内容
类型。
- `role: "user" or "system" or "developer"`
@@ -6141,8 +6139,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 项的状态,取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ 条目的状态,取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -6158,7 +6156,7 @@
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 来自模型的输出消息。
+ 模型输出的消息。
- `id: string`
@@ -6170,7 +6168,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 来自模型的文本输出。
+ 模型输出的文本。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -6186,11 +6184,11 @@
- `filename: string`
- 被引用文件的文件名。
+ 所引用文件的文件名。
- `index: number`
- 该文件在文件列表中的索引。
+ 文件在文件列表中的索引。
- `type: "file_citation"`
@@ -6200,7 +6198,7 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型回复的网页资源引用。
+ 用于生成模型回答的网页资源引用。
- `end_index: number`
@@ -6226,7 +6224,7 @@
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
- 用于生成模型回复的容器文件引用。
+ 用于生成模型回答的容器文件引用。
- `container_id: string`
@@ -6242,7 +6240,7 @@
- `filename: string`
- 被引用容器文件的文件名。
+ 所引用容器文件的文件名。
- `start_index: number`
@@ -6264,7 +6262,7 @@
- `index: number`
- 该文件在文件列表中的索引。
+ 文件在文件列表中的索引。
- `type: "file_path"`
@@ -6290,7 +6288,7 @@
- `text: string`
- 模型输出的文本内容。
+ 模型输出的文本。
- `type: "output_text"`
@@ -6300,15 +6298,15 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝响应。
+ 模型的拒绝回复。
- `refusal: string`
- 模型给出的拒绝原因说明。
+ 模型的拒绝解释。
- `type: "refusal"`
- 拒绝响应的类型。始终为 `refusal`.
+ 拒绝的类型。始终为 `refusal`.
- `"refusal"`
@@ -6320,8 +6318,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。可选值为以下之一: `in_progress`, `completed`,或
- `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。通过 API 返回输入项时填充。
- `"in_progress"`
@@ -6337,9 +6335,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将消息标记为 `assistant` 中间评论(`commentary`)或最终答案(`final_answer`).
- 对于类似 `gpt-5.3-codex` 及以上的模型,在发送后续请求时,请保留并重新发送
- 字段作用于所有助手消息——丢弃该字段可能导致性能下降。该字段不用于用户消息。
+ 将该 `assistant` 消息标记为中间说明性内容(`commentary`)或最终答复(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请保留并重新发送
+ 阶段在所有助手消息上——丢弃它可能导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -6347,7 +6345,7 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。请参阅
+ 文件搜索 工具调用的结果。参见
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -6356,11 +6354,11 @@
- `queries: array of string`
- 用于搜索文件的查询语句。
+ 用于搜索文件的查询。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。可选值为以下之一: `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -6385,11 +6383,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 个键值对集合。这可以
- 以结构化格式存储关于对象的附加信息,
- 并通过 API 或仪表板查询对象。键为字符串
- 最大长度为 64 个字符。值为最大长度
- 为 512 个字符的字符串、布尔值或数字。
+ 可以附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储有关对象的附加信息,并通过
+ API 或控制台查询对象。键为字符串
+ 最大长度为 64 个字符。值是最大
+ 长度为 512 个字符的字符串、布尔值或数字。
- `string`
@@ -6407,7 +6405,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,介于 0 和 1 之间。
- `text: optional string`
@@ -6416,7 +6414,7 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
对计算机使用工具的工具调用。参见
- [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
+ [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
@@ -6424,11 +6422,11 @@
- `call_id: string`
- 使用输出响应工具调用时所使用的标识符。
+ 在向工具调用提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
- 计算机调用中待处理的安全检查。
+ 计算机调用的待处理安全检查。
- `id: string`
@@ -6445,7 +6443,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -6455,21 +6453,21 @@
- `type: "computer_call"`
- 计算机调用的类型。始终为 `computer_call`.
+ 计算机调用的类型,恒为 `computer_call`.
- `"computer_call"`
- `action: optional ComputerAction`
- 点击操作。
+ 点击动作。
- `Click object { button, type, x, 2 more }`
- 点击操作。
+ 点击动作。
- `button: "left" or "right" or "wheel" or 2 more`
- 指示点击时按下的鼠标按键。取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指明点击时按下的鼠标按键。取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -6483,13 +6481,13 @@
- `type: "click"`
- 指定事件类型。对于点击操作,此属性始终为 `click`.
+ 指定事件类型。对于点击动作,该属性恒为 `click`.
- `"click"`
- `x: number`
- 发生点击的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
@@ -6509,7 +6507,7 @@
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击动作,该属性始终设置为 `double_click`.
- `"double_click"`
@@ -6527,7 +6525,7 @@
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式出现,例如
+ 一个由坐标构成的数组,表示拖动动作的路径。坐标将作为对象数组出现,例如
```
[
@@ -6546,7 +6544,7 @@
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动动作,该属性始终设置为 `drag`.
- `"drag"`
@@ -6556,7 +6554,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的按键操作的集合。
- `keys: array of string`
@@ -6564,7 +6562,7 @@
- `type: "keypress"`
- 指定事件类型。对于按键动作,此属性始终设置为 `keypress`.
+ 指定事件类型。对于按键动作,该属性始终设置为 `keypress`.
- `"keypress"`
@@ -6574,17 +6572,17 @@
- `type: "move"`
- 指定事件类型。对于移动动作,此属性始终设置为 `move`.
+ 指定事件类型。对于移动动作,该属性始终设置为 `move`.
- `"move"`
- `x: number`
- 要移至的 x 坐标。
+ 要移动到的 x 坐标。
- `y: number`
- 要移至的 y 坐标。
+ 要移动到的 y 坐标。
- `keys: optional array of string or null`
@@ -6592,17 +6590,17 @@
- `Screenshot object { type }`
- 截屏动作。
+ 截图操作。
- `type: "screenshot"`
- 指定事件类型。对于截屏动作,此属性始终设置为 `screenshot`.
+ 指定事件类型。对于截图操作,此属性始终设置为 `screenshot`.
- `"screenshot"`
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
- 滚动动作。
+ 滚动操作。
- `scroll_x: number`
@@ -6614,17 +6612,17 @@
- `type: "scroll"`
- 指定事件类型。对于滚动动作,此属性始终设置为 `scroll`.
+ 指定事件类型。对于滚动操作,此属性始终设置为 `scroll`.
- `"scroll"`
- `x: number`
- 发生滚动位置的 x 坐标。
+ 发生滚动事件的 x 坐标。
- `y: number`
- 发生滚动位置的 y 坐标。
+ 发生滚动事件的 y 坐标。
- `keys: optional array of string or null`
@@ -6632,7 +6630,7 @@
- `Type object { text, type }`
- 用于输入文本的动作。
+ 输入文本的操作。
- `text: string`
@@ -6640,28 +6638,28 @@
- `type: "type"`
- 指定事件类型。对于输入动作,此属性始终设置为 `type`.
+ 指定事件类型。对于输入操作,此属性始终设置为 `type`.
- `"type"`
- `Wait object { type }`
- 等待动作。
+ 等待操作。
- `type: "wait"`
- 指定事件类型。对于等待动作,此属性始终设置为 `wait`.
+ 指定事件类型。对于等待操作,此属性始终设置为 `wait`.
- `"wait"`
- `actions: optional ComputerActionList`
- 为 `computer_use`。扁平化后的批量动作。每个动作包含一个
- `type` 判别字段以及动作专属字段。
+ 针对的扁平化批处理操作 `computer_use`。每个操作都包含一个
+ `type` 判别字段以及操作特有的字段。
- `Click object { button, type, x, 2 more }`
- 点击操作。
+ 点击动作。
- `DoubleClick object { keys, type, x, y }`
@@ -6673,7 +6671,7 @@
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的按键操作的集合。
- `Move object { type, x, y, keys }`
@@ -6681,19 +6679,19 @@
- `Screenshot object { type }`
- 截屏动作。
+ 截图操作。
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
- 滚动动作。
+ 滚动操作。
- `Type object { text, type }`
- 用于输入文本的动作。
+ 输入文本的操作。
- `Wait object { type }`
- 等待动作。
+ 等待操作。
- `ComputerCallOutput object { call_id, output, type, 3 more }`
@@ -6701,7 +6699,7 @@
- `call_id: string`
- 产生该输出的计算机工具调用的 ID。
+ 生成该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
@@ -6734,7 +6732,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由开发者确认的 API 报告的安全检查。
+ 由 API 报告的、已被开发者确认的安全检查。
- `id: string`
@@ -6750,7 +6748,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。可选值为以下之一: `in_progress`, `completed`,或 `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。通过 API 返回输入项时填充。
- `"in_progress"`
@@ -6760,21 +6758,21 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索 工具调用的结果。请参阅
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 该 网页搜索 工具调用的唯一 ID。
+ 网页搜索 工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行具体操作的对象。
+ 描述本次 网页搜索 调用中所执行的具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 “search”——执行一次 网页搜索 查询。
+ 操作类型 "search" - 执行 网页搜索 查询。
- `type: "search"`
@@ -6784,11 +6782,11 @@
- `queries: optional array of string`
- 搜索查询语句。
+ 搜索查询。
- `query: optional string`
- 搜索查询语句。
+ 搜索查询。
- `sources: optional array of object { type, url }`
@@ -6796,7 +6794,7 @@
- `type: "url"`
- 来源的类型。始终为 `url`.
+ 来源类型。始终为 `url`.
- `"url"`
@@ -6806,7 +6804,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 操作类型 "open_page" —— 从搜索结果中打开指定的 URL。
- `type: "open_page"`
@@ -6824,7 +6822,7 @@
- `pattern: string`
- 要在页面内搜索的模式或文本。
+ 要在页面中搜索的模式或文本。
- `type: "find_in_page"`
@@ -6834,7 +6832,7 @@
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -6883,7 +6881,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -6895,7 +6893,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -6908,7 +6906,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -6934,7 +6932,7 @@
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
@@ -6948,7 +6946,7 @@
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -6958,7 +6956,7 @@
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision)
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision)
- `type: "input_image"`
@@ -6972,15 +6970,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完全限定的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像的 URL。可以是完整的 URL,也可以是 data URL 中的 base64 编码图像。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -6990,7 +6988,7 @@
- `ResponseInputFileContent object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `type: "input_file"`
@@ -7000,7 +6998,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 的使用量。使用 `low` 用于降低渲染成本,或 `high` 以更高质量渲染文件。默认值为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 用于以更低成本进行渲染,或 `high` 以更高质量渲染文件时使用。默认为 `auto`.
- `"auto"`
@@ -7014,19 +7012,19 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string or null`
- 要发送给模型的文件的 URL。
+ 发送给模型的文件的 URL。
- `filename: optional string or null`
- 要发送给模型的文件名称。
+ 发送给模型的文件的名称。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点继承请求的 `prompt_cache_options.ttl`;边界不会取整到 token 块。
+ 标记可复用提示前缀的精确结束位置。该断点的 TTL 继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -7042,7 +7040,7 @@
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当此条目通过 API 返回时会填充该字段。
+ 函数工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: optional string or null`
@@ -7050,7 +7048,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -7064,7 +7062,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7074,15 +7072,15 @@
- `name: optional string or null`
- 产生该输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 产生该输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。取值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回项时会填充。
+ 条目的状态。取值为 `in_progress`, `completed`,或 `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -7112,7 +7110,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -7136,7 +7134,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -7148,7 +7146,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -7166,37 +7164,37 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `key: string`
@@ -7209,11 +7207,11 @@
- `eq`: 等于
- `ne`: 不等于
- `gt`: 大于
- - `gte`: 大于等于
+ - `gte`: 大于或等于
- `lt`: 小于
- - `lte`: 小于等于
- - `in`: 包含于
- - `nin`: 不包含于
+ - `lte`: 小于或等于
+ - `in`: 包含
+ - `nin`: 不包含
- `"eq"`
@@ -7233,7 +7231,7 @@
- `value: string or number or boolean or array of string or number`
- 与属性键进行比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -7249,15 +7247,15 @@
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 要组合的过滤器数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `unknown`
@@ -7271,7 +7269,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -7279,15 +7277,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -7299,21 +7297,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -7339,18 +7337,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -7358,7 +7356,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -7366,14 +7364,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -7391,7 +7389,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -7399,7 +7397,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -7409,16 +7407,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -7432,21 +7430,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -7454,26 +7452,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -7493,32 +7491,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -7526,13 +7524,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -7540,9 +7538,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -7550,27 +7548,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -7578,7 +7576,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -7588,7 +7586,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -7610,7 +7608,7 @@
- `type: "disabled"`
- 禁用出站网络访问。始终 `disabled`.
+ 禁用出站网络访问。Always `disabled`.
- `"disabled"`
@@ -7618,17 +7616,17 @@
- `allowed_domains: array of string`
- 当 type 为 `allowlist`.
+ 当类型为 allowed_domains 时允许访问的域名列表。 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域进行出站网络访问。始终 `allowlist`.
+ 仅允许向指定域发出出站网络访问。Always `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 针对已加入允许列表的域的可选域作用域密钥。
+ 用于白名单域的可选域作用域密钥。
- `domain: string`
@@ -7687,9 +7685,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -7700,7 +7698,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -7717,7 +7715,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -7747,7 +7745,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -7770,7 +7768,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -7787,13 +7785,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -7837,13 +7835,13 @@
- `type: "container_auto"`
- 自动为本次请求创建一个容器
+ 自动为该请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -7883,7 +7881,7 @@
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略以使用默认值。
+ 可选的技能版本。使用正整数或 'latest'。省略时使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -7931,7 +7929,7 @@
- `skills: optional array of LocalSkill`
- 一个可选的技能列表。
+ 可选的技能列表。
- `description: string`
@@ -7959,7 +7957,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -7981,7 +7979,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -7989,7 +7987,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Text object { type }`
@@ -8011,7 +8009,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法。取值之一为 `lark` 或 `regex`.
+ 语法定义的语法。取值为以下之一 `lark` 或 `regex`.
- `"lark"`
@@ -8025,7 +8023,7 @@
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -8033,7 +8031,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -8057,23 +8055,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8095,7 +8093,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -8103,7 +8101,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -8123,11 +8121,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -8135,15 +8133,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -8157,7 +8155,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -8181,7 +8179,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -8189,7 +8187,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -8225,7 +8223,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -8255,7 +8253,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -8267,7 +8265,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -8285,45 +8283,45 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -8331,15 +8329,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -8351,21 +8349,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -8391,18 +8389,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -8410,7 +8408,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -8418,14 +8416,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -8443,7 +8441,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -8451,7 +8449,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -8461,16 +8459,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -8484,21 +8482,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -8506,26 +8504,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -8545,32 +8543,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -8578,13 +8576,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -8592,9 +8590,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -8602,27 +8600,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -8630,7 +8628,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -8640,7 +8638,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -8707,9 +8705,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -8720,7 +8718,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -8737,7 +8735,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -8767,7 +8765,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -8790,7 +8788,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -8807,13 +8805,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -8861,7 +8859,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8883,7 +8881,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -8891,11 +8889,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -8903,7 +8901,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -8927,23 +8925,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -8965,7 +8963,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -8973,7 +8971,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -8993,11 +8991,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -9005,15 +9003,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -9027,7 +9025,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -9051,7 +9049,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -9059,7 +9057,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -9091,10 +9089,10 @@
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成回复时所使用的思维链描述。请务必将这些条目包含在你的
- 中,以便在后续对话轮次中传递给 Responses API `input` 至 响应接口
- ,如果你正在手动管理
- [上下文](/docs/guides/conversation-state).
+ 对推理模型在生成回复时所使用的思维链的描述。如果你手动管理上下文,请务必在后续对话轮次中将这些条目包含在提交给 响应接口 的
+ 中。 `input` 请求里
+ 。
+ [管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -9136,20 +9134,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。该字段默认填充
- 用于由 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充
+ 由 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求返回的推理条目。
- 在流式传输时,使用已完成的推理项及其
+ 在流式传输时,请使用已完成的推理条目及其
`encrypted_content` 从 `response.output_item.done` 事件中
- 后续请求。该 `encrypted_content` 中
- `response.output_item.added` 可能不完整。这一点尤其
- 重要,在 `store` 被 `false` 截断,或者使用 Zero Data Retention 时。
+ 后续请求中获取。由于 `encrypted_content` 处于
+ `response.output_item.added` 中的数据可能不完整。尤其是在
+ important when `store` is `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -9159,7 +9157,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由 API 生成的压缩项 [`v1/responses/compact` 接口](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -9167,13 +9165,13 @@
- `type: "compaction"`
- 该项的类型。始终为 `compaction`.
+ 该 item 的类型。始终为 `compaction`.
- `"compaction"`
- `id: optional string or null`
- 压缩条目的 ID。
+ 压缩项的 ID。
- `ImageGenerationCall object { id, result, status, type }`
@@ -9224,7 +9222,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 若没有可用输出,可能为 null。
- `Logs object { logs, type }`
@@ -9256,7 +9254,7 @@
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`、以及 `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -9310,7 +9308,7 @@
- `working_directory: optional string or null`
- 运行命令所在的可选工作目录。
+ 运行命令时所在的可选工作目录。
- `call_id: string`
@@ -9362,11 +9360,11 @@
- `ShellCall object { action, call_id, type, 4 more }`
- 表示执行一条或多条 shell 命令请求的工具。
+ 表示请求执行一个或多个 shell 命令的工具。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令和限制。
+ 描述如何运行该工具调用的 shell 命令及限制。
- `commands: array of string`
@@ -9378,25 +9376,25 @@
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的最大挂钟时间(毫秒)。
+ 允许 shell 命令运行的最长墙钟时间(毫秒)。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `type: "shell_call"`
- 该项的类型。始终为 `shell_call`.
+ 该 item 的类型。始终为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当通过 API 返回该条目时填充。
+ shell 工具调用的唯一 ID。在通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -9410,7 +9408,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -9420,7 +9418,7 @@
- `environment: optional LocalEnvironment or ContainerReference or null`
- 执行 shell 命令的环境。
+ 用于执行 shell 命令的环境。
- `LocalEnvironment object { type, skills }`
@@ -9428,7 +9426,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -9438,15 +9436,15 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- shell 工具调用发出的流式输出项。
+ shell 工具调用产生的流式输出条目。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 和 stderr 输出块及其关联结果。
+ 已捕获的 stdout 和 stderr 输出块及其关联的结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -9454,7 +9452,7 @@
- `Timeout object { type }`
- 表示 shell 调用超出了其配置的时间限制。
+ 表示该 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -9464,11 +9462,11 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已结束并返回了退出码。
- `exit_code: number`
- shell 进程返回的退出码。
+ 由 shell 进程返回的退出码。
- `type: "exit"`
@@ -9486,17 +9484,17 @@
- `type: "shell_call_output"`
- 该项的类型。始终为 `shell_call_output`.
+ 该 item 的类型。始终为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当通过 API 返回该条目时填充。
+ shell 工具调用输出的唯一 ID。在通过 API 返回此条目时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -9510,7 +9508,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -9534,11 +9532,11 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示使用 diff 补丁创建、删除或更新文件的工具调用。
+ 一个表示使用 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -9550,11 +9548,11 @@
- `diff: string`
- 创建文件时要应用的统一差异内容。
+ 创建文件时要应用的 unified diff 内容。
- `path: string`
- 相对于工作区根目录要创建的文件的路径。
+ 相对于工作区根目录的要创建的文件的路径。
- `type: "create_file"`
@@ -9568,7 +9566,7 @@
- `path: string`
- 相对于工作区根目录要删除的文件的路径。
+ 相对于工作区根目录的要删除的文件的路径。
- `type: "delete_file"`
@@ -9582,11 +9580,11 @@
- `diff: string`
- 要应用到现有文件的统一差异内容。
+ 要应用于现有文件的 unified diff 内容。
- `path: string`
- 相对于工作区根目录要更新的文件的路径。
+ 相对于工作区根目录的要更新的文件的路径。
- `type: "update_file"`
@@ -9596,7 +9594,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。取值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -9604,17 +9602,17 @@
- `type: "apply_patch_call"`
- 该项的类型。始终为 `apply_patch_call`.
+ 该 item 的类型。始终为 `apply_patch_call`.
- `"apply_patch_call"`
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当该条目通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当此条目通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -9628,7 +9626,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -9638,15 +9636,15 @@
- `ApplyPatchCallOutput object { call_id, status, type, 3 more }`
- apply patch 工具调用产生的流式输出。
+ apply patch 工具调用发出的流式输出。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。取值为 `completed` 或 `failed`.
- `"completed"`
@@ -9654,17 +9652,17 @@
- `type: "apply_patch_call_output"`
- 该项的类型。始终为 `apply_patch_call_output`.
+ 该 item 的类型。始终为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当该条目通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -9678,7 +9676,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -9688,7 +9686,7 @@
- `output: optional string or null`
- apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
+ 来自 apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
@@ -9716,15 +9714,15 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注释。
+ 有关该工具的其他注释。
- `description: optional string or null`
- 该工具的描述。
+ 工具的描述。
- `type: "mcp_list_tools"`
- 该项的类型。始终为 `mcp_list_tools`.
+ 该 item 的类型。始终为 `mcp_list_tools`.
- `"mcp_list_tools"`
@@ -9734,7 +9732,7 @@
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工审批某个工具调用。
- `id: string`
@@ -9742,7 +9740,7 @@
- `arguments: string`
- 用于该工具的参数的 JSON 字符串。
+ 工具参数的 JSON 字符串。
- `name: string`
@@ -9750,11 +9748,11 @@
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 该项的类型。始终为 `mcp_approval_request`.
+ 该 item 的类型。始终为 `mcp_approval_request`.
- `"mcp_approval_request"`
@@ -9764,15 +9762,15 @@
- `approval_request_id: string`
- 正在响应的审批请求的 ID。
+ 正在应答的审批请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已被批准。
- `type: "mcp_approval_response"`
- 该项的类型。始终为 `mcp_approval_response`.
+ 该 item 的类型。始终为 `mcp_approval_response`.
- `"mcp_approval_response"`
@@ -9786,7 +9784,7 @@
- `McpCall object { id, arguments, name, 6 more }`
- 对 MCP 服务器上某个工具的调用。
+ 在 MCP 服务器上对工具的一次调用。
- `id: string`
@@ -9806,14 +9804,14 @@
- `type: "mcp_call"`
- 该项的类型。始终为 `mcp_call`.
+ 该 item 的类型。始终为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 用于批准或拒绝相应工具调用的输入。
+ 在后续请求中包含此值 `mcp_approval_response` 用于批准或拒绝相应工具调用的输入。
- `error: optional McpToolCallError or null`
@@ -9867,11 +9865,11 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 由你的代码生成的自定义工具调用的输出,将被发送回模型。
+ 来自你代码的自定义工具调用输出,正在发回给模型。
- `call_id: string`
- 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
+ 调用 ID,用于将此自定义工具调用输出映射到自定义工具调用。
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
@@ -9884,19 +9882,19 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `type: "custom_tool_call_output"`
@@ -9906,11 +9904,11 @@
- `id: optional string`
- 自定义工具调用输出在 OpenAI 平台上的唯一 ID。
+ 在 OpenAI 平台中自定义工具调用输出的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -9924,7 +9922,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -9942,11 +9940,11 @@
- `input: string`
- 由模型生成的自定义工具调用的输入。
+ 模型生成的自定义工具调用的输入。
- `name: string`
- 被调用的自定义工具的名称。
+ 正在调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -9956,11 +9954,11 @@
- `id: optional string`
- 自定义工具调用在 OpenAI 平台上的唯一 ID。
+ 在 OpenAI 平台中自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -9972,7 +9970,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -9980,15 +9978,15 @@
- `namespace: optional string`
- 被调用的自定义工具的命名空间。
+ 正在调用的自定义工具的命名空间。
- `CompactionTrigger object { type, id }`
- 压缩当前上下文。必须是最后的输入项。
+ 压缩当前上下文。必须是最终的输入项。
- `type: "compaction_trigger"`
- 该项的类型。始终为 `compaction_trigger`.
+ 该 item 的类型。始终为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -10014,19 +10012,19 @@
- `id: string`
- 该程序条目的唯一 ID。
+ 此程序条目的唯一 ID。
- `call_id: string`
- 该程序条目的稳定调用 ID。
+ 程序条目的稳定调用 ID。
- `code: string`
- 由编程式工具调用执行的 JavaScript 源代码。
+ 通过程序化工具调用执行的 JavaScript 源码。
- `fingerprint: string`
- 必须来回透传的不透明程序回放指纹。
+ 必须往返传输的不透明程序回放指纹。
- `type: "program"`
@@ -10042,11 +10040,11 @@
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
@@ -10064,19 +10062,19 @@
- `metadata: Metadata or null`
- 可附加到对象的 16 个键值对集合。这可以
- 以结构化格式存储关于对象的附加信息,
- 格式,以及通过 API 或仪表板查询对象。
+ 可以附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储有关对象的附加信息,并通过
+ format,以及通过 API 或控制台查询对象。
- 键为字符串,最大长度为 64 个字符。值为字符串
+ 键为字符串,最大长度为 64 个字符。值为字符串,
最大长度为 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI
+ 用于生成响应的模型 ID,如 `gpt-5.6-sol`。OpenAI
提供多种不同能力、性能
特征和价格的模型。请参阅 [模型指南](/docs/models)
- 以浏览和比较可用模型。
+ 以浏览和比较可用的模型。
- `string`
@@ -10290,7 +10288,7 @@
- `object: "response"`
- 此资源的对象类型——始终设置为 `response`.
+ 此资源的对象类型,始终设置为 `response`.
- `"response"`
@@ -10298,20 +10296,20 @@
由模型生成的内容项数组。
- - 以下各项的长度和顺序 `output` 数组取决于
+ - 该数组中项的长度和顺序 `output` 数组取决于
模型的响应。
- - 与其访问数组中的第一项并 `output` 假设它是一个
- 包含由 `assistant` 模型生成的内容的
- 消息,不如考虑使用 `output_text` 属性(在
- SDK 支持时)。
+ - 与其直接访问 `output` 数组中的第一项并
+ 假设它是 `assistant` 包含模型生成内容的
+ 消息,你可以考虑使用该 `output_text` 属性,在支持该属性的
+ SDK 中可用。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 来自模型的输出消息。
+ 模型输出的消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。请参阅
+ 文件搜索 工具调用的结果。参见
[文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
- `id: string`
@@ -10320,11 +10318,11 @@
- `queries: array of string`
- 用于搜索文件的查询语句。
+ 用于搜索文件的查询。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。可选值为以下之一: `in_progress`,
+ 文件搜索 工具调用的状态。取值为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -10349,11 +10347,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的 16 个键值对集合。这可以
- 以结构化格式存储关于对象的附加信息,
- 并通过 API 或仪表板查询对象。键为字符串
- 最大长度为 64 个字符。值为最大长度
- 为 512 个字符的字符串、布尔值或数字。
+ 可以附加到对象的 16 个键值对集合。可用于
+ 以结构化格式存储有关对象的附加信息,并通过
+ API 或控制台查询对象。键为字符串
+ 最大长度为 64 个字符。值是最大
+ 长度为 512 个字符的字符串、布尔值或数字。
- `string`
@@ -10371,7 +10369,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,介于 0 和 1 之间。
- `text: optional string`
@@ -10406,7 +10404,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -10418,7 +10416,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -10431,7 +10429,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10456,24 +10454,24 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `status: "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10493,7 +10491,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -10507,7 +10505,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -10517,33 +10515,33 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `name: optional string`
- 产生该输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string`
- 产生该输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索工具调用的结果。请参阅
- [网页搜索指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索 工具调用的结果。请参阅
+ [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
- `id: string`
- 该 网页搜索 工具调用的唯一 ID。
+ 网页搜索 工具调用的唯一 ID。
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行具体操作的对象。
+ 描述本次 网页搜索 调用中所执行的具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- 操作类型 “search”——执行一次 网页搜索 查询。
+ 操作类型 "search" - 执行 网页搜索 查询。
- `type: "search"`
@@ -10553,11 +10551,11 @@
- `queries: optional array of string`
- 搜索查询语句。
+ 搜索查询。
- `query: optional string`
- 搜索查询语句。
+ 搜索查询。
- `sources: optional array of object { type, url }`
@@ -10565,7 +10563,7 @@
- `type: "url"`
- 来源的类型。始终为 `url`.
+ 来源类型。始终为 `url`.
- `"url"`
@@ -10575,7 +10573,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 操作类型 "open_page" —— 从搜索结果中打开指定的 URL。
- `type: "open_page"`
@@ -10593,7 +10591,7 @@
- `pattern: string`
- 要在页面内搜索的模式或文本。
+ 要在页面中搜索的模式或文本。
- `type: "find_in_page"`
@@ -10603,7 +10601,7 @@
- `url: string`
- 搜索该模式的页面 URL。
+ 在其中搜索模式的页面 URL。
- `status: "in_progress" or "searching" or "completed" or "failed"`
@@ -10626,7 +10624,7 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
对计算机使用工具的工具调用。参见
- [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
+ [计算机使用指南](/docs/guides/tools-computer-use) 了解更多信息。
- `id: string`
@@ -10634,11 +10632,11 @@
- `call_id: string`
- 使用输出响应工具调用时所使用的标识符。
+ 在向工具调用提供输出时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
- 计算机调用中待处理的安全检查。
+ 计算机调用的待处理安全检查。
- `id: string`
@@ -10655,7 +10653,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10665,18 +10663,18 @@
- `type: "computer_call"`
- 计算机调用的类型。始终为 `computer_call`.
+ 计算机调用的类型,恒为 `computer_call`.
- `"computer_call"`
- `action: optional ComputerAction`
- 点击操作。
+ 点击动作。
- `actions: optional ComputerActionList`
- 为 `computer_use`。扁平化后的批量动作。每个动作包含一个
- `type` 判别字段以及动作专属字段。
+ 针对的扁平化批处理操作 `computer_use`。每个操作都包含一个
+ `type` 判别字段以及操作特有的字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
@@ -10686,7 +10684,7 @@
- `call_id: string`
- 产生该输出的计算机工具调用的 ID。
+ 生成该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
@@ -10694,8 +10692,8 @@
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。可选值为以下之一: `in_progress`, `completed`,或
- `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态。取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。通过 API 返回输入项时填充。
- `"completed"`
@@ -10713,8 +10711,8 @@
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 已被开发者确认的 API 所报告的安全检查。
- developer.
+ 由API报告的、已被
+ 开发者确认的安全检查。
- `id: string`
@@ -10730,14 +10728,14 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 推理模型在生成回复时所使用的思维链描述。请务必将这些条目包含在你的
- 中,以便在后续对话轮次中传递给 Responses API `input` 至 响应接口
- ,如果你正在手动管理
- [上下文](/docs/guides/conversation-state).
+ 对推理模型在生成回复时所使用的思维链的描述。如果你手动管理上下文,请务必在后续对话轮次中将这些条目包含在提交给 响应接口 的
+ 中。 `input` 请求里
+ 。
+ [管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -10777,20 +10775,20 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。该字段默认填充
- 用于由 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充
+ 由 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求返回的推理条目。
- 在流式传输时,使用已完成的推理项及其
+ 在流式传输时,请使用已完成的推理条目及其
`encrypted_content` 从 `response.output_item.done` 事件中
- 后续请求。该 `encrypted_content` 中
- `response.output_item.added` 可能不完整。这一点尤其
- 重要,在 `store` 被 `false` 截断,或者使用 Zero Data Retention 时。
+ 后续请求中获取。由于 `encrypted_content` 处于
+ `response.output_item.added` 中的数据可能不完整。尤其是在
+ important when `store` is `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -10806,19 +10804,19 @@
- `call_id: string`
- 该程序条目的稳定调用 ID。
+ 程序条目的稳定调用 ID。
- `code: string`
- 由编程式工具调用执行的 JavaScript 源代码。
+ 通过程序化工具调用执行的 JavaScript 源码。
- `fingerprint: string`
- 必须来回透传的不透明程序回放指纹。
+ 必须往返传输的不透明程序回放指纹。
- `type: "program"`
- 该项的类型。始终为 `program`.
+ 该 item 的类型。始终为 `program`.
- `"program"`
@@ -10830,15 +10828,15 @@
- `call_id: string`
- 该程序条目的调用 ID。
+ 程序条目的调用 ID。
- `result: string`
- 由该程序条目生成的结果。
+ 由程序条目生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出条目的终止状态。
+ 程序输出条目的终态。
- `"completed"`
@@ -10846,7 +10844,7 @@
- `type: "program_output"`
- 该项的类型。始终为 `program_output`.
+ 该 item 的类型。始终为 `program_output`.
- `"program_output"`
@@ -10866,7 +10864,7 @@
- `execution: "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -10884,13 +10882,13 @@
- `type: "tool_search_call"`
- 该项的类型。始终为 `tool_search_call`.
+ 该 item 的类型。始终为 `tool_search_call`.
- `"tool_search_call"`
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
@@ -10904,7 +10902,7 @@
- `execution: "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -10926,7 +10924,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -10938,7 +10936,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -10956,45 +10954,45 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -11002,15 +11000,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -11022,21 +11020,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -11062,18 +11060,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -11081,7 +11079,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -11089,14 +11087,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -11114,7 +11112,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -11122,7 +11120,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -11132,16 +11130,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -11155,21 +11153,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -11177,26 +11175,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -11216,32 +11214,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -11249,13 +11247,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -11263,9 +11261,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -11273,27 +11271,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -11301,7 +11299,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -11311,7 +11309,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -11378,9 +11376,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -11391,7 +11389,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -11408,7 +11406,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -11438,7 +11436,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -11461,7 +11459,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -11478,13 +11476,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -11532,7 +11530,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -11554,7 +11552,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -11562,11 +11560,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -11574,7 +11572,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -11598,23 +11596,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -11636,7 +11634,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -11644,7 +11642,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -11664,11 +11662,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -11676,15 +11674,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -11698,7 +11696,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -11722,7 +11720,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -11730,7 +11728,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -11752,23 +11750,23 @@
- `type: "tool_search_output"`
- 该项的类型。始终为 `tool_search_output`.
+ 该 item 的类型。始终为 `tool_search_output`.
- `"tool_search_output"`
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 额外工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供额外工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -11788,11 +11786,11 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目处可用的额外工具定义。
+ 在此条目处可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -11804,7 +11802,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -11822,45 +11820,45 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -11868,15 +11866,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -11888,21 +11886,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -11928,18 +11926,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -11947,7 +11945,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -11955,14 +11953,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -11980,7 +11978,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -11988,7 +11986,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -11998,16 +11996,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -12021,21 +12019,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -12043,26 +12041,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -12082,32 +12080,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -12115,13 +12113,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -12129,9 +12127,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -12139,27 +12137,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -12167,7 +12165,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -12177,7 +12175,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -12244,9 +12242,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -12257,7 +12255,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -12274,7 +12272,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -12304,7 +12302,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -12327,7 +12325,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -12344,13 +12342,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -12398,7 +12396,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -12420,7 +12418,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -12428,11 +12426,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -12440,7 +12438,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -12464,23 +12462,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -12502,7 +12500,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -12510,7 +12508,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -12530,11 +12528,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -12542,15 +12540,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -12564,7 +12562,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -12588,7 +12586,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -12596,7 +12594,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -12618,13 +12616,13 @@
- `type: "additional_tools"`
- 该项的类型。始终为 `additional_tools`.
+ 该 item 的类型。始终为 `additional_tools`.
- `"additional_tools"`
- `Compaction object { id, encrypted_content, type, created_by }`
- 由 API 生成的压缩项 [`v1/responses/compact` 接口](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩项 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
@@ -12636,13 +12634,13 @@
- `type: "compaction"`
- 该项的类型。始终为 `compaction`.
+ 该 item 的类型。始终为 `compaction`.
- `"compaction"`
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -12693,7 +12691,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用输出,可以为 null。
+ 若没有可用输出,可能为 null。
- `Logs object { logs, type }`
@@ -12725,7 +12723,7 @@
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`、以及 `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -12779,7 +12777,7 @@
- `working_directory: optional string or null`
- 运行命令所在的可选工作目录。
+ 运行命令时所在的可选工作目录。
- `call_id: string`
@@ -12831,29 +12829,29 @@
- `ShellCall object { id, action, call_id, 5 more }`
- 在托管环境中执行一个或多个 shell 命令的工具调用。
+ 在托管环境中执行一条或多条 shell 命令的工具调用。
- `id: string`
- shell 工具调用的唯一 ID。当通过 API 返回该条目时填充。
+ shell 工具调用的唯一 ID。在通过 API 返回此条目时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 描述如何运行该工具调用的 shell 命令和限制。
+ 描述如何运行该工具调用的 shell 命令及限制。
- `commands: array of string`
- `max_output_length: number or null`
- 可选参数,每个命令返回内容的最大字符数。
+ 可选的每个命令返回的最大字符数。
- `timeout_ms: number or null`
- 可选参数,命令的超时时间(毫秒)。
+ 命令的可选超时时间(毫秒)。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `environment: ResponseLocalEnvironment or ResponseContainerReference or null`
@@ -12883,7 +12881,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -12893,13 +12891,13 @@
- `type: "shell_call"`
- 该项的类型。始终为 `shell_call`.
+ 该 item 的类型。始终为 `shell_call`.
- `"shell_call"`
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -12911,7 +12909,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -12927,27 +12925,27 @@
- `id: string`
- shell 调用输出的唯一 ID。当此条目通过 API 返回时会填充该字段。
+ shell 调用输出的唯一 ID。当通过 API 返回此项时填充。
- `call_id: string`
- 模型生成的 shell 工具调用的唯一 ID。
+ 由模型生成的 shell 工具调用的唯一 ID。
- `max_output_length: number or null`
- shell 命令输出的最大长度。该值由模型生成,并应与原始输出一起传回。
+ shell 命令输出的最大长度。这由模型生成,应与原始输出一起传回。
- `output: array of object { outcome, stderr, stdout, created_by }`
- shell 调用输出内容的数组
+ shell 调用输出内容数组
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块的结果,可以是退出结果(带有退出码)或超时结果。
+ 表示 shell 调用输出块的退出结果(带有退出码)或超时结果。
- `Timeout object { type }`
- 表示 shell 调用超出了其配置的时间限制。
+ 表示该 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -12957,7 +12955,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已执行完毕并返回了退出码。
+ 表示 shell 命令已结束并返回了退出码。
- `exit_code: number`
@@ -12979,11 +12977,11 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用输出的状态。取值之一 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -12999,7 +12997,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -13011,7 +13009,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -13019,7 +13017,7 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -13027,11 +13025,11 @@
- `id: string`
- apply patch 工具调用的唯一 ID。当该条目通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }`
@@ -13039,7 +13037,7 @@
- `CreateFile object { diff, path, type }`
- 描述如何通过 apply_patch 工具创建文件的指令。
+ 通过 apply_patch 工具创建文件的指令说明。
- `diff: string`
@@ -13051,13 +13049,13 @@
- `type: "create_file"`
- 使用提供的差异创建新文件。
+ 使用提供的差异创建一个新文件。
- `"create_file"`
- `DeleteFile object { path, type }`
- 描述如何通过 apply_patch 工具删除文件的指令。
+ 通过 apply_patch 工具删除文件的指令说明。
- `path: string`
@@ -13071,7 +13069,7 @@
- `UpdateFile object { diff, path, type }`
- 描述如何通过 apply_patch 工具更新文件的指令。
+ 通过 apply_patch 工具更新文件的指令说明。
- `diff: string`
@@ -13089,7 +13087,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。取值之一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。取值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -13097,13 +13095,13 @@
- `type: "apply_patch_call"`
- 该项的类型。始终为 `apply_patch_call`.
+ 该 item 的类型。始终为 `apply_patch_call`.
- `"apply_patch_call"`
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -13115,7 +13113,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -13131,15 +13129,15 @@
- `id: string`
- apply patch 工具调用输出的唯一 ID。当该条目通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: string`
- 模型生成的 apply patch 工具调用的唯一 ID。
+ 由模型生成的 apply patch 工具调用的唯一 ID。
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。取值之一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。取值为 `completed` 或 `failed`.
- `"completed"`
@@ -13147,13 +13145,13 @@
- `type: "apply_patch_call_output"`
- 该项的类型。始终为 `apply_patch_call_output`.
+ 该 item 的类型。始终为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -13165,7 +13163,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -13173,7 +13171,7 @@
- `created_by: optional string`
- 创建此工具调用输出的实体的 ID。
+ 创建此工具调输出的实体的 ID。
- `output: optional string or null`
@@ -13181,7 +13179,7 @@
- `McpCall object { id, arguments, name, 6 more }`
- 对 MCP 服务器上某个工具的调用。
+ 在 MCP 服务器上对工具的一次调用。
- `id: string`
@@ -13201,14 +13199,14 @@
- `type: "mcp_call"`
- 该项的类型。始终为 `mcp_call`.
+ 该 item 的类型。始终为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 用于批准或拒绝相应工具调用的输入。
+ 在后续请求中包含此值 `mcp_approval_response` 用于批准或拒绝相应工具调用的输入。
- `error: optional McpToolCallError or null`
@@ -13258,15 +13256,15 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注释。
+ 有关该工具的其他注释。
- `description: optional string or null`
- 该工具的描述。
+ 工具的描述。
- `type: "mcp_list_tools"`
- 该项的类型。始终为 `mcp_list_tools`.
+ 该 item 的类型。始终为 `mcp_list_tools`.
- `"mcp_list_tools"`
@@ -13276,7 +13274,7 @@
- `McpApprovalRequest object { id, arguments, name, 2 more }`
- 对工具调用的人工审批请求。
+ 请求人工审批某个工具调用。
- `id: string`
@@ -13284,7 +13282,7 @@
- `arguments: string`
- 用于该工具的参数的 JSON 字符串。
+ 工具参数的 JSON 字符串。
- `name: string`
@@ -13292,11 +13290,11 @@
- `server_label: string`
- 发起该请求的 MCP 服务器的标签。
+ 发起请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
- 该项的类型。始终为 `mcp_approval_request`.
+ 该 item 的类型。始终为 `mcp_approval_request`.
- `"mcp_approval_request"`
@@ -13310,15 +13308,15 @@
- `approval_request_id: string`
- 正在响应的审批请求的 ID。
+ 正在应答的审批请求的 ID。
- `approve: boolean`
- 该请求是否已批准。
+ 请求是否已被批准。
- `type: "mcp_approval_response"`
- 该项的类型。始终为 `mcp_approval_response`.
+ 该 item 的类型。始终为 `mcp_approval_response`.
- `"mcp_approval_response"`
@@ -13336,11 +13334,11 @@
- `input: string`
- 由模型生成的自定义工具调用的输入。
+ 模型生成的自定义工具调用的输入。
- `name: string`
- 被调用的自定义工具的名称。
+ 正在调用的自定义工具的名称。
- `type: "custom_tool_call"`
@@ -13350,11 +13348,11 @@
- `id: optional string`
- 自定义工具调用在 OpenAI 平台上的唯一 ID。
+ 在 OpenAI 平台中自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -13366,7 +13364,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -13374,7 +13372,7 @@
- `namespace: optional string`
- 被调用的自定义工具的命名空间。
+ 正在调用的自定义工具的命名空间。
- `CustomToolCallOutput object { id, call_id, output, 4 more }`
@@ -13384,7 +13382,7 @@
- `call_id: string`
- 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
+ 调用 ID,用于将此自定义工具调用输出映射到自定义工具调用。
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
@@ -13397,24 +13395,24 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `status: "in_progress" or "completed" or "incomplete"`
条目的状态。取值为 `in_progress`, `completed`,或
- `incomplete`。当通过 API 返回项时会填充。
+ `incomplete`。之一。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -13430,7 +13428,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -13444,7 +13442,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -13454,7 +13452,7 @@
- `created_by: optional string`
- 创建该条目的行为者的标识符。
+ 创建该条目的参与者的标识符。
- `parallel_tool_calls: boolean`
@@ -13462,20 +13460,20 @@
- `temperature: number or null`
- 使用的采样温度,介于 0 到 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加聚焦和确定性。
- 我们通常建议修改此设置或 `top_p` 但不要同时修改两者。
+ 使用的采样温度,介于 0 和 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定性更强。
+ 我们通常建议修改此参数或 `top_p` 但不能同时使用两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 模型在生成响应时应如何选择要使用的工具(一个或多个)。请参阅
- 参数,了解如何指定模型可以调用的工具。 `tools` 参数以了解如何指定哪些工具
- 模型可以调用。
+ 指定模型在生成响应时应如何选择使用哪个(或哪些)工具。
+ 有关如何指定可调用工具的信息,请参阅 `tools` 参数。
+ 模型可以调用的工具。
- `ToolChoiceOptions = "none" or "auto" or "required"`
- 控制模型调用哪个工具(如果有的话)。
+ 控制由模型调用哪个工具(如果有)。
- `none` 表示模型将不调用任何工具,而是生成一条消息。
+ `none` 表示模型不会调用任何工具,而是生成一条消息。
`auto` 表示模型可以在生成消息与调用一个或
多个工具之间进行选择。
@@ -13490,16 +13488,16 @@
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为预定义的集合。
+ 将模型可使用的工具限制为一组预定义工具。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为预定义的集合。
+ 将模型可使用的工具限制为一组预定义工具。
- `auto` 允许模型从允许的工具中进行选择,并生成一条
+ `auto` 允许模型从允许的工具中进行选择并生成一条
消息。
- `required` 要求模型调用一个或多个允许的工具。
+ `required` 要求模型调用允许的工具中的一个或多个。
- `"auto"`
@@ -13507,7 +13505,7 @@
- `tools: array of map[unknown]`
- 模型应被允许调用的工具定义列表。
+ 模型可以调用的工具定义列表。
对于 Responses API,工具定义列表可能如下所示:
@@ -13527,15 +13525,15 @@
- `ToolChoiceTypes object { type }`
- 指示模型应使用内置工具生成响应。
- [了解有关内置工具的更多信息](/docs/guides/tools).
+ 指示模型应使用内置工具来生成响应。
+ [详细了解内置工具](/docs/guides/tools).
- `type: "file_search" or "web_search_preview" or "computer" or 5 more`
- 模型应使用的托管工具类型。了解有关
+ 模型应使用的托管工具类型。详细了解
[内置工具](/docs/guides/tools).
- 允许的值为:
+ 允许的取值为:
- `file_search`
- `web_search_preview`
@@ -13563,7 +13561,7 @@
- `ToolChoiceFunction object { name, type }`
- 使用此选项可强制模型调用特定函数。
+ 使用此选项可强制模型调用特定的函数。
- `name: string`
@@ -13577,7 +13575,7 @@
- `ToolChoiceMcp object { server_label, type, name }`
- 使用此选项可强制模型调用远程 MCP 服务器上的特定工具。
+ 使用此选项可以强制模型调用远程 MCP 服务器上的特定工具。
- `server_label: string`
@@ -13595,7 +13593,7 @@
- `ToolChoiceCustom object { name, type }`
- 使用此选项可强制模型调用特定的自定义工具。
+ 使用此选项可以强制模型调用特定的自定义工具。
- `name: string`
@@ -13611,53 +13609,53 @@
- `type: "programmatic_tool_calling"`
- 要调用的工具。始终 `programmatic_tool_calling`.
+ 要调用的工具。始终为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
- `ToolChoiceApplyPatch object { type }`
- 在执行工具调用时强制模型调用 apply_patch 工具。
+ 强制模型在执行工具调用时调用 apply_patch 工具。
- `type: "apply_patch"`
- 要调用的工具。始终 `apply_patch`.
+ 要调用的工具。始终为 `apply_patch`.
- `"apply_patch"`
- `ToolChoiceShell object { type }`
- 在需要工具调用时强制模型调用 shell 工具。
+ 在需要工具调用时,强制模型调用 shell 工具。
- `type: "shell"`
- 要调用的工具。始终 `shell`.
+ 要调用的工具。始终为 `shell`.
- `"shell"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 模型在生成响应时可以调用的工具数组。你
- 可以通过设置 `tool_choice` 参数来指定要使用的工具。
+ 模型在生成响应时可以调用的工具数组。你可以
+ 通过设置 `tool_choice` 参数来指定要使用的工具。
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供、可扩展模型能力的工具,例如
- 模型的各项能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 或 [文件搜索](/docs/guides/tools-file-search)。了解更多信息
+ - **内置工具**: 由 OpenAI 提供的可扩展模型能力的工具,例如
+ 模型的能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
[内置工具](/docs/guides/tools).
- - **MCP 工具**:通过自定义 MCP 服务器与第三方系统集成
- ,或使用 Google Drive 和 SharePoint 等预定义连接器。了解更多信息
- [MCP 工具](/docs/guides/tools-connectors-mcp).
- - **函数调用(自定义工具)**:由你定义的函数,
- 使模型能够使用强类型参数和输出调用你自己的代码。了解更多信息
- 和输出。了解更多信息
+ - **MCP Tools**: 通过自定义 MCP 服务器或预定义连接器(如 Google Drive 和 SharePoint)与第三方系统集成。了解更多关于
+ 或 Google Drive 和 SharePoint 等预定义连接器与第三方系统集成。了解更多关于
+ [MCP Tools](/docs/guides/tools-connectors-mcp).
+ - **函数调用(自定义工具)**: 由你定义的函数,
+ 使模型能够使用强类型参数和输出调用你自己的代码
+ 和输出。了解更多关于
[函数调用](/docs/guides/function-calling)。你也可以使用
- 自定义工具调用你自己的代码。
+ 自定义工具来调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可由模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个模型可以选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -13669,7 +13667,7 @@
- `strict: boolean or null`
- 是否对此函数工具强制执行严格的参数校验。
+ 是否对该函数工具强制执行严格参数验证。
- `type: "function"`
@@ -13687,45 +13685,45 @@
- `defer_loading: optional boolean`
- 该函数是否延迟加载并通过工具搜索加载。
+ 此函数是否被延迟加载并通过工具搜索加载。
- `description: optional string or null`
- 对函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 用于描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 用于描述此函数字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容文件搜索工具的工具。详细了解 [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容文件搜索 tool [文件搜索 tool](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型,始终为 `file_search`.
+ 文件搜索 tool 的类型。始终为 `file_search`.
- `"file_search"`
- `vector_store_ids: array of string`
- 要搜索的向量存储库的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
- 要应用的筛选器。
+ 要应用的过滤器。
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值通过定义的比较运算进行比较的筛选器。
+ 用于将指定属性键与给定值按照定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选器 `and` 或 `or`.
+ 使用以下方式合并多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 返回的最大结果数。该数字应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -13733,15 +13731,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 用于控制在启用混合搜索时,倒数排名融合如何平衡语义嵌入匹配与稀疏关键词匹配的权重。
+ 在启用混合搜索时,用于控制互逆排序融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ 在互逆排序融合中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ 在互逆排序融合中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -13753,21 +13751,21 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值会试图仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数字会尝试仅返回最相关的结果,但可能返回的结果更少。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
- computer 工具的类型。始终为 `computer`.
+ 计算机工具的类型。始终为 `computer`.
- `"computer"`
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。了解更多关于 [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。详细了解 [计算机工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -13793,18 +13791,18 @@
- `type: "computer_use_preview"`
- computer use 工具的类型。始终为 `computer_use_preview`.
+ 计算机使用工具的类型。始终为 `computer_use_preview`.
- `"computer_use_preview"`
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。了解更多关于
+ 在互联网上搜索与提示相关的来源。详细了解
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -13812,7 +13810,7 @@
- `external_web_access: optional boolean`
- 允许网页搜索访问实时互联网。省略时默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。若省略,默认值为 true。当为 false 时,网页搜索 工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
@@ -13820,14 +13818,14 @@
- `allowed_domains: optional array of string or null`
- 允许搜索的域名。如果未提供,则允许所有域名。
- 所提供的域名的子域名也同样允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -13845,7 +13843,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -13853,7 +13851,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -13863,16 +13861,16 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程模型上下文协议
- (MCP)服务器为模型提供访问其他工具的能力。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ 允许模型通过远程模型上下文协议
+ (MCP)服务器访问其他工具。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 此 MCP 服务器的标签,用于在工具调用中标识它。
- `type: "mcp"`
- MCP 工具的类型。始终为 `mcp`.
+ MCP 工具的类型,始终为 `mcp`.
- `"mcp"`
@@ -13886,21 +13884,21 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许使用的工具名称列表或过滤对象。
+ 允许使用的工具名称列表或筛选对象。
- `McpAllowedTools = array of string`
- 允许使用的工具名称组成的字符串数组
+ 允许使用的工具名称字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -13908,26 +13906,26 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可以配合
- 自定义 MCP 服务器 URL 或服务连接器一起使用。你的应用
- 必须处理 OAuth 授权流程,并在此处提供该令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可以与自定义 MCP 服务器
+ URL 或服务连接器一起使用。你的应用程序必须处理 OAuth 授权流
+ 并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的那些。必须提供其中之一
- `server_url`, `connector_id`,或 `tunnel_id` 。详细了解
- 关于服务连接器的 [信息](/docs/guides/tools-remote-mcp#connectors).
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须提供以下之一。详细
+ `server_url`, `connector_id`,或 `tunnel_id` 了解关于服务连接器
+ about service connectors [here](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 取值包括:
+ Currently supported `connector_id` values are:
- Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
- - Google Drive: `connector_googledrive`
- - Microsoft Teams: `connector_microsoftteams`
- - Outlook Calendar: `connector_outlookcalendar`
- - Outlook Email: `connector_outlookemail`
- - SharePoint: `connector_sharepoint`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
+ - Google Drive: `connector_googledrive`
+ - Microsoft Teams: `connector_microsoftteams`
+ - Outlook Calendar: `connector_outlookcalendar`
+ - Outlook Email: `connector_outlookemail`
+ - SharePoint: `connector_sharepoint`
- `"connector_dropbox"`
@@ -13947,32 +13945,32 @@
- `defer_loading: optional boolean`
- 该 MCP 工具是否为延迟加载,并通过工具搜索发现。
+ Whether this MCP tool is deferred and discovered via tool search.
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
- 或其他用途。
+ Optional HTTP headers to send to the MCP server. Use for authentication
+ or other purposes.
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ Specify which of the MCP server's tools require approval.
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的过滤器对象
- 。
+ Specify which of the MCP server's tools require approval. Can be
+ `always`, `never`, or a filter object associated with tools
+ that require approval.
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -13980,13 +13978,13 @@
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的过滤对象。
+ 用于指定允许哪些工具的筛选对象。
- `read_only: optional boolean`
- 指示该工具是否会修改数据,或是否为只读。如果一个
+ 指示工具是修改数据还是只读。如果一个
MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它将匹配此过滤器。
+ 标记,它将匹配此筛选器。
- `tool_names: optional array of string`
@@ -13994,9 +13992,9 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。可选值为 `always` 或
- `never`。之一。当设置为 `always`,时,所有工具都需要审批。当
- 设置为 `never`,时,所有工具都不需要审批。
+ Specify a single approval policy for all tools. One of `always` 或
+ `never`. When set to `always`, all tools will require approval. When
+ set to `never`, all tools will not require approval.
- `"always"`
@@ -14004,27 +14002,27 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ Optional description of the MCP server, used to provide more context.
- `server_url: optional string`
- MCP 服务器的 URL。必须提供以下其中一项 `server_url`, `connector_id`,或
+ MCP 服务器的 URL。必须提供以下之一: `server_url`, `connector_id`,或
`tunnel_id` 必须提供其中之一。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下其中一项
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。必须提供以下之一:
`server_url`, `connector_id`,或 `tunnel_id` 必须提供其中之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 一个用于运行 Python 代码以帮助生成提示响应的工具。
+ 一个运行 Python 代码以帮助生成提示词回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID 或一个用于指定上传文件 ID(以供你的代码使用)以及一个
- 可选
- 设置的对象。 `memory_limit` 设置的对象。
+ 代码解释器容器。可以是容器 ID,也可以是一个用于指定可供你代码使用的已上传文件 ID 的对象,并提供
+ 指定可供代码使用的已上传文件 ID,以及一个可选的
+ 可选的 `memory_limit` 设置。
- `string`
@@ -14032,7 +14030,7 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要对其运行代码的文件 ID。
- `type: "auto"`
@@ -14042,7 +14040,7 @@
- `file_ids: optional array of string`
- 可选的上传文件列表,供你的代码使用。
+ 一个可选的已上传文件列表,供你的代码使用。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -14109,9 +14107,9 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`,或 `auto`。之一。透明背景可用于受支持的
- GPT 图像模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
+ `opaque`,或 `auto`。透明背景适用于受支持的 GPT
+ 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该支持处于预览阶段。使用
`transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -14122,7 +14120,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不受 `gpt-image-1-mini`。支持。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所付出的努力程度。此参数仅受 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -14139,7 +14137,7 @@
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
@@ -14169,7 +14167,7 @@
- `moderation: optional "auto" or "low"`
- 生成图像的内容审核等级。默认值: `auto`.
+ 生成图像的内容审核级别。默认值: `auto`.
- `"auto"`
@@ -14192,7 +14190,7 @@
- `partial_images: optional number`
- 在流式模式下生成的中间图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
@@ -14209,13 +14207,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式传入任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,并且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素与边长限制。GPT 图像模型支持的标准尺寸为 `1024x1024`, `1536x1024`、以及 `1024x1536` ; `auto` 支持用于允许自动尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持任意分辨率,以 `WIDTHxHEIGHT` 字符串形式表示,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最高支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边数限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 受到 GPT 图像模型的支持; `auto` 受到支持用于允许自动调整尺寸的模型。对于 `dall-e-2`,使用以下之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,使用以下之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -14263,7 +14261,7 @@
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -14285,7 +14283,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -14293,11 +14291,11 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `Namespace object { description, name, tools, type }`
- 将函数/自定义工具归入共享命名空间。
+ 在共享命名空间下对函数/自定义工具进行分组。
- `description: string`
@@ -14305,7 +14303,7 @@
- `name: string`
- 在工具调用中使用的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -14329,23 +14327,23 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 是否应延迟此函数并通过工具搜索发现它。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具中字符串输出所编码的 JSON 值的 JSON Schema。这不描述内容数组输出。
+ 描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。此字段不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,则当 schema 兼容时 Responses 会尝试使用严格校验,否则回退到非严格校验。
+ 是否启用严格的参数校验。如果省略,当 schema 兼容时 Responses 尝试使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
- 一个使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
+ 使用指定格式处理输入的自定义工具。详细了解 [自定义工具](/docs/guides/function-calling#custom-tools)
- `name: string`
@@ -14367,7 +14365,7 @@
- `defer_loading: optional boolean`
- 是否应延迟此工具并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索发现它。
- `description: optional string`
@@ -14375,7 +14373,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认是无约束文本。
+ 自定义工具的输入格式。默认为无约束文本。
- `type: "namespace"`
@@ -14395,11 +14393,11 @@
- `description: optional string or null`
- 在客户端执行的工具搜索工具中,向模型展示的描述。
+ 向模型展示的客户端执行工具搜索工具的描述。
- `execution: optional "server" or "client"`
- 工具搜索是由服务端执行还是由客户端执行。
+ 工具搜索是由服务端还是由客户端执行。
- `"server"`
@@ -14407,15 +14405,15 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会在网页中搜索相关结果以用于回复。详细了解 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会在网页上搜索相关结果以用于回复中。详细了解 Responses API [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -14429,7 +14427,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` 是默认值。
- `"low"`
@@ -14453,7 +14451,7 @@
- `country: optional string or null`
- 两字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所在国家,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -14461,7 +14459,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所在国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
@@ -14483,12 +14481,12 @@
- `top_p: number or null`
- 一种温度采样的替代方法,称为核采样(nucleus sampling),
- 模型会考虑概率质量排名前 top_p 的词元的结果。
- 因此 0.1 表示仅考虑概率质量排名前 10% 的词元
+ 一种称为 nucleus 采样的温度采样替代方案,
+ 模型在此考虑 top_p 概率对应的 token 结果
+ 的位置。因此 0.1 表示仅考虑构成前 10% 概率质量的 token
。
- 我们通常建议修改此设置或 `temperature` 但不要同时修改两者。
+ 我们通常建议修改此参数或 `temperature` 但不能同时使用两者。
- `background: optional boolean or null`
@@ -14497,44 +14495,44 @@
- `completed_at: optional number or null`
- 该 Response 完成时的 Unix 时间戳(以秒为单位)。
- 仅在状态为 `completed`.
+ 此 Response 完成时的 Unix 时间戳(以秒为单位)。
+ 仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此 response 所属的对话。该 response 中的输入项和输出项已自动添加到此对话中。
+ 此 Response 所属的会话。此 Response 中的输入项和输出项已自动添加到此会话中。
- `id: string`
- 与此 response 相关联的对话的唯一 ID。
+ 与此 Response 关联的会话的唯一 ID。
- `max_output_tokens: optional number or null`
- 响应可生成 token 数量的上限,包括可见输出 token 以及 [推理 token](/docs/guides/reasoning).
+ 响应可生成 token 数量的上限,包括可见输出 token 和 [推理 token](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 在一次响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非按单个工具计算。模型后续任何进一步的工具调用尝试都将被忽略。
+ 单个响应中可处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型任何进一步的工具调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 针对该 response 输入和输出的审核结果(如果请求了带审核的 completions)。
+ Response 输入和输出的审核结果(如果请求了受审核的补全)。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 针对该 response 输入的审核。
+ Response 输入的审核结果。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
- 为响应输入或输出生成的审核结果。
+ 为响应输入或输出生成的内容审核结果。
- `categories: map[boolean]`
- 从审核类别到布尔值的字典,如果输入在该类别下被标记则为 True。
+ 从内容审核类别到布尔值的字典;若输入在该类别下被标记,则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的评分反映了哪些输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -14542,25 +14540,25 @@
- `category_scores: map[number]`
- 从审核类别到评分的字典。
+ 从内容审核类别到分数的字典。
- `flagged: boolean`
- 指示内容是否被任何类别标记的布尔值。
+ 指示内容是否被任意类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成此结果的内容审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的 `moderation_result` 内容审核结果始终为。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在为响应输入或输出尝试审核时产生的错误。
+ 在尝试为响应输入或输出进行内容审核时产生的错误。
- `code: string`
@@ -14572,25 +14570,25 @@
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` ,用于审核失败的情况。
+ 对象类型,对于成功的 `error` 失败时的对象类型。
- `"error"`
- `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
- 对响应输出进行的审核。
+ 针对响应输出的内容审核。
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
- 为响应输入或输出生成的审核结果。
+ 为响应输入或输出生成的内容审核结果。
- `categories: map[boolean]`
- 从审核类别到布尔值的字典,如果输入在该类别下被标记则为 True。
+ 从内容审核类别到布尔值的字典;若输入在该类别下被标记,则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的评分反映了哪些输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -14598,25 +14596,25 @@
- `category_scores: map[number]`
- 从审核类别到评分的字典。
+ 从内容审核类别到分数的字典。
- `flagged: boolean`
- 指示内容是否被任何类别标记的布尔值。
+ 指示内容是否被任意类别标记的布尔值。
- `model: string`
- 生成此结果的审核模型。
+ 生成此结果的内容审核模型。
- `type: "moderation_result"`
- 对象类型,对于成功的审核结果始终为 `moderation_result` 。
+ 对象类型,对于成功的 `moderation_result` 内容审核结果始终为。
- `"moderation_result"`
- `Error object { code, message, type }`
- 在为响应输入或输出尝试审核时产生的错误。
+ 在尝试为响应输入或输出进行内容审核时产生的错误。
- `code: string`
@@ -14628,21 +14626,21 @@
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` ,用于审核失败的情况。
+ 对象类型,对于成功的 `error` 失败时的对象类型。
- `"error"`
- `output_text: optional string or null`
- 仅SDK提供的便捷属性,包含来自数组中所有项的聚合文本输出(如果存在)。
- 来自所有 `output_text` 项的 `output` ,如果存在的话。
- 在 Python 和 JavaScript SDK 中受支持。
+ 仅限 SDK 的便捷属性,包含汇总的文本输出,
+ 来自 `output_text` 数组中的所有 `output` 项(若存在)。
+ 支持 Python 和 JavaScript SDK。
- `previous_response_id: optional string or null`
- 模型上一次响应的唯一 ID。使用此 ID 可
+ 上一次模型响应的唯一 ID。用它来
创建多轮对话。详细了解
- [对话状态](/docs/guides/conversation-state)。无法与 `conversation`.
+ [对话状态](/docs/guides/conversation-state)。不能与 `conversation`.
- `prompt: optional ResponsePrompt or null`
@@ -14655,39 +14653,39 @@
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 可选的值映射,用于替换你的
- 提示词中的变量。替换值可以是字符串,也可以是其他
+ 可选的映射,用于在你的
+ 提示词中替换变量。替换值可以是字符串,也可以是其他
Response 输入类型,例如图片或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 模型的文件输入。
+ 发送给模型的文件输入。
- `version: optional string or null`
- 可选的提示词模板版本。
+ 提示词模板的可选版本。
- `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` 的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
- 是否启用了隐式 prompt 缓存断点。
+ 是否启用了隐式提示缓存断点。
- `"implicit"`
@@ -14701,18 +14699,18 @@
- `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).
- 该字段表示最长保留策略,而
- `prompt_cache_options.ttl` 表示最短缓存生命周期。这两个字段彼此独立且互不影响。
- 字段彼此独立且互不影响。
- 对于 `gpt-5.5`, `gpt-5.5-pro`,及未来模型,仅支持 `24h` 。
+ 提示缓存的保留策略。设置为 `24h` 以启用扩展提示缓存,使缓存的前缀保持更长时间的活跃状态,最长可达 24 小时。 [了解更多](/docs/guides/prompt-caching#prompt-cache-retention).
+ 此字段表示最大保留策略,而
+ `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 的组织默认为 `24h`.
+ - 已启用 ZDR 的组织默认为 `in_memory` 当 `prompt_cache_retention` 未指定时。
- `"in_memory"`
@@ -14720,20 +14718,18 @@
- `reasoning: optional Reasoning or null`
- **仅限 gpt-5 和 o 系列模型**
-
- 用于
+ 针对
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续轮次中向模型回传的推理项。
- 如果省略或设置为 `auto`,则由模型决定上下文模式。该
- `gpt-5.6` 模型系列默认为 `all_turns`;更早的模型默认为
+ 控制在后续轮次中哪些推理项会被重新渲染回模型。
+ 如果省略或设置为 `auto`,模型将自行决定上下文模式。
+ `gpt-5.6` 模型系列默认为 `all_turns`;较早的模型默认为
`current_turn`.
- 在响应中返回时,这是该响应实际使用的有效推理上下文模式。
- 用于该响应。
+ 在响应中返回时,这是该响应使用的有效推理上下文模式
+ 。
- `"auto"`
@@ -14743,11 +14739,11 @@
- `effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入程度。当前支持的值
- 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`、以及 `max`.
- 降低推理投入程度可以带来更快的响应,并在响应中消耗更少的
- 推理 tokens 并非所有推理模型都支持每个
- 值。请参阅
+ 约束推理模型的推理力度。当前支持
+ 的取值有 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理力度可以让响应更快,并减少响应中用于推理的令牌数量。
+ 并非所有推理模型都支持每个
+ 取值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
了解特定模型的支持情况。
@@ -14767,11 +14763,11 @@
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已弃用:** 使用 `summary` 替代。
+ **已弃用:** 使用 `summary` 代替。
- 对模型所执行推理的摘要。这可以
- 有助于调试和理解模型的推理过程。
- 以下之一 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这对于调试和理解模型的推理过程
+ 很有用。
+ 取值之一 `auto`, `concise`,或 `detailed`.
- `"auto"`
@@ -14781,17 +14777,17 @@
- `mode: optional string or "standard" or "pro"`
- 控制该请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,这是实际生效的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `string`
- `"standard" or "pro"`
- 控制该请求的推理执行模式。
+ 控制请求的推理执行模式。
- 在响应中返回时,这是实际生效的执行模式。
+ 在响应中返回时,这是有效的执行模式。
- `"standard"`
@@ -14799,11 +14795,11 @@
- `summary: optional "auto" or "concise" or "detailed" or null`
- 对模型所执行推理的摘要。这可以
- 有助于调试和理解模型的推理过程。
- 以下之一 `auto`, `concise`,或 `detailed`.
+ 模型执行的推理摘要。这对于调试和理解模型的推理过程
+ 很有用。
+ 取值之一 `auto`, `concise`,或 `detailed`.
- `concise` 可用于 `computer-use-preview` 模型以及之后发布的所有推理模型 `gpt-5`.
+ `concise` 支持以下模型和之后的 `computer-use-preview` 推理模型 `gpt-5`.
- `"auto"`
@@ -14813,21 +14809,21 @@
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理该请求的处理类型。
- - 如果设置为 'auto',则该请求将使用项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。
- - 如果设置为 'default',则该请求将使用所选模型的标准定价和性能进行处理。
+ - 如果设置为 'auto',则该请求将按照项目设置中配置的服务层级进行处理。除非另行配置,项目将使用 'default'。
+ - 如果设置为 'default',则该请求将按照所选模型的标准定价和性能进行处理。
- 如果设置为 '[flex](/docs/guides/flex-processing)',则该请求将使用 Flex Processing 服务层级进行处理。
- - 若要在请求级别启用 [快速模式](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
- - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。此层级当前可用于 `gpt-5.6-sol`;通过该层级提供的响应将显示 `service_tier=ultrafast`.
+ - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。
+ - 如果设置为 'ultrafast',则该请求将使用受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过该层级返回的响应将显示 `service_tier=ultrafast`.
- 未设置时,默认行为为 'auto'。
- 当 `service_tier` 参数被设置时,响应体将根据实际用于处理该请求的处理模式包含相应的 `service_tier` 值。此响应值可能与该参数中设置的值不同。
+ 当 `service_tier` 参数已设置,响应体将包含基于实际用于处理请求的 `service_tier` 处理模式所得到的值。该响应值可能与参数中设置的值不同。
- `"auto"`
@@ -14862,7 +14858,7 @@
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
+ 用于配置模型返回的文本响应格式。可以是纯文本或结构化的 JSON 数据。了解更多:
文本或结构化 JSON 数据。了解更多:
- [文本输入与输出](/docs/guides/text)
@@ -14870,19 +14866,19 @@
- `format: optional ResponseFormatTextConfig`
- 一个对象,用于指定模型必须输出的格式。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 会启用结构化输出,
- 从而确保模型与你提供的 JSON schema 匹配。详见
+ 配置 `{ "type": "json_schema" }` 可启用结构化输出,
+ 从而确保模型的输出与你提供的 JSON schema 完全匹配。更多信息请参阅
[结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` 且无其他选项。
+ 默认格式为 `{ "type": "text" }` ,不包含额外选项。
**不推荐用于 gpt-4o 及更新的模型:**
- 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
- 确保模型生成的消息是有效的 JSON。对于支持 `json_schema`
- 的模型,建议优先使用该模式。
+ 设置为 `{ "type": "json_object" }` 可启用旧的 JSON 模式,该模式
+ 会确保模型生成的消息是合法的 JSON。对于支持 `json_schema`
+ 的模型,推荐使用结构化输出。
- `ResponseFormatText object { type }`
@@ -14890,62 +14886,62 @@
- `type: "text"`
- 正在定义的响应格式的类型。始终为 `text`.
+ 正在定义的响应格式类型。始终为 `text`.
- `"text"`
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
- JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 了解更多信息 [结构化输出](/docs/guides/structured-outputs).
+ JSON Schema 响应格式。用于生成结构化的 JSON 响应。
+ 详细了解 [结构化输出](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON 架构对象描述。
- 了解如何构建 JSON 架构 [信息](https://json-schema.org/).
+ 响应格式所对应的 schema,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON schema [here](https://json-schema.org/).
- `type: "json_schema"`
- 正在定义的响应格式的类型。始终为 `json_schema`.
+ 正在定义的响应格式类型。始终为 `json_schema`.
- `"json_schema"`
- `description: optional string`
- 响应格式用途的描述,模型使用该描述
- 确定如何按该格式进行响应。
+ 对响应格式用途的描述,供模型用于
+ 确定如何在该格式中作出响应。
- `strict: optional boolean or null`
- 生成输出时是否启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循所定义的确切架构
- 中的 `schema` 字段。仅支持 JSON Schema 的一个子集,
- `strict` 被 `true`。要了解更多信息,请参阅 [结构化输出
+ 是否在生成输出时启用严格的 schema 遵从。
+ 若设为 true,模型将始终遵循在
+ 字段中定义的精确 schema。仅支持部分 JSON Schema, `schema` 当
+ `strict` is `true`。为 true 时。要了解更多信息,请参阅 [结构化输出
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 建议在支持的模型上使用 `json_schema` 。请注意,
- 模型在收到系统或用户消息明确指示前不会生成 JSON,
- 因此需要相应指令。
+ JSON 对象响应格式。一种较老的生成 JSON 响应的方法。
+ 建议使用 `json_schema` 以支持相关功能的模型。请注意,
+ 模型在没有系统或用户消息指示的情况下不会生成 JSON,
+ 指示它这样做。
- `type: "json_object"`
- 正在定义的响应格式的类型。始终为 `json_object`.
+ 正在定义的响应格式类型。始终为 `json_object`.
- `"json_object"`
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更高的值将生成更简洁的响应,而较低的值将生成更冗长的响应。
- 当前支持的值包括 `low`, `medium`、以及 `high`。默认值为
+ 限制模型响应的详细程度。较低的值会得到
+ 更简洁的响应,而较高的值会得到更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
- `"low"`
@@ -14956,9 +14952,9 @@
- `top_logprobs: optional number or null`
- 一个介于 0 和 20 之间的整数,指定在每个词元位置最多返回的词元数量,每个词元都有一个关联的对数
- 词元,每个词元都有一个关联的对数概率
- 概率。在某些情况下,返回的词元数量可能少于
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的
+ 最大可能性 token 数量,每个 token 都带有对应的对数
+ 概率。在某些情况下,返回的 token 数量可能少于
请求的数量。
- `truncation: optional "auto" or "disabled" or null`
@@ -14966,8 +14962,8 @@
用于模型响应的截断策略。
- `auto`:如果此 Response 的输入超过
- 模型的上下文窗口大小,模型将通过丢弃对话开头的条目来
- 截断响应以适配上下文窗口。
+ 模型的上下文窗口大小,模型将通过从对话开头丢弃内容来截断
+ 响应以适配上下文窗口。
- `disabled` (默认):如果输入大小将超过模型的上下文窗口
大小,请求将失败并返回 400 错误。
@@ -14977,7 +14973,7 @@
- `usage: optional ResponseUsage`
- 表示 token 使用详情,包括输入 token、输出 token、
+ 表示 token 使用明细,包括输入 token、输出 token、
输出 token 的细分,以及使用的 token 总数。
- `input_tokens: number`
@@ -14995,7 +14991,7 @@
- `cached_tokens: number`
从缓存中检索到的 token 数量。
- [详细了解 prompt 缓存](/docs/guides/prompt-caching).
+ [更多关于提示缓存的信息](/docs/guides/prompt-caching).
- `output_tokens: number`
@@ -15015,12 +15011,12 @@
- `compute_units: optional number or null`
- 请求的计算单元。当前可用时为 null。
+ 请求的计算单元。当可用时,当前为 null。
- `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).
### 示例
@@ -15030,7 +15026,7 @@ curl https://api.openai.com/v1/responses \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"prompt_cache_key": "prompt-cache-key-1234",
"safety_identifier": "safety-identifier-1234",
"temperature": 1,
@@ -15056,7 +15052,7 @@ curl https://api.openai.com/v1/responses \
"metadata": {
"foo": "string"
},
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"object": "response",
"output": [
{
@@ -15219,7 +15215,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": [
{
"role": "user",
@@ -15251,7 +15247,7 @@ curl https://api.openai.com/v1/responses \
"instructions": null,
"max_output_tokens": null,
"max_tool_calls": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"id": "msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86",
@@ -15311,7 +15307,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"tools": [{
"type": "file_search",
"vector_store_ids": ["vs_1234567890"],
@@ -15334,7 +15330,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "file_search_call",
@@ -15462,7 +15458,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": "What is the weather like in Boston today?",
"tools": [
{
@@ -15502,7 +15498,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "function_call",
@@ -15577,7 +15573,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": [
{
"role": "user",
@@ -15606,7 +15602,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -15663,7 +15659,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "o3-mini",
+ "model": "gpt-5.6-sol",
"input": "How much wood would a woodchuck chuck?",
"reasoning": {
"effort": "high"
@@ -15684,7 +15680,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "o1-2024-12-17",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -15741,7 +15737,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"instructions": "You are a helpful assistant.",
"input": "Hello!",
"stream": true
@@ -15752,10 +15748,10 @@ curl https://api.openai.com/v1/responses \
```json
event: response.created
-data: {"type":"response.created","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+data: {"type":"response.created","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.6-sol","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
event: response.in_progress
-data: {"type":"response.in_progress","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+data: {"type":"response.in_progress","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.6-sol","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
event: response.output_item.added
data: {"type":"response.output_item.added","output_index":0,"item":{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"in_progress","role":"assistant","content":[]}}
@@ -15778,7 +15774,7 @@ event: response.output_item.done
data: {"type":"response.output_item.done","output_index":0,"item":{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}}
event: response.completed
-data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}
+data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.6-sol","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}
```
### 文本输入
@@ -15788,7 +15784,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"input": "Tell me a three sentence bedtime story about a unicorn."
}'
```
@@ -15806,7 +15802,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
@@ -15863,7 +15859,7 @@ curl https://api.openai.com/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"tools": [{ "type": "web_search_preview" }],
"input": "What was a positive news story from today?"
}'
@@ -15882,7 +15878,7 @@ curl https://api.openai.com/v1/responses \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-5.4",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "web_search_call",
diff --git a/docs/zh/api/reference/resources/responses/methods/retrieve.md b/docs/zh/api/reference/resources/responses/methods/retrieve.md
index 3ef8f62..3174387 100644
--- a/docs/zh/api/reference/resources/responses/methods/retrieve.md
+++ b/docs/zh/api/reference/resources/responses/methods/retrieve.md
@@ -1,10 +1,10 @@
-> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
+> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾添加 `.md` 即可获取该页面的 Markdown 版本。
## 获取模型响应
-**get** `/responses/{response_id}`
+**获取** `/responses/{response_id}`
-通过给定 ID 获取模型响应。
+根据给定 ID 检索模型响应。
### 路径参数
@@ -14,8 +14,8 @@
- `include: optional array of ResponseIncludable`
- 响应中包含的其他字段。参见上方 `include`
- 参数中关于创建 Response 的说明以获取更多信息。
+ 响应中要包含的其他字段。详见上方 `include`
+ 参数中关于 Response 创建的说明。
- `"file_search_call.results"`
@@ -35,28 +35,28 @@
- `include_obfuscation: optional boolean`
- 如果为 true,将启用流混淆。流混淆会在
- 字段中添加随机字符,用于 `obfuscation` 流式增量事件上的
- 字段,规范化负载大小以缓解某些侧信道
- 攻击。这些混淆字段默认包含,但会给数据流带来少量开销。你可以将
- 设为 false 以优化带宽,前提是你信任
- `include_obfuscation` 你的应用与 OpenAI API 之间的网络链路。
- 设置该参数后的事件序号,作为开始流式传输的起点。
+ 若设为 true,将启用流混淆。流混淆会向流式 delta 事件上的
+ 字段添加随机字符 `obfuscation` 以规范化 payload 体积,
+ 缓解特定的侧信道攻击。默认包含这些混淆字段,但会给数据流带来少量开销。
+ 若你信任应用与 OpenAI API 之间的网络链路,
+ 可以将该参数设为 false 以优化带宽。
+ `include_obfuscation` 若你信任应用与
+ the network links between your application and the 该公司 接口.
- `starting_after: optional number`
- 开始流式传输的事件之后的序号。
+ 开始流式传输之前一个事件的序列号。
- `stream: optional false`
- 如果设置为 true,模型响应数据将以
- 的方式流式传输到客户端,使用 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
- 参见下方 [流式传输部分](/docs/api-reference/responses-streaming)
- 了解更多信息。
+ 若设为 true,模型响应数据将以流式方式通过
+ 实时发送给客户端 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+ 详见下文 [“Streaming”部分](/docs/api-reference/responses-streaming)
+ 。
- `false`
-### 返回值
+### Returns
- `Response object { id, created_at, error, 32 more }`
@@ -122,7 +122,7 @@
- `incomplete_details: object { reason } or null`
- 关于响应未完成原因的详细信息。
+ 有关响应未完成原因的详细信息。
- `reason: optional "max_output_tokens" or "content_filter"`
@@ -136,49 +136,49 @@
插入到模型上下文中的系统(或开发者)消息。
- 当与 `previous_response_id`,一起使用时,上一个
- response 中的指令不会延续到下一个 response。这样可以方便地
- 在新的 response 中替换系统(或开发者)消息。
+ 当与 `previous_response_id`,一起使用时,来自上一次响应的
+ 指令不会延续到下一次响应。这便于在
+ 新的响应中替换系统(或开发者)消息。
- `string`
- 模型的文本输入,等同于带有
+ 发送给模型的文本输入,等同于使用
`developer` 角色的文本输入。
- `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 提供给模型的一个或多个输入项的列表,其中包含
+ 发送给模型的一个或多个输入项的列表,包含
不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
- 发送给模型的消息输入,带有指示指令层级关系的角色。使用
- 或 `developer` 角色提供的指令优先级高于 `system` 角色所给的指令。
- 优先级高于通过 `user` 角色给出的指令。带有
- `assistant` 角色的消息被视为模型在之前
- 交互中生成的内容。
+ 发送给模型的消息输入,其角色指示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色提供的指令具有
+ 优先于使用 `user` 角色给出的指令。带有
+ `assistant` 角色的消息被假定为模型在之前的
+ 交互中生成。
- `content: string or ResponseInputMessageContentList`
- 提供给模型的文本、图像或音频输入,用于生成响应。
+ 发送给模型的文本、图像或音频输入,用于生成响应。
也可以包含之前的助手响应。
- `TextInput = string`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 提供给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一个或多个输入项的列表,包含不同的内容
类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -198,11 +198,11 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 提供给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解有关 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。默认为 `auto`.
+ 发送给模型的图像的详细程度。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `"low"`
@@ -224,7 +224,7 @@
- `image_url: optional string or null`
- 发送给模型的图像的 URL。可以是完整 URL,也可以是 data URL 中的 base64 编码图像。
+ 发送给模型的图片的 URL。可以是完整 URL,也可以是 data URL 形式的 base64 编码图片。
- `prompt_cache_breakpoint: optional object { mode }`
@@ -238,7 +238,7 @@
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 发送给模型的输入文件。
- `type: "input_file"`
@@ -248,7 +248,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 消耗。使用 `low` 可使用更低成本的渲染,或使用 `high` 可使用更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的消耗。使用 `low` 可以降低渲染成本,使用 `high` 可以以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -258,7 +258,7 @@
- `file_data: optional string`
- 发送给模型的文件的 content。
+ 发送给模型的文件内容。
- `file_id: optional string or null`
@@ -284,7 +284,7 @@
- `role: "user" or "assistant" or "system" or "developer"`
- 消息输入的角色,取值为以下之一 `user`, `assistant`, `system`、或
+ 消息输入的角色,取值为 `user`, `assistant`, `system`,或
`developer`.
- `"user"`
@@ -297,9 +297,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`)或最终回答(`final_answer`).
- 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请在所有助手消息上保留并重新发送
- 阶段——丢弃它可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间推理过程(`commentary`)或最终回答(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高的模型,在发送后续请求时,需保留并重新发送所有助手消息上的
+ 阶段,去掉它可能会导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -307,24 +307,24 @@
- `type: optional "message"`
- 消息输入的类型。始终为 `message`.
+ 消息输入的类型,始终为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
- 发送给模型的消息输入,带有指示指令层级关系的角色。使用
- 或 `developer` 角色提供的指令优先级高于 `system` 角色所给的指令。
- 优先级高于通过 `user` 角色的文本输入。
+ 发送给模型的消息输入,其角色指示指令的优先级
+ 层级。使用 `developer` 或 `system` 角色提供的指令具有
+ 优先于使用 `user` 角色的文本输入。
- `content: ResponseInputMessageContentList`
- 提供给模型的一个或多个输入项的列表,包含不同的内容
+ 发送给模型的一个或多个输入项的列表,包含不同的内容
类型。
- `role: "user" or "system" or "developer"`
- 消息输入的角色,取值为以下之一 `user`, `system`、或 `developer`.
+ 消息输入的角色,取值为 `user`, `system`,或 `developer`.
- `"user"`
@@ -334,8 +334,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- item 的状态,取值为以下之一 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 项目的状态,取值为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -351,7 +351,7 @@
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 来自模型的一条输出消息。
+ 来自模型的输出消息。
- `id: string`
@@ -363,7 +363,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 来自模型的一条文本输出。
+ 来自模型的文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -383,7 +383,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -393,15 +393,15 @@
- `URLCitation object { end_index, start_index, title, 2 more }`
- 用于生成模型响应的网页资源的引用。
+ 用于生成模型响应的网页资源引用。
- `end_index: number`
- 消息中 URL 引用最后一个字符的索引。
+ 消息中 URL 引用末尾字符的索引。
- `start_index: number`
- 消息中 URL 引用第一个字符的索引。
+ 消息中 URL 引用起始字符的索引。
- `title: string`
@@ -419,7 +419,7 @@
- `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`
- 用于生成模型响应的容器文件的引用。
+ 用于生成模型响应的容器文件引用。
- `container_id: string`
@@ -427,7 +427,7 @@
- `end_index: number`
- 消息中容器文件引用最后一个字符的索引。
+ 消息中容器文件引用末尾字符的索引。
- `file_id: string`
@@ -435,11 +435,11 @@
- `filename: string`
- 所引用的容器文件的文件名。
+ 引用的容器文件的文件名。
- `start_index: number`
- 消息中容器文件引用的起始字符索引。
+ 消息中容器文件引用起始字符的索引。
- `type: "container_file_citation"`
@@ -457,7 +457,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -493,7 +493,7 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型的拒绝回复。
+ 模型的拒绝。
- `refusal: string`
@@ -513,8 +513,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。可选值为 `in_progress`, `completed`、或
- `incomplete`。之一。当输入项通过API返回时填充。
+ 消息输入的状态。取值之一 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回输入项时填充。
- `"in_progress"`
@@ -530,9 +530,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间评论(`commentary`)或最终回答(`final_answer`).
- 对于像 `gpt-5.3-codex` 及更高版本的模型,在发送后续请求时,请在所有助手消息上保留并重新发送
- 阶段——丢弃它可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间推理过程(`commentary`)或最终回答(`final_answer`).
+ 对于像 `gpt-5.3-codex` 及更高的模型,在发送后续请求时,需保留并重新发送所有助手消息上的
+ 阶段,去掉它可能会导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -540,8 +540,8 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。参见
- [文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
+ 文件搜索 工具调用的结果。请参阅
+ [文件搜索 指南](/docs/guides/tools-file-search) 。
- `id: string`
@@ -553,8 +553,8 @@
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。可选值为 `in_progress`,
- `searching`, `incomplete` 角色提供的指令优先级高于 `failed`,
+ 文件搜索 工具调用的状态。取值之一 `in_progress`,
+ `searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -578,11 +578,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的一组 16 个键值对。这可以
- 用于以结构化格式存储有关对象的附加信息,
- 并通过 API 或仪表板查询对象。键为字符串,
- 最大长度为 64 个字符。值为字符串(最大
- 长度为 512 个字符)、布尔值或数字。
+ 可以附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储关于对象的附加信息,
+ 并通过API或仪表板查询对象。键是字符串,
+ 最大长度为 64 个字符。值是最大长度为 512 个字符的字符串、
+ 布尔值或数字。
- `string`
@@ -600,7 +600,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,介于 0 和 1 之间。
- `text: optional string`
@@ -608,8 +608,8 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。请参阅
- [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
+ 对计算机使用工具的工具调用。参见
+ [计算机使用指南](/docs/guides/tools-computer-use) 。
- `id: string`
@@ -617,7 +617,7 @@
- `call_id: string`
- 用于在响应工具调用时携带输出的标识符。
+ 在向工具调用提供输出响应时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -633,12 +633,12 @@
- `message: optional string or null`
- 待处理安全检查的详细信息。
+ 关于待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -654,15 +654,15 @@
- `action: optional ComputerAction`
- 单击操作。
+ 一次点击动作。
- `Click object { button, type, x, 2 more }`
- 单击操作。
+ 一次点击动作。
- `button: "left" or "right" or "wheel" or 2 more`
- 表示单击时按下了哪个鼠标按钮。取值为 `left`, `right`, `wheel`, `back`、或 `forward`.
+ 表示点击时按下的鼠标按键。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -676,33 +676,33 @@
- `type: "click"`
- 指定事件类型。对于单击操作,此属性始终为 `click`.
+ 指定事件类型。对于点击动作,该属性始终为 `click`.
- `"click"`
- `x: number`
- 单击发生位置的 x 坐标。
+ 点击发生位置的 x 坐标。
- `y: number`
- 单击发生位置的 y 坐标。
+ 点击发生位置的 y 坐标。
- `keys: optional array of string or null`
- 单击时按住的键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击操作。
+ 一次双击动作。
- `keys: array of string or null`
- 双击时按住的键。
+ 双击时按住的按键。
- `type: "double_click"`
- 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击动作,该属性始终设置为 `double_click`.
- `"double_click"`
@@ -716,11 +716,11 @@
- `Drag object { path, type, keys }`
- 拖动操作。
+ 一次拖动动作。
- `path: array of object { x, y }`
- 表示拖动操作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 一个坐标数组,表示拖动动作的路径。坐标将以对象数组的形式呈现,例如
```
[
@@ -739,45 +739,45 @@
- `type: "drag"`
- 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动动作,该属性始终设置为 `drag`.
- `"drag"`
- `keys: optional array of string or null`
- 拖动鼠标时按住的键。
+ 拖动鼠标时按住的按键。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的按键操作的集合。
- `keys: array of string`
- 模型请求按下的键组合。这是一个字符串数组,每个字符串表示一个键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
- `type: "keypress"`
- 指定事件类型。对于按键操作,此属性始终设置为 `keypress`.
+ 指定事件类型。对于按键动作,该属性始终设置为 `keypress`.
- `"keypress"`
- `Move object { type, x, y, keys }`
- 鼠标移动操作。
+ 鼠标移动动作。
- `type: "move"`
- 指定事件类型。对于移动操作,该属性始终设置为 `move`.
+ 指定事件类型。对于 move 动作,此属性始终设置为 `move`.
- `"move"`
- `x: number`
- 要移至的 x 坐标。
+ 要移动到的 x 坐标。
- `y: number`
- 要移至的 y 坐标。
+ 要移动到的 y 坐标。
- `keys: optional array of string or null`
@@ -785,17 +785,17 @@
- `Screenshot object { type }`
- 截图操作。
+ 截图动作。
- `type: "screenshot"`
- 指定事件类型。对于截图操作,该属性始终设置为 `screenshot`.
+ 指定事件类型。对于 screenshot 动作,此属性始终设置为 `screenshot`.
- `"screenshot"`
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
- 滚动操作。
+ 滚动动作。
- `scroll_x: number`
@@ -807,7 +807,7 @@
- `type: "scroll"`
- 指定事件类型。对于滚动操作,该属性始终设置为 `scroll`.
+ 指定事件类型。对于 scroll 动作,此属性始终设置为 `scroll`.
- `"scroll"`
@@ -825,7 +825,7 @@
- `Type object { text, type }`
- 用于输入文本的操作。
+ 输入文本的动作。
- `text: string`
@@ -833,64 +833,64 @@
- `type: "type"`
- 指定事件类型。对于 type 操作,该属性始终设置为 `type`.
+ 指定事件类型。对于 type 动作,此属性始终设置为 `type`.
- `"type"`
- `Wait object { type }`
- 等待操作。
+ 等待动作。
- `type: "wait"`
- 指定事件类型。对于等待操作,该属性始终设置为 `wait`.
+ 指定事件类型。对于 wait 动作,此属性始终设置为 `wait`.
- `"wait"`
- `actions: optional ComputerActionList`
- 针对的扁平化批量操作 `computer_use`. 每个 action 包含一个
- `type` discriminator 和 action 特有的字段。
+ 针对的扁平化批量动作 `computer_use`. 每个 action 包含一个
+ `type` 判别字段和 action 特定的字段。
- `Click object { button, type, x, 2 more }`
- 单击操作。
+ 一次点击动作。
- `DoubleClick object { keys, type, x, y }`
- 双击操作。
+ 一次双击动作。
- `Drag object { path, type, keys }`
- 拖动操作。
+ 一次拖动动作。
- `Keypress object { keys, type }`
- 模型希望执行的一组按键操作。
+ 模型希望执行的按键操作的集合。
- `Move object { type, x, y, keys }`
- 鼠标移动操作。
+ 鼠标移动动作。
- `Screenshot object { type }`
- 截图操作。
+ 截图动作。
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
- 滚动操作。
+ 滚动动作。
- `Type object { text, type }`
- 用于输入文本的操作。
+ 输入文本的动作。
- `Wait object { type }`
- 等待操作。
+ 等待动作。
- `ComputerCallOutput object { call_id, output, type, 3 more }`
- computer 工具调用的输出。
+ 一次 computer 工具调用的输出。
- `call_id: string`
@@ -898,12 +898,12 @@
- `output: ResponseComputerToolCallOutputScreenshot`
- 与 computer use 工具配合使用的 computer 截图图像。
+ 与 computer use 工具配合使用的电脑截图。
- `type: "computer_screenshot"`
- 指定事件类型。对于 computer 截图,该属性
- 始终设置为 `computer_screenshot`.
+ 指定事件类型。对于电脑截图,此属性始终
+ 设置为 `computer_screenshot`.
- `"computer_screenshot"`
@@ -913,11 +913,11 @@
- `image_url: optional string`
- 截图图像的 URL。
+ 截图的 URL。
- `type: "computer_call_output"`
- computer 工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终 `computer_call_output`.
- `"computer_call_output"`
@@ -927,7 +927,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 开发者已确认的 API 报告的安全检查。
+ 由开发者确认的 API 上报的安全检查项。
- `id: string`
@@ -939,11 +939,11 @@
- `message: optional string or null`
- 待处理安全检查的详细信息。
+ 关于待处理安全检查的详细信息。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。可选值为 `in_progress`, `completed`、或 `incomplete`。之一。当输入项通过API返回时填充。
+ 消息输入的状态。取值之一 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回输入项时填充。
- `"in_progress"`
@@ -953,8 +953,8 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。参见
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 一次 网页搜索 工具调用的结果。请参阅
+ [网页搜索 指南](/docs/guides/tools-web-search) 。
- `id: string`
@@ -962,12 +962,12 @@
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
- 包含模型如何使用网络的详细信息(search、open_page、find_in_page)。
+ 描述本次 网页搜索 调用中所执行具体操作的对象。
+ 包含模型使用网络的方式的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- Action 类型 "search" - 执行一次 网页搜索 查询。
+ Action 类型 "search" —— 执行一次 网页搜索 查询。
- `type: "search"`
@@ -977,11 +977,11 @@
- `queries: optional array of string`
- 搜索查询列表。
+ 搜索查询。
- `query: optional string`
- 搜索查询。
+ 搜索查询语句。
- `sources: optional array of object { type, url }`
@@ -999,7 +999,7 @@
- `OpenPage object { type, url }`
- 动作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 操作类型 "open_page" - 从搜索结果中打开指定的 URL。
- `type: "open_page"`
@@ -1013,7 +1013,7 @@
- `FindInPage object { pattern, type, url }`
- 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -1043,14 +1043,14 @@
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 运行函数的工具调用。请参阅
- [函数调用指南](/docs/guides/function-calling) 了解更多信息。
+ 用于运行函数的工具调用。请参阅
+ [function calling guide](/docs/guides/function-calling) 。
- `arguments: string`
@@ -1076,7 +1076,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -1088,7 +1088,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -1100,8 +1100,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -1115,7 +1115,7 @@
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -1123,15 +1123,15 @@
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `text: string`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `type: "input_text"`
@@ -1151,7 +1151,7 @@
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 提供给模型的图像输入。了解 [图像输入](/docs/guides/vision)
+ 发送给模型的图像输入。了解有关 [图像输入](/docs/guides/vision)
- `type: "input_image"`
@@ -1161,7 +1161,7 @@
- `detail: optional ImageDetail or null`
- 发送给模型的图像的细节级别。可选值为 `high`, `low`, `auto`、或 `original`。默认为 `auto`.
+ 发送给模型的图像的详细程度。可选值为 `high`, `low`, `auto`,或 `original`。默认为 `auto`.
- `file_id: optional string or null`
@@ -1169,7 +1169,7 @@
- `image_url: optional string or null`
- 发送给模型的图像的 URL。可以是完整 URL,也可以是 data URL 中的 base64 编码图像。
+ 发送给模型的图片的 URL。可以是完整 URL,也可以是 data URL 形式的 base64 编码图片。
- `prompt_cache_breakpoint: optional object { mode } or null`
@@ -1183,7 +1183,7 @@
- `ResponseInputFileContent object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 发送给模型的输入文件。
- `type: "input_file"`
@@ -1193,7 +1193,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 消耗。使用 `low` 可使用更低成本的渲染,或使用 `high` 可使用更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 可让系统自动选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,可能会增加输入 token 的消耗。使用 `low` 可以降低渲染成本,使用 `high` 可以以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -1243,7 +1243,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -1257,7 +1257,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -1267,15 +1267,15 @@
- `name: optional string or null`
- 生成该输出的工具的名称。
+ 产生该输出的工具的名称。
- `namespace: optional string or null`
- 生成该输出的工具的命名空间。
+ 产生该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 项目的状态。取值之一为 `in_progress`, `completed`、或 `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -1329,7 +1329,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -1337,11 +1337,11 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -1359,19 +1359,19 @@
- `defer_loading: optional boolean`
- 该函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -1381,7 +1381,7 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
@@ -1389,7 +1389,7 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于在指定的属性键与给定值之间使用定义的比较运算进行比较的过滤器。
- `key: string`
@@ -1426,7 +1426,7 @@
- `value: string or number or boolean or array of string or number`
- 用于与属性键比较的值,支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值;支持字符串、数字或布尔类型。
- `string`
@@ -1442,21 +1442,21 @@
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选条件 `and` 角色提供的指令优先级高于 `or`.
+ 使用以下方式组合多个过滤器 `and` 或 `or`.
- `filters: array of ComparisonFilter or unknown`
- 要组合的筛选条件数组。元素可以是 `ComparisonFilter` 角色提供的指令优先级高于 `CompoundFilter`.
+ 要组合的过滤器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于在指定的属性键与给定值之间使用定义的比较运算进行比较的过滤器。
- `unknown`
- `type: "and" or "or"`
- 操作类型: `and` 角色提供的指令优先级高于 `or`.
+ 操作类型: `and` 或 `or`.
- `"and"`
@@ -1464,7 +1464,7 @@
- `max_num_results: optional number`
- 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -1472,7 +1472,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -1492,7 +1492,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1,尝试仅返回最相关的结果,但可能会返回更少的结果。
- `Computer object { type }`
@@ -1500,7 +1500,7 @@
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终为 `computer`.
- `"computer"`
@@ -1539,11 +1539,11 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
在互联网上搜索与提示相关的来源。详细了解
- [网页搜索工具](/docs/guides/tools-web-search).
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值之一为 `web_search` 角色提供的指令优先级高于 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1551,22 +1551,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索 进行实时互联网访问。如果省略,默认值为 true。如果设为 false,网页搜索工具将运行在离线/仅缓存模式下,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当设置为 false 时,网页搜索 工具将以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 搜索的过滤条件。
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -1584,7 +1584,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -1592,7 +1592,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -1603,11 +1603,11 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ (MCP) 服务器为模型提供对其他工具的访问权限。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -1625,39 +1625,39 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许使用的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 包含允许的工具名称的字符串数组
+ 允许使用的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可与自定义 MCP
- 服务器 URL 或服务连接器一起使用。你的应用程序
- 必须处理 OAuth 授权流程并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义
+ MCP 服务器 URL 或服务连接器使用。你的应用程序
+ 必须处理 OAuth 授权流程,并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的连接器。以下之一
- `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。
+ `server_url`, `connector_id`,或 `tunnel_id` 中的一个必须提供。了解更多
关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持 `connector_id` 的取值包括:
+ 目前支持 `connector_id` 的值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -1700,42 +1700,42 @@
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选器对象
- 。
+ `always`, `never`,也可以是与工具关联的过滤器对象
+ 这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。取值为 `always` 角色提供的指令优先级高于
- `never`。之一。设置为 `always`,所有工具都将需要审批。设置为
- 时, `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值之一为 `always` 或
+ `never`。当设置为 `always`,所有工具都将需要审批。当
+ 设置为 `never`,所有工具都将不需要审批。
- `"always"`
@@ -1747,23 +1747,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。二者必须提供 `server_url`, `connector_id`、或
- `tunnel_id` 其一。
+ MCP 服务器的 URL。需要提供以下其中一项 `server_url`, `connector_id`,或
+ `tunnel_id` 。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。二者必须提供
- `server_url`, `connector_id`、或 `tunnel_id` 其一。
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。需要提供以下其中一项
+ `server_url`, `connector_id`,或 `tunnel_id` 。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示的响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是指定可供你的代码使用的已上传文件 ID 以及可选的
- 设置的对象。
- 可选的 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID 或指定可上传到你的代码中的文件 ID 以及
+ 指定可提供给代码的上传文件 ID,以及
+ 可选的 `memory_limit` 设置的对象。
- `string`
@@ -1771,17 +1771,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供你的代码使用的已上传文件的可选列表。
+ 提供给代码的可选上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1803,7 +1803,7 @@
- `type: "disabled"`
- 禁用出站网络访问。始终为 `disabled`.
+ 禁用出站网络访问。始终 `disabled`.
- `"disabled"`
@@ -1811,33 +1811,33 @@
- `allowed_domains: array of string`
- 当 type 为时允许访问的域名列表 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
+ 仅允许对指定域进行出站网络访问。固定为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 允许列表中域名的可选域作用域密钥。
+ 允许列表中域的可选域作用域密钥。
- `domain: string`
- 与该密钥关联的域名。
+ 与该密钥关联的域。
- `name: string`
- 要为该域名注入的密钥名称。
+ 为该域注入的密钥名称。
- `value: string`
- 要为该域名注入的密钥值。
+ 为该域注入的密钥值。
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终为 `code_interpreter`.
+ 代码解释器工具的类型。固定为 `code_interpreter`.
- `"code_interpreter"`
@@ -1853,7 +1853,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 工具的类型。固定为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -1863,7 +1863,7 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终为 `image_generation`.
+ 图像生成工具的类型。固定为 `image_generation`.
- `"image_generation"`
@@ -1880,10 +1880,10 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`、或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
- `transparent`,时,请将输出格式设置为 `png` 角色提供的指令优先级高于 `webp`。默认值: `auto`.
+ `opaque`,或 `auto`。之一。支持透明背景的
+ GPT 图像模型可用。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1893,7 +1893,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅对 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -1901,8 +1901,8 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (string, optional)和 `file_id` (string, optional)。
+ 可选的修复蒙版。包含 `image_url`
+ (string, optional) 和 `file_id` (string, optional)。
- `file_id: optional string`
@@ -1916,7 +1916,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -1925,7 +1925,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -1952,7 +1952,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`、或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -1963,12 +1963,12 @@
- `partial_images: optional number`
- 在流式模式下要生成的局部图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
生成图像的质量。可选值为 `low`, `medium`, `high`,
- 角色提供的指令优先级高于 `auto`。默认值: `auto`.
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -1980,13 +1980,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -2036,7 +2036,7 @@
- `file_ids: optional array of string`
- 可供你的代码使用的已上传文件的可选列表。
+ 提供给代码的可选上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2060,7 +2060,7 @@
- `skills: optional array of SkillReference or InlineSkill`
- 通过 id 引用或以内联数据形式提供的可选技能列表。
+ 通过 id 或内联数据引用的可选技能列表。
- `SkillReference object { skill_id, type, version }`
@@ -2090,7 +2090,7 @@
- `source: InlineSkillSource`
- 内联技能负载
+ 内联技能载荷
- `data: string`
@@ -2098,13 +2098,13 @@
- `media_type: "application/zip"`
- 内联技能负载的媒体类型。必须为 `application/zip`.
+ 内联技能载荷的媒体类型。必须为 `application/zip`.
- `"application/zip"`
- `type: "base64"`
- 内联技能源的类型。必须为 `base64`.
+ 内联技能来源的类型。必须为 `base64`.
- `"base64"`
@@ -2136,7 +2136,7 @@
- `path: string`
- 包含该技能的目录路径。
+ 包含技能的目录路径。
- `ContainerReference object { container_id, type }`
@@ -2174,7 +2174,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -2182,21 +2182,21 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Text object { type }`
- 无约束的自由格式文本。
+ 不受约束的自由格式文本。
- `type: "text"`
- 无约束文本格式。始终为 `text`.
+ 不受约束的文本格式。始终为 `text`.
- `"text"`
- `Grammar object { definition, syntax, type }`
- 由用户定义的语法。
+ 用户定义的语法。
- `definition: string`
@@ -2204,7 +2204,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法。取值之一为 `lark` 角色提供的指令优先级高于 `regex`.
+ 语法定义的语法格式。可选值为 `lark` 或 `regex`.
- `"lark"`
@@ -2230,7 +2230,7 @@
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 该命名空间内可用的函数/自定义工具。
+ 此命名空间内可用的 function/custom 工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -2250,19 +2250,19 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 该 function 是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
+ 描述该 function 工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否启用严格的参数校验。如果省略,响应接口 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。若未指定,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -2288,7 +2288,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -2296,21 +2296,21 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 工具的类型。固定为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 工具的类型。固定为 `tool_search`.
- `"tool_search"`
@@ -2320,7 +2320,7 @@
- `execution: optional "server" or "client"`
- 工具搜索由服务端执行还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -2328,15 +2328,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会搜索网页以获取与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会搜索网页以获取用于回复的相关结果。了解更多关于 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值之一为 `web_search_preview` 角色提供的指令优先级高于 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -2350,7 +2350,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -2360,7 +2360,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -2374,7 +2374,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2382,15 +2382,15 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一的差异格式创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 工具的类型。固定为 `apply_patch`.
- `"apply_patch"`
@@ -2444,11 +2444,11 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在此项中可用的额外工具列表。
+ 在此条目中提供的额外工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -2456,11 +2456,11 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -2478,19 +2478,19 @@
- `defer_loading: optional boolean`
- 该函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -2500,7 +2500,7 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
@@ -2508,15 +2508,15 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于在指定的属性键与给定值之间使用定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选条件 `and` 角色提供的指令优先级高于 `or`.
+ 使用以下方式组合多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -2524,7 +2524,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -2544,7 +2544,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1,尝试仅返回最相关的结果,但可能会返回更少的结果。
- `Computer object { type }`
@@ -2552,7 +2552,7 @@
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终为 `computer`.
- `"computer"`
@@ -2591,11 +2591,11 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
在互联网上搜索与提示相关的来源。详细了解
- [网页搜索工具](/docs/guides/tools-web-search).
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值之一为 `web_search` 角色提供的指令优先级高于 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -2603,22 +2603,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索 进行实时互联网访问。如果省略,默认值为 true。如果设为 false,网页搜索工具将运行在离线/仅缓存模式下,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当设置为 false 时,网页搜索 工具将以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 搜索的过滤条件。
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -2636,7 +2636,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -2644,7 +2644,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -2655,11 +2655,11 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ (MCP) 服务器为模型提供对其他工具的访问权限。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -2677,39 +2677,39 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许使用的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 包含允许的工具名称的字符串数组
+ 允许使用的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可与自定义 MCP
- 服务器 URL 或服务连接器一起使用。你的应用程序
- 必须处理 OAuth 授权流程并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义
+ MCP 服务器 URL 或服务连接器使用。你的应用程序
+ 必须处理 OAuth 授权流程,并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的连接器。以下之一
- `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。
+ `server_url`, `connector_id`,或 `tunnel_id` 中的一个必须提供。了解更多
关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持 `connector_id` 的取值包括:
+ 目前支持 `connector_id` 的值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -2752,42 +2752,42 @@
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选器对象
- 。
+ `always`, `never`,也可以是与工具关联的过滤器对象
+ 这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。取值为 `always` 角色提供的指令优先级高于
- `never`。之一。设置为 `always`,所有工具都将需要审批。设置为
- 时, `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值之一为 `always` 或
+ `never`。当设置为 `always`,所有工具都将需要审批。当
+ 设置为 `never`,所有工具都将不需要审批。
- `"always"`
@@ -2799,23 +2799,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。二者必须提供 `server_url`, `connector_id`、或
- `tunnel_id` 其一。
+ MCP 服务器的 URL。需要提供以下其中一项 `server_url`, `connector_id`,或
+ `tunnel_id` 。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。二者必须提供
- `server_url`, `connector_id`、或 `tunnel_id` 其一。
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。需要提供以下其中一项
+ `server_url`, `connector_id`,或 `tunnel_id` 。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示的响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是指定可供你的代码使用的已上传文件 ID 以及可选的
- 设置的对象。
- 可选的 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID 或指定可上传到你的代码中的文件 ID 以及
+ 指定可提供给代码的上传文件 ID,以及
+ 可选的 `memory_limit` 设置的对象。
- `string`
@@ -2823,17 +2823,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供你的代码使用的已上传文件的可选列表。
+ 提供给代码的可选上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2857,7 +2857,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终为 `code_interpreter`.
+ 代码解释器工具的类型。固定为 `code_interpreter`.
- `"code_interpreter"`
@@ -2873,7 +2873,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 工具的类型。固定为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -2883,7 +2883,7 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终为 `image_generation`.
+ 图像生成工具的类型。固定为 `image_generation`.
- `"image_generation"`
@@ -2900,10 +2900,10 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`、或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
- `transparent`,时,请将输出格式设置为 `png` 角色提供的指令优先级高于 `webp`。默认值: `auto`.
+ `opaque`,或 `auto`。之一。支持透明背景的
+ GPT 图像模型可用。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -2913,7 +2913,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅对 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -2921,8 +2921,8 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (string, optional)和 `file_id` (string, optional)。
+ 可选的修复蒙版。包含 `image_url`
+ (string, optional) 和 `file_id` (string, optional)。
- `file_id: optional string`
@@ -2936,7 +2936,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -2945,7 +2945,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -2972,7 +2972,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`、或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -2983,12 +2983,12 @@
- `partial_images: optional number`
- 在流式模式下要生成的局部图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
生成图像的质量。可选值为 `low`, `medium`, `high`,
- 角色提供的指令优先级高于 `auto`。默认值: `auto`.
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -3000,13 +3000,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -3076,7 +3076,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -3084,7 +3084,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
@@ -3100,7 +3100,7 @@
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 该命名空间内可用的函数/自定义工具。
+ 此命名空间内可用的 function/custom 工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -3120,19 +3120,19 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 该 function 是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
+ 描述该 function 工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否启用严格的参数校验。如果省略,响应接口 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。若未指定,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -3158,7 +3158,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -3166,21 +3166,21 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 工具的类型。固定为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 工具的类型。固定为 `tool_search`.
- `"tool_search"`
@@ -3190,7 +3190,7 @@
- `execution: optional "server" or "client"`
- 工具搜索由服务端执行还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -3198,15 +3198,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会搜索网页以获取与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会搜索网页以获取用于回复的相关结果。了解更多关于 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值之一为 `web_search_preview` 角色提供的指令优先级高于 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -3220,7 +3220,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -3230,7 +3230,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -3244,7 +3244,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -3252,15 +3252,15 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一的差异格式创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 工具的类型。固定为 `apply_patch`.
- `"apply_patch"`
@@ -3280,13 +3280,13 @@
- `id: optional string or null`
- 此额外工具项的唯一 ID。
+ 此额外工具条目的唯一 ID。
- `Reasoning object { id, summary, type, 3 more }`
- 对推理模型在生成响应时使用的思维链的描述。请务必将这些项包含在你的
- 请求中,并发送给 Responses API `input` 。
- 用于对话的后续轮次(如果你在手动
+ 推理模型在生成回复时所用思维链的描述。请务必在向
+ 发送的请求中包含这些条目 `input` :Responses API
+ 如果你需要手动管理上下文,用于对话的后续轮次
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -3299,17 +3299,17 @@
- `text: string`
- 到目前为止模型推理输出的摘要。
+ 模型到目前为止的推理输出摘要。
- `type: "summary_text"`
- 对象的类型,固定为 `summary_text`.
+ 对象的类型。始终为 `summary_text`.
- `"summary_text"`
- `type: "reasoning"`
- 对象的类型,固定为 `reasoning`.
+ 对象的类型。始终为 `reasoning`.
- `"reasoning"`
@@ -3323,26 +3323,26 @@
- `type: "reasoning_text"`
- 推理文本的类型,固定为 `reasoning_text`.
+ 推理文本的类型。始终为 `reasoning_text`.
- `"reasoning_text"`
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此项,
- 适用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理项的加密内容。默认情况下会填充此字段
+ 针对由以下接口返回的推理项 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 在流式传输时,请使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件
- 用于后续请求。此处 `encrypted_content` 中的
- `response.output_item.added` 可能不完整。这一点尤其
- 重要,当 `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 流式传输时,使用已完成的推理项及其
+ `encrypted_content` 来自 `response.output_item.done` 事件,于
+ 后续请求中使用。其中 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。这在以下情况下尤为重要:
+ 当 `store` 时 `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -3352,7 +3352,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由以下接口生成的压缩条目: [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -3408,7 +3408,7 @@
- `code: string or null`
- 要运行的代码,若不可用则为 null。
+ 要运行的代码,如果不可用则为 null。
- `container_id: string`
@@ -3417,7 +3417,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用的输出,可以为 null。
+ 如果没有可用输出,可能为 null。
- `Logs object { logs, type }`
@@ -3435,7 +3435,7 @@
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
@@ -3445,11 +3445,11 @@
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,由 GPT 图像模型支持; `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -3495,7 +3495,7 @@
- `timeout_ms: optional number or null`
- 命令的可选超时时间,以毫秒为单位。
+ 命令的可选超时(毫秒)。
- `user: optional string or null`
@@ -3545,7 +3545,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 项目的状态。取值之一为 `in_progress`, `completed`、或 `incomplete`.
+ 条目的状态。其一为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3559,11 +3559,11 @@
- `action: object { commands, max_output_length, timeout_ms }`
- 用于描述如何运行该工具调用的 shell 命令与限制。
+ 用于描述如何运行该工具调用的 shell 命令和限制。
- `commands: array of string`
- 供执行环境按顺序运行的 shell 命令。
+ 执行环境要按顺序运行的 shell 命令。
- `max_output_length: optional number or null`
@@ -3571,7 +3571,7 @@
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的最长挂钟时间(毫秒)。
+ 允许 shell 命令运行的最长墙上时钟时间(毫秒)。
- `call_id: string`
@@ -3585,11 +3585,11 @@
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当此 item 通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -3603,7 +3603,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3621,7 +3621,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。可选值为 `in_progress`, `completed`、或 `incomplete`.
+ shell 调用的状态。值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3631,7 +3631,7 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- shell 工具调用发出的流式输出条目。
+ 由 shell 工具调用发出的流式输出 item。
- `call_id: string`
@@ -3639,7 +3639,7 @@
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获到的 stdout 与 stderr 输出块及其相关结果。
+ 已捕获的 stdout 和 stderr 输出块及其关联的结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -3657,7 +3657,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已结束并返回了退出码。
+ 表示 shell 命令已执行完毕并返回了退出码。
- `exit_code: number`
@@ -3671,11 +3671,11 @@
- `stderr: string`
- 为该 shell 调用捕获到的 stderr 输出。
+ 为该 shell 调用捕获的 stderr 输出。
- `stdout: string`
- 为该 shell 调用捕获到的 stdout 输出。
+ 为该 shell 调用捕获的 stdout 输出。
- `type: "shell_call_output"`
@@ -3685,11 +3685,11 @@
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用输出的唯一 ID。当此 item 通过 API 返回时填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -3703,7 +3703,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3713,7 +3713,7 @@
- `max_output_length: optional number or null`
- 为该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 为该 shell 调用合并输出所捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -3727,7 +3727,7 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的请求的工具调用。
+ 表示通过差异补丁创建、删除或更新文件的工具调用。
- `call_id: string`
@@ -3743,7 +3743,7 @@
- `diff: string`
- 创建文件时要应用的 unified diff 内容。
+ 创建文件时要应用的统一差异内容。
- `path: string`
@@ -3775,7 +3775,7 @@
- `diff: string`
- 要应用到现有文件的 unified diff 内容。
+ 要对现有文件应用的统一差异内容。
- `path: string`
@@ -3789,7 +3789,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。值为以下之一: `in_progress` 角色提供的指令优先级高于 `completed`.
+ apply patch 工具调用的状态。可选值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -3803,11 +3803,11 @@
- `id: optional string or null`
- apply patch 工具调用的唯一 ID。当此项通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当此条目通过 API 返回时被填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -3821,7 +3821,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3839,7 +3839,7 @@
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。值为以下之一: `completed` 角色提供的指令优先级高于 `failed`.
+ apply patch 工具调用输出的状态。可选值为 `completed` 或 `failed`.
- `"completed"`
@@ -3853,11 +3853,11 @@
- `id: optional string or null`
- apply patch 工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时被填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -3871,7 +3871,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -3881,7 +3881,7 @@
- `output: optional string or null`
- apply patch 工具产生的可选人类可读的日志文本(例如补丁结果或错误)。
+ apply patch 工具的可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
@@ -3909,11 +3909,11 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 关于该工具的附加注释。
- `description: optional string or null`
- 工具的描述。
+ 该工具的描述。
- `type: "mcp_list_tools"`
@@ -3923,7 +3923,7 @@
- `error: optional string or null`
- 若服务器无法列出工具时返回的错误信息。
+ 如果服务器无法列出工具,则返回错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
@@ -3935,7 +3935,7 @@
- `arguments: string`
- 工具参数的 JSON 字符串。
+ 该工具参数的 JSON 字符串。
- `name: string`
@@ -3943,7 +3943,7 @@
- `server_label: string`
- 发起请求的 MCP 服务器的标签。
+ 发起该请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
@@ -4006,11 +4006,11 @@
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续输入中包含此值,以批准或拒绝对应的工具调用。 `mcp_approval_response` 在后续输入中包含此值,以批准或拒绝对应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误信息(如果有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -4046,7 +4046,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。可选值为 `in_progress`, `completed`, `incomplete`, `calling`、或 `failed`.
+ 工具调用的状态。可选值为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -4060,7 +4060,7 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 由你的代码生成的自定义工具调用输出,正被回传给模型。
+ 由你的代码生成的自定义工具调用输出,将发送回模型。
- `call_id: string`
@@ -4069,27 +4069,27 @@
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
由你的代码生成的自定义工具调用的输出。
- 可以是字符串或输出内容列表。
+ 可以是字符串或输出内容的列表。
- `StringOutput = string`
- 自定义工具调用输出的字符串。
+ 自定义工具调用的输出字符串。
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 提供给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解有关 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 发送给模型的输入文件。
- `type: "custom_tool_call_output"`
@@ -4099,11 +4099,11 @@
- `id: optional string`
- 在 OpenAI 平台中自定义工具调用输出的唯一 ID。
+ 在 OpenAI 平台中该自定义工具调用输出的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -4117,7 +4117,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4149,11 +4149,11 @@
- `id: optional string`
- 自定义工具调用在 OpenAI 平台中的唯一 ID。
+ 该自定义工具调用在 OpenAI 平台上的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -4165,7 +4165,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4177,7 +4177,7 @@
- `CompactionTrigger object { type, id }`
- 压缩当前上下文。必须作为最后一个输入项。
+ 压缩当前上下文。必须是最后一个输入项。
- `type: "compaction_trigger"`
@@ -4191,15 +4191,15 @@
- `ItemReference object { id, type }`
- 用于引用某个条目的内部标识符。
+ 用于引用某个项目的内部标识符。
- `id: string`
- 要引用的条目的 ID。
+ 要引用的项目的 ID。
- `type: optional "item_reference" or null`
- 要引用的条目的类型。始终为 `item_reference`.
+ 要引用的项目类型。始终为 `item_reference`.
- `"item_reference"`
@@ -4207,11 +4207,11 @@
- `id: string`
- 此程序条目的唯一 ID。
+ 该程序项的唯一 ID。
- `call_id: string`
- 程序条目的稳定调用 ID。
+ 该程序项的稳定调用 ID。
- `code: string`
@@ -4219,7 +4219,7 @@
- `fingerprint: string`
- 必须原样往返传递的、不透明的程序回放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
@@ -4231,19 +4231,19 @@
- `id: string`
- 此程序输出条目的唯一 ID。
+ 该程序输出项的唯一 ID。
- `call_id: string`
- 程序条目的调用 ID。
+ 该程序项的调用 ID。
- `result: string`
- 程序条目所生成的结果。
+ 由该程序项生成的结果。
- `status: "completed" or "incomplete"`
- 程序输出的终止状态。
+ 该程序输出的最终状态。
- `"completed"`
@@ -4257,19 +4257,19 @@
- `metadata: Metadata or null`
- 可附加到对象的一组 16 个键值对。这可以
- 用于以结构化格式存储有关对象的附加信息,
- 格式,并支持通过 API 或控制台查询对象。
+ 可以附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储关于对象的附加信息,
+ 格式,以及通过 API 或控制台查询对象。
- 键为字符串,最大长度为 64 个字符。值为字符串,
+ 键是字符串,最大长度为 64 个字符。值是字符串
最大长度为 512 个字符。
- `model: ResponsesModel`
- 用于生成响应的模型 ID,例如 `gpt-4o` 角色提供的指令优先级高于 `o3`. OpenAI
- 提供多种能力、性能
- 特性和价格点各不相同的模型。请参阅 [模型指南](/docs/models)
- 以浏览和比较可用模型。
+ 用于生成响应的模型 ID,例如 `gpt-5.6-sol`. OpenAI
+ 提供多种模型,这些模型在能力、性能
+ 特征和价格上各不相同。请参阅 [模型指南](/docs/models)
+ 以浏览和比较可用的模型。
- `string`
@@ -4483,29 +4483,29 @@
- `object: "response"`
- 此资源的对象类型——始终设置为 `response`.
+ 此资源的对象类型 - 始终设置为 `response`.
- `"response"`
- `output: array of ResponseOutputItem`
- 由模型生成的内容项数组。
+ 模型生成的内容项数组。
- - 该数组中项的长度 `output` 和顺序取决于
+ - 该数组中项的长度和顺序取决于 `output` 数组取决于
模型的响应。
- - 与其访问该数组的 `output` 第一项并
- 假设它是 `assistant` 包含模型生成内容的
- 消息,不如考虑使用 开发工具包 中支持 `output_text` 的属性,
- 前提是 SDK 支持该属性。
+ - 与其访问该数组的第一项并 `output` 假设它是
+ 包含模型生成内容的 `assistant` 消息,不如考虑使用
+ 属性(在支持的 `output_text` 属性,其中
+ 在 SDK 中受支持)。
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 来自模型的一条输出消息。
+ 来自模型的输出消息。
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。参见
- [文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
+ 文件搜索 工具调用的结果。请参阅
+ [文件搜索 指南](/docs/guides/tools-file-search) 。
- `id: string`
@@ -4517,8 +4517,8 @@
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。可选值为 `in_progress`,
- `searching`, `incomplete` 角色提供的指令优先级高于 `failed`,
+ 文件搜索 工具调用的状态。取值之一 `in_progress`,
+ `searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -4542,11 +4542,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的一组 16 个键值对。这可以
- 用于以结构化格式存储有关对象的附加信息,
- 并通过 API 或仪表板查询对象。键为字符串,
- 最大长度为 64 个字符。值为字符串(最大
- 长度为 512 个字符)、布尔值或数字。
+ 可以附加到对象的 16 组键值对。这可以
+ 用于以结构化格式存储关于对象的附加信息,
+ 并通过API或仪表板查询对象。键是字符串,
+ 最大长度为 64 个字符。值是最大长度为 512 个字符的字符串、
+ 布尔值或数字。
- `string`
@@ -4564,7 +4564,7 @@
- `score: optional number`
- 文件的相关性评分,取值范围为 0 到 1。
+ 文件的相关性评分,介于 0 和 1 之间。
- `text: optional string`
@@ -4572,8 +4572,8 @@
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 运行函数的工具调用。请参阅
- [函数调用指南](/docs/guides/function-calling) 了解更多信息。
+ 用于运行函数的工具调用。请参阅
+ [function calling guide](/docs/guides/function-calling) 。
- `arguments: string`
@@ -4599,7 +4599,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -4611,7 +4611,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4623,8 +4623,8 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -4640,8 +4640,8 @@
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 你的代码生成的函数调用的输出。
- 可以是字符串或输出内容列表。
+ 由你的代码生成的函数调用的输出。
+ 可以是字符串或输出内容的列表。
- `StringOutput = string`
@@ -4649,24 +4649,24 @@
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 函数调用的文本、图像或文件输出。
+ 函数调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 提供给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解有关 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 发送给模型的输入文件。
- `status: "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -4686,7 +4686,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -4700,7 +4700,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4710,20 +4710,20 @@
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `name: optional string`
- 生成该输出的工具的名称。
+ 产生该输出的工具的名称。
- `namespace: optional string`
- 生成该输出的工具的命名空间。
+ 产生该输出的工具的命名空间。
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。参见
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 一次 网页搜索 工具调用的结果。请参阅
+ [网页搜索 指南](/docs/guides/tools-web-search) 。
- `id: string`
@@ -4731,12 +4731,12 @@
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
- 包含模型如何使用网络的详细信息(search、open_page、find_in_page)。
+ 描述本次 网页搜索 调用中所执行具体操作的对象。
+ 包含模型使用网络的方式的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
- Action 类型 "search" - 执行一次 网页搜索 查询。
+ Action 类型 "search" —— 执行一次 网页搜索 查询。
- `type: "search"`
@@ -4746,11 +4746,11 @@
- `queries: optional array of string`
- 搜索查询列表。
+ 搜索查询。
- `query: optional string`
- 搜索查询。
+ 搜索查询语句。
- `sources: optional array of object { type, url }`
@@ -4768,7 +4768,7 @@
- `OpenPage object { type, url }`
- 动作类型 "open_page" - 打开搜索结果中的特定 URL。
+ 操作类型 "open_page" - 从搜索结果中打开指定的 URL。
- `type: "open_page"`
@@ -4782,7 +4782,7 @@
- `FindInPage object { pattern, type, url }`
- 动作类型 "find_in_page":在已加载的页面中搜索某个模式。
+ 操作类型 "find_in_page":在已加载的页面中搜索某个模式。
- `pattern: string`
@@ -4812,14 +4812,14 @@
- `type: "web_search_call"`
- 网页搜索工具调用的类型。始终为 `web_search_call`.
+ 网页搜索 工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。请参阅
- [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
+ 对计算机使用工具的工具调用。参见
+ [计算机使用指南](/docs/guides/tools-computer-use) 。
- `id: string`
@@ -4827,7 +4827,7 @@
- `call_id: string`
- 用于在响应工具调用时携带输出的标识符。
+ 在向工具调用提供输出响应时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
@@ -4843,12 +4843,12 @@
- `message: optional string or null`
- 待处理安全检查的详细信息。
+ 关于待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -4864,18 +4864,18 @@
- `action: optional ComputerAction`
- 单击操作。
+ 一次点击动作。
- `actions: optional ComputerActionList`
- 针对的扁平化批量操作 `computer_use`. 每个 action 包含一个
- `type` discriminator 和 action 特有的字段。
+ 针对的扁平化批量动作 `computer_use`. 每个 action 包含一个
+ `type` 判别字段和 action 特定的字段。
- `ComputerCallOutput object { id, call_id, output, 4 more }`
- `id: string`
- 该计算机调用工具输出的唯一 ID。
+ 计算机调用工具输出的唯一 ID。
- `call_id: string`
@@ -4883,12 +4883,12 @@
- `output: ResponseComputerToolCallOutputScreenshot`
- 与 computer use 工具配合使用的 computer 截图图像。
+ 与 computer use 工具配合使用的电脑截图。
- `status: "completed" or "incomplete" or "failed" or "in_progress"`
- 消息输入的状态。可选值为 `in_progress`, `completed`、或
- `incomplete`。之一。当输入项通过API返回时填充。
+ 消息输入的状态。取值之一 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回输入项时填充。
- `"completed"`
@@ -4900,13 +4900,13 @@
- `type: "computer_call_output"`
- computer 工具调用输出的类型。始终为 `computer_call_output`.
+ computer 工具调用输出的类型。始终 `computer_call_output`.
- `"computer_call_output"`
- `acknowledged_safety_checks: optional array of object { id, code, message }`
- 由 API 报告的、已被
+ 由 API 报告且已被
开发者确认的安全检查。
- `id: string`
@@ -4919,17 +4919,17 @@
- `message: optional string or null`
- 待处理安全检查的详细信息。
+ 关于待处理安全检查的详细信息。
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `Reasoning object { id, summary, type, 3 more }`
- 对推理模型在生成响应时使用的思维链的描述。请务必将这些项包含在你的
- 请求中,并发送给 Responses API `input` 。
- 用于对话的后续轮次(如果你在手动
+ 推理模型在生成回复时所用思维链的描述。请务必在向
+ 发送的请求中包含这些条目 `input` :Responses API
+ 如果你需要手动管理上下文,用于对话的后续轮次
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -4942,15 +4942,15 @@
- `text: string`
- 到目前为止模型推理输出的摘要。
+ 模型到目前为止的推理输出摘要。
- `type: "summary_text"`
- 对象的类型,固定为 `summary_text`.
+ 对象的类型。始终为 `summary_text`.
- `type: "reasoning"`
- 对象的类型,固定为 `reasoning`.
+ 对象的类型。始终为 `reasoning`.
- `"reasoning"`
@@ -4964,26 +4964,26 @@
- `type: "reasoning_text"`
- 推理文本的类型,固定为 `reasoning_text`.
+ 推理文本的类型。始终为 `reasoning_text`.
- `"reasoning_text"`
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充此项,
- 适用于通过 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理项的加密内容。默认情况下会填充此字段
+ 针对由以下接口返回的推理项 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求。
- 在流式传输时,请使用已完成的推理项及其
- `encrypted_content` 来自 `response.output_item.done` 事件
- 用于后续请求。此处 `encrypted_content` 中的
- `response.output_item.added` 可能不完整。这一点尤其
- 重要,当 `store` 是 `false` 或在使用 Zero Data Retention 时。
+ 流式传输时,使用已完成的推理项及其
+ `encrypted_content` 来自 `response.output_item.done` 事件,于
+ 后续请求中使用。其中 `encrypted_content` 中的
+ `response.output_item.added` 可能不完整。这在以下情况下尤为重要:
+ 当 `store` 时 `false` 或在使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -4999,7 +4999,7 @@
- `call_id: string`
- 程序条目的稳定调用 ID。
+ 该程序项的稳定调用 ID。
- `code: string`
@@ -5007,7 +5007,7 @@
- `fingerprint: string`
- 必须原样往返传递的、不透明的程序回放指纹。
+ 必须往返透传的不透明程序回放指纹。
- `type: "program"`
@@ -5019,19 +5019,19 @@
- `id: string`
- 该程序输出条目的唯一 ID。
+ 程序输出条目的唯一 ID。
- `call_id: string`
- 程序条目的调用 ID。
+ 该程序项的调用 ID。
- `result: string`
- 程序条目所生成的结果。
+ 由该程序项生成的结果。
- `status: "completed" or "incomplete"`
- 该程序输出条目的终态。
+ 程序输出条目的最终状态。
- `"completed"`
@@ -5047,7 +5047,7 @@
- `id: string`
- 该工具搜索调用条目的唯一 ID。
+ 工具搜索调用条目的唯一 ID。
- `arguments: unknown`
@@ -5067,7 +5067,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索调用条目的状态。
+ 已记录的工具搜索调用条目的状态。
- `"in_progress"`
@@ -5083,13 +5083,13 @@
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `ToolSearchOutput object { id, call_id, execution, 4 more }`
- `id: string`
- 该工具搜索输出条目的唯一 ID。
+ 工具搜索输出条目的唯一 ID。
- `call_id: string or null`
@@ -5105,7 +5105,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 所记录的工具搜索输出条目的状态。
+ 已记录的工具搜索输出条目的状态。
- `"in_progress"`
@@ -5115,11 +5115,11 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 工具搜索返回的已加载工具定义。
+ 由工具搜索返回的已加载工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -5127,11 +5127,11 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -5149,19 +5149,19 @@
- `defer_loading: optional boolean`
- 该函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -5171,7 +5171,7 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
@@ -5179,15 +5179,15 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于在指定的属性键与给定值之间使用定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选条件 `and` 角色提供的指令优先级高于 `or`.
+ 使用以下方式组合多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -5195,7 +5195,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -5215,7 +5215,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1,尝试仅返回最相关的结果,但可能会返回更少的结果。
- `Computer object { type }`
@@ -5223,7 +5223,7 @@
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终为 `computer`.
- `"computer"`
@@ -5262,11 +5262,11 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
在互联网上搜索与提示相关的来源。详细了解
- [网页搜索工具](/docs/guides/tools-web-search).
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值之一为 `web_search` 角色提供的指令优先级高于 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -5274,22 +5274,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索 进行实时互联网访问。如果省略,默认值为 true。如果设为 false,网页搜索工具将运行在离线/仅缓存模式下,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当设置为 false 时,网页搜索 工具将以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 搜索的过滤条件。
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -5307,7 +5307,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5315,7 +5315,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -5326,11 +5326,11 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ (MCP) 服务器为模型提供对其他工具的访问权限。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -5348,39 +5348,39 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许使用的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 包含允许的工具名称的字符串数组
+ 允许使用的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可与自定义 MCP
- 服务器 URL 或服务连接器一起使用。你的应用程序
- 必须处理 OAuth 授权流程并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义
+ MCP 服务器 URL 或服务连接器使用。你的应用程序
+ 必须处理 OAuth 授权流程,并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的连接器。以下之一
- `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。
+ `server_url`, `connector_id`,或 `tunnel_id` 中的一个必须提供。了解更多
关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持 `connector_id` 的取值包括:
+ 目前支持 `connector_id` 的值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -5423,42 +5423,42 @@
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选器对象
- 。
+ `always`, `never`,也可以是与工具关联的过滤器对象
+ 这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。取值为 `always` 角色提供的指令优先级高于
- `never`。之一。设置为 `always`,所有工具都将需要审批。设置为
- 时, `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值之一为 `always` 或
+ `never`。当设置为 `always`,所有工具都将需要审批。当
+ 设置为 `never`,所有工具都将不需要审批。
- `"always"`
@@ -5470,23 +5470,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。二者必须提供 `server_url`, `connector_id`、或
- `tunnel_id` 其一。
+ MCP 服务器的 URL。需要提供以下其中一项 `server_url`, `connector_id`,或
+ `tunnel_id` 。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。二者必须提供
- `server_url`, `connector_id`、或 `tunnel_id` 其一。
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。需要提供以下其中一项
+ `server_url`, `connector_id`,或 `tunnel_id` 。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示的响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是指定可供你的代码使用的已上传文件 ID 以及可选的
- 设置的对象。
- 可选的 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID 或指定可上传到你的代码中的文件 ID 以及
+ 指定可提供给代码的上传文件 ID,以及
+ 可选的 `memory_limit` 设置的对象。
- `string`
@@ -5494,17 +5494,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供你的代码使用的已上传文件的可选列表。
+ 提供给代码的可选上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -5528,7 +5528,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终为 `code_interpreter`.
+ 代码解释器工具的类型。固定为 `code_interpreter`.
- `"code_interpreter"`
@@ -5544,7 +5544,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 工具的类型。固定为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -5554,7 +5554,7 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终为 `image_generation`.
+ 图像生成工具的类型。固定为 `image_generation`.
- `"image_generation"`
@@ -5571,10 +5571,10 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`、或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
- `transparent`,时,请将输出格式设置为 `png` 角色提供的指令优先级高于 `webp`。默认值: `auto`.
+ `opaque`,或 `auto`。之一。支持透明背景的
+ GPT 图像模型可用。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5584,7 +5584,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅对 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -5592,8 +5592,8 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (string, optional)和 `file_id` (string, optional)。
+ 可选的修复蒙版。包含 `image_url`
+ (string, optional) 和 `file_id` (string, optional)。
- `file_id: optional string`
@@ -5607,7 +5607,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -5616,7 +5616,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -5643,7 +5643,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`、或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -5654,12 +5654,12 @@
- `partial_images: optional number`
- 在流式模式下要生成的局部图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
生成图像的质量。可选值为 `low`, `medium`, `high`,
- 角色提供的指令优先级高于 `auto`。默认值: `auto`.
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -5671,13 +5671,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -5747,7 +5747,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -5755,7 +5755,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
@@ -5771,7 +5771,7 @@
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 该命名空间内可用的函数/自定义工具。
+ 此命名空间内可用的 function/custom 工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -5791,19 +5791,19 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 该 function 是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
+ 描述该 function 工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否启用严格的参数校验。如果省略,响应接口 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。若未指定,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -5829,7 +5829,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -5837,21 +5837,21 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 工具的类型。固定为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 工具的类型。固定为 `tool_search`.
- `"tool_search"`
@@ -5861,7 +5861,7 @@
- `execution: optional "server" or "client"`
- 工具搜索由服务端执行还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -5869,15 +5869,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会搜索网页以获取与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会搜索网页以获取用于回复的相关结果。了解更多关于 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值之一为 `web_search_preview` 角色提供的指令优先级高于 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -5891,7 +5891,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -5901,7 +5901,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -5915,7 +5915,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -5923,15 +5923,15 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一的差异格式创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 工具的类型。固定为 `apply_patch`.
- `"apply_patch"`
@@ -5951,17 +5951,17 @@
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `AdditionalTools object { id, role, tools, type }`
- `id: string`
- 该附加工具条目的唯一 ID。
+ 附加工具条目的唯一 ID。
- `role: "unknown" or "user" or "assistant" or 5 more`
- 提供这些附加工具的角色。
+ 提供附加工具的角色。
- `"unknown"`
@@ -5981,11 +5981,11 @@
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在该条目中可用的附加工具定义。
+ 在此条目中可用的附加工具定义。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -5993,11 +5993,11 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -6015,19 +6015,19 @@
- `defer_loading: optional boolean`
- 该函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -6037,7 +6037,7 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
@@ -6045,15 +6045,15 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于在指定的属性键与给定值之间使用定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选条件 `and` 角色提供的指令优先级高于 `or`.
+ 使用以下方式组合多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -6061,7 +6061,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -6081,7 +6081,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1,尝试仅返回最相关的结果,但可能会返回更少的结果。
- `Computer object { type }`
@@ -6089,7 +6089,7 @@
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终为 `computer`.
- `"computer"`
@@ -6128,11 +6128,11 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
在互联网上搜索与提示相关的来源。详细了解
- [网页搜索工具](/docs/guides/tools-web-search).
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值之一为 `web_search` 角色提供的指令优先级高于 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -6140,22 +6140,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索 进行实时互联网访问。如果省略,默认值为 true。如果设为 false,网页搜索工具将运行在离线/仅缓存模式下,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当设置为 false 时,网页搜索 工具将以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 搜索的过滤条件。
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6173,7 +6173,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6181,7 +6181,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -6192,11 +6192,11 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ (MCP) 服务器为模型提供对其他工具的访问权限。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -6214,39 +6214,39 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许使用的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 包含允许的工具名称的字符串数组
+ 允许使用的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可与自定义 MCP
- 服务器 URL 或服务连接器一起使用。你的应用程序
- 必须处理 OAuth 授权流程并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义
+ MCP 服务器 URL 或服务连接器使用。你的应用程序
+ 必须处理 OAuth 授权流程,并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的连接器。以下之一
- `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。
+ `server_url`, `connector_id`,或 `tunnel_id` 中的一个必须提供。了解更多
关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持 `connector_id` 的取值包括:
+ 目前支持 `connector_id` 的值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -6289,42 +6289,42 @@
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选器对象
- 。
+ `always`, `never`,也可以是与工具关联的过滤器对象
+ 这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。取值为 `always` 角色提供的指令优先级高于
- `never`。之一。设置为 `always`,所有工具都将需要审批。设置为
- 时, `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值之一为 `always` 或
+ `never`。当设置为 `always`,所有工具都将需要审批。当
+ 设置为 `never`,所有工具都将不需要审批。
- `"always"`
@@ -6336,23 +6336,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。二者必须提供 `server_url`, `connector_id`、或
- `tunnel_id` 其一。
+ MCP 服务器的 URL。需要提供以下其中一项 `server_url`, `connector_id`,或
+ `tunnel_id` 。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。二者必须提供
- `server_url`, `connector_id`、或 `tunnel_id` 其一。
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。需要提供以下其中一项
+ `server_url`, `connector_id`,或 `tunnel_id` 。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示的响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是指定可供你的代码使用的已上传文件 ID 以及可选的
- 设置的对象。
- 可选的 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID 或指定可上传到你的代码中的文件 ID 以及
+ 指定可提供给代码的上传文件 ID,以及
+ 可选的 `memory_limit` 设置的对象。
- `string`
@@ -6360,17 +6360,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供你的代码使用的已上传文件的可选列表。
+ 提供给代码的可选上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -6394,7 +6394,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终为 `code_interpreter`.
+ 代码解释器工具的类型。固定为 `code_interpreter`.
- `"code_interpreter"`
@@ -6410,7 +6410,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 工具的类型。固定为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -6420,7 +6420,7 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终为 `image_generation`.
+ 图像生成工具的类型。固定为 `image_generation`.
- `"image_generation"`
@@ -6437,10 +6437,10 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`、或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
- `transparent`,时,请将输出格式设置为 `png` 角色提供的指令优先级高于 `webp`。默认值: `auto`.
+ `opaque`,或 `auto`。之一。支持透明背景的
+ GPT 图像模型可用。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -6450,7 +6450,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅对 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -6458,8 +6458,8 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (string, optional)和 `file_id` (string, optional)。
+ 可选的修复蒙版。包含 `image_url`
+ (string, optional) 和 `file_id` (string, optional)。
- `file_id: optional string`
@@ -6473,7 +6473,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -6482,7 +6482,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -6509,7 +6509,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`、或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -6520,12 +6520,12 @@
- `partial_images: optional number`
- 在流式模式下要生成的局部图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
生成图像的质量。可选值为 `low`, `medium`, `high`,
- 角色提供的指令优先级高于 `auto`。默认值: `auto`.
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -6537,13 +6537,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -6613,7 +6613,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -6621,7 +6621,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
@@ -6637,7 +6637,7 @@
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 该命名空间内可用的函数/自定义工具。
+ 此命名空间内可用的 function/custom 工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -6657,19 +6657,19 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 该 function 是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
+ 描述该 function 工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否启用严格的参数校验。如果省略,响应接口 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。若未指定,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -6695,7 +6695,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -6703,21 +6703,21 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 工具的类型。固定为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 工具的类型。固定为 `tool_search`.
- `"tool_search"`
@@ -6727,7 +6727,7 @@
- `execution: optional "server" or "client"`
- 工具搜索由服务端执行还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -6735,15 +6735,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会搜索网页以获取与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会搜索网页以获取用于回复的相关结果。了解更多关于 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值之一为 `web_search_preview` 角色提供的指令优先级高于 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -6757,7 +6757,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -6767,7 +6767,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -6781,7 +6781,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -6789,15 +6789,15 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一的差异格式创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 工具的类型。固定为 `apply_patch`.
- `"apply_patch"`
@@ -6817,15 +6817,15 @@
- `Compaction object { id, encrypted_content, type, created_by }`
- 由以下接口生成的压缩条目: [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `id: string`
- 该压缩条目的唯一 ID。
+ 压缩条目的唯一 ID。
- `encrypted_content: string`
- 由压缩生成的内容(已加密)。
+ 由压缩生成的加密内容。
- `type: "compaction"`
@@ -6835,7 +6835,7 @@
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `ImageGenerationCall object { id, result, status, type }`
@@ -6877,7 +6877,7 @@
- `code: string or null`
- 要运行的代码,若不可用则为 null。
+ 要运行的代码,如果不可用则为 null。
- `container_id: string`
@@ -6886,7 +6886,7 @@
- `outputs: array of object { logs, type } or object { type, url } or null`
代码解释器生成的输出,例如日志或图像。
- 如果没有可用的输出,可以为 null。
+ 如果没有可用输出,可能为 null。
- `Logs object { logs, type }`
@@ -6904,7 +6904,7 @@
- `Image object { type, url }`
- 来自代码解释器的图片输出。
+ 代码解释器的图片输出。
- `type: "image"`
@@ -6914,11 +6914,11 @@
- `url: string`
- 来自代码解释器的图片输出的 URL。
+ 代码解释器图片输出的 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
- 代码解释器工具调用的状态。有效值包括 `in_progress`, `completed`, `incomplete`, `interpreting`,由 GPT 图像模型支持; `failed`.
+ 代码解释器工具调用的状态。有效值为 `in_progress`, `completed`, `incomplete`, `interpreting`,和 `failed`.
- `"in_progress"`
@@ -6964,7 +6964,7 @@
- `timeout_ms: optional number or null`
- 命令的可选超时时间,以毫秒为单位。
+ 命令的可选超时(毫秒)。
- `user: optional string or null`
@@ -7014,7 +7014,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 项目的状态。取值之一为 `in_progress`, `completed`、或 `incomplete`.
+ 条目的状态。其一为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7028,21 +7028,21 @@
- `id: string`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当此 item 通过 API 返回时填充。
- `action: object { commands, max_output_length, timeout_ms }`
- 用于描述如何运行该工具调用的 shell 命令与限制。
+ 用于描述如何运行该工具调用的 shell 命令和限制。
- `commands: array of string`
- `max_output_length: number or null`
- 每个命令返回内容的可选最大字符数。
+ 每个命令返回的可选最大字符数。
- `timeout_ms: number or null`
- 命令的可选超时时间,单位为毫秒。
+ 命令的可选超时时间,以毫秒为单位。
- `call_id: string`
@@ -7076,7 +7076,7 @@
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用的状态。可选值为 `in_progress`, `completed`、或 `incomplete`.
+ shell 调用的状态。值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7092,7 +7092,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -7104,7 +7104,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7120,7 +7120,7 @@
- `id: string`
- shell 调用的唯一 ID。通过 API 返回该 item 时填充。
+ shell 调用输出的唯一 ID。通过 API 返回此条目时填充。
- `call_id: string`
@@ -7128,7 +7128,7 @@
- `max_output_length: number or null`
- shell 命令输出的最大长度。该值由模型生成,应与原始输出一起传回。
+ shell 命令输出的最大长度。这由模型生成,应与原始输出一起传回。
- `output: array of object { outcome, stderr, stdout, created_by }`
@@ -7136,7 +7136,7 @@
- `outcome: object { type } or object { exit_code, type }`
- 表示 shell 调用输出块的退出结果(包含退出码)或超时结果。
+ 表示 shell 调用输出块的退出结果(带有退出码)或超时结果。
- `Timeout object { type }`
@@ -7150,7 +7150,7 @@
- `Exit object { exit_code, type }`
- 表示 shell 命令已结束并返回了退出码。
+ 表示 shell 命令已执行完毕并返回了退出码。
- `exit_code: number`
@@ -7164,19 +7164,19 @@
- `stderr: string`
- 捕获到的标准错误输出。
+ 已捕获的标准错误输出。
- `stdout: string`
- 捕获到的标准输出。
+ 已捕获的标准输出。
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `status: "in_progress" or "completed" or "incomplete"`
- shell 调用输出的状态。取值为以下之一 `in_progress`, `completed`、或 `incomplete`.
+ shell 调用输出的状态。取值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -7192,7 +7192,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -7204,7 +7204,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7212,7 +7212,7 @@
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `ApplyPatchCall object { id, call_id, operation, 4 more }`
@@ -7220,7 +7220,7 @@
- `id: string`
- apply patch 工具调用的唯一 ID。当此项通过 API 返回时填充。
+ apply patch 工具调用的唯一 ID。当此条目通过 API 返回时被填充。
- `call_id: string`
@@ -7282,7 +7282,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。值为以下之一: `in_progress` 角色提供的指令优先级高于 `completed`.
+ apply patch 工具调用的状态。可选值为 `in_progress` 或 `completed`.
- `"in_progress"`
@@ -7296,7 +7296,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -7308,7 +7308,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7324,7 +7324,7 @@
- `id: string`
- apply patch 工具调用输出的唯一 ID。当此项通过 API 返回时填充。
+ apply patch 工具调用输出的唯一 ID。当此条目通过 API 返回时被填充。
- `call_id: string`
@@ -7332,7 +7332,7 @@
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。值为以下之一: `completed` 角色提供的指令优先级高于 `failed`.
+ apply patch 工具调用输出的状态。可选值为 `completed` 或 `failed`.
- `"completed"`
@@ -7346,7 +7346,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -7358,7 +7358,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7366,7 +7366,7 @@
- `created_by: optional string`
- 创建此工具调用输出的实体 ID。
+ 创建此工具调用输出的实体的 ID。
- `output: optional string or null`
@@ -7401,11 +7401,11 @@
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续输入中包含此值,以批准或拒绝对应的工具调用。 `mcp_approval_response` 在后续输入中包含此值,以批准或拒绝对应的工具调用。
+ 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误信息(如果有)。
+ 工具调用的错误(如果有)。
- `output: optional string or null`
@@ -7413,7 +7413,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。可选值为 `in_progress`, `completed`, `incomplete`, `calling`、或 `failed`.
+ 工具调用的状态。可选值为 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -7451,11 +7451,11 @@
- `annotations: optional unknown or null`
- 关于该工具的附加注解。
+ 关于该工具的附加注释。
- `description: optional string or null`
- 工具的描述。
+ 该工具的描述。
- `type: "mcp_list_tools"`
@@ -7465,7 +7465,7 @@
- `error: optional string or null`
- 若服务器无法列出工具时返回的错误信息。
+ 如果服务器无法列出工具,则返回错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
@@ -7477,7 +7477,7 @@
- `arguments: string`
- 工具参数的 JSON 字符串。
+ 该工具参数的 JSON 字符串。
- `name: string`
@@ -7485,7 +7485,7 @@
- `server_label: string`
- 发起请求的 MCP 服务器的标签。
+ 发起该请求的 MCP 服务器的标签。
- `type: "mcp_approval_request"`
@@ -7543,11 +7543,11 @@
- `id: optional string`
- 自定义工具调用在 OpenAI 平台中的唯一 ID。
+ 该自定义工具调用在 OpenAI 平台上的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -7559,7 +7559,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7582,32 +7582,32 @@
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
由你的代码生成的自定义工具调用的输出。
- 可以是字符串或输出内容列表。
+ 可以是字符串或输出内容的列表。
- `StringOutput = string`
- 自定义工具调用输出的字符串。
+ 自定义工具调用的输出字符串。
- `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 自定义工具调用的文本、图像或文件输出。
+ 自定义工具调用的文本、图片或文件输出。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 提供给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解有关 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 发送给模型的输入文件。
- `status: "in_progress" or "completed" or "incomplete"`
- 项目的状态。取值之一为 `in_progress`, `completed`、或
- `incomplete`。当通过 API 返回 item 时填充。
+ 条目的状态。其一为 `in_progress`, `completed`,或
+ `incomplete`。当通过 API 返回项目时会填充此字段。
- `"in_progress"`
@@ -7623,7 +7623,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 生成此工具调用的执行上下文。
+ 产生此工具调用的执行上下文。
- `Direct object { type }`
@@ -7637,7 +7637,7 @@
- `caller_id: string`
- 生成此工具调用的程序项的调用 ID。
+ 产生此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -7647,7 +7647,7 @@
- `created_by: optional string`
- 创建该条目的角色标识符。
+ 创建该条目的执行者的标识符。
- `parallel_tool_calls: boolean`
@@ -7655,22 +7655,22 @@
- `temperature: number or null`
- 使用的采样温度,介于 0 到 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加聚焦和确定性。
- 我们通常建议更改此项或 `top_p` ,但不要同时更改两者。
+ 使用的采样温度,介于 0 和 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使其更加聚焦和确定。
+ 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。
- `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more`
- 在生成时,模型应如何选择要使用的工具
- 响应。请参阅 `tools` 参数以了解如何指定模型可以调用
- 哪些工具。
+ 模型在生成
+ 响应时应如何选择要使用的工具(或多个工具)。请参阅 `tools` 参数以了解如何指定模型可以调用的工具
+ 。
- `ToolChoiceOptions = "none" or "auto" or "required"`
- 控制模型调用哪个工具(如果有的话)。
+ 控制模型调用哪个工具(如果有)。
`none` 表示模型不会调用任何工具,而是生成一条消息。
- `auto` 表示模型可以在生成消息与调用一个或
+ `auto` 表示模型可以在生成一条消息或调用一个或
多个工具之间进行选择。
`required` 表示模型必须调用一个或多个工具。
@@ -7683,16 +7683,16 @@
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为预定义的集合。
+ 将模型可用的工具限制为预定义集合。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为预定义的集合。
+ 将模型可用的工具限制为预定义集合。
`auto` 允许模型从允许的工具中进行选择并生成一条
消息。
- `required` 要求模型必须调用一个或多个允许的工具。
+ `required` 要求模型调用一个或多个允许的工具。
- `"auto"`
@@ -7721,14 +7721,14 @@
- `ToolChoiceTypes object { type }`
指示模型应使用内置工具生成响应。
- [详细了解内置工具](/docs/guides/tools).
+ [了解更多关于内置工具的信息](/docs/guides/tools).
- `type: "file_search" or "web_search_preview" or "computer" or 5 more`
- 模型应使用的 托管工具 类型。详细了解
+ 模型应使用的 托管工具 类型。了解更多关于
[内置工具](/docs/guides/tools).
- 允许的取值为:
+ 允许的值为:
- `file_search`
- `web_search_preview`
@@ -7778,17 +7778,17 @@
- `type: "mcp"`
- 对于 MCP 工具,type 始终为 `mcp`.
+ 对于 MCP 工具,类型始终为 `mcp`.
- `"mcp"`
- `name: optional string or null`
- 要在服务器上调用的工具的名称。
+ 要在服务器上调用的工具名称。
- `ToolChoiceCustom object { name, type }`
- 使用此选项以强制模型调用特定的自定义工具。
+ 使用此选项可强制模型调用特定的自定义工具。
- `name: string`
@@ -7796,7 +7796,7 @@
- `type: "custom"`
- 对于自定义工具调用,type 始终为 `custom`.
+ 对于自定义工具调用,类型始终为 `custom`.
- `"custom"`
@@ -7820,7 +7820,7 @@
- `ToolChoiceShell object { type }`
- 在需要工具调用时,强制模型调用 shell 工具。
+ 当需要工具调用时,强制模型调用 shell 工具。
- `type: "shell"`
@@ -7835,22 +7835,22 @@
我们支持以下类别的工具:
- - **内置工具**:由 OpenAI 提供的工具,用于扩展模型
- 的能力,例如 [网页搜索](/docs/guides/tools-web-search)
- 角色提供的指令优先级高于 [文件搜索](/docs/guides/tools-file-search)。详细了解
+ - **内置工具**:由 OpenAI 提供的工具,用于扩展模型的
+ 能力,例如 [网页搜索](/docs/guides/tools-web-search)
+ 或 [文件搜索](/docs/guides/tools-file-search)。了解更多关于
[内置工具](/docs/guides/tools).
- **MCP 工具**: 通过自定义 MCP 服务器与第三方系统集成
- 或预定义连接器(例如 Google Drive 和 SharePoint)进行集成。详细了解
+ 或预定义连接器(如 Google Drive 和 SharePoint)。了解有关
[MCP 工具](/docs/guides/tools-connectors-mcp).
- **函数调用(自定义工具)**: 由你定义的函数,
- 使模型能够使用强类型参数调用你自己的代码
- 并返回输出。详细了解
+ 使模型能够以强类型参数和返回值调用你自己的代码
+ 。了解有关
[函数调用](/docs/guides/function-calling)。你也可以使用
自定义工具来调用你自己的代码。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己的代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 在你自己的代码中定义一个可供模型选择的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -7858,11 +7858,11 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对该函数工具强制执行严格的参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
@@ -7880,19 +7880,19 @@
- `defer_loading: optional boolean`
- 该函数是否为延迟加载并通过工具搜索加载。
+ 此函数是否延迟加载并通过 tool search 加载。
- `description: optional string or null`
- 函数的描述,供模型用于判断是否调用该函数。
+ 函数的描述。供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
- 描述该函数字符串输出中所编码 JSON 值的 JSON schema 对象。
+ 描述此函数的字符串输出中所编码 JSON 值的 JSON schema 对象。
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
@@ -7902,7 +7902,7 @@
- `vector_store_ids: array of string`
- 要搜索的向量存储的 ID。
+ 要搜索的向量存储库 ID。
- `filters: optional ComparisonFilter or CompoundFilter or null`
@@ -7910,15 +7910,15 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于在指定的属性键与给定值之间使用定义的比较运算进行比较的过滤器。
- `CompoundFilter object { filters, type }`
- 使用以下方式组合多个筛选条件 `and` 角色提供的指令优先级高于 `or`.
+ 使用以下方式组合多个过滤器 `and` 或 `or`.
- `max_num_results: optional number`
- 返回的最大结果数。该数值应介于 1 到 50 之间(含端点)。
+ 返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -7926,7 +7926,7 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合中语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 用于在启用混合搜索时,控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
- `embedding_weight: number`
@@ -7946,7 +7946,7 @@
- `score_threshold: optional number`
- 文件搜索的分数阈值,介于 0 到 1 之间。越接近 1 的数值会尝试仅返回最相关的结果,但可能会返回更少的结果。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1,尝试仅返回最相关的结果,但可能会返回更少的结果。
- `Computer object { type }`
@@ -7954,7 +7954,7 @@
- `type: "computer"`
- 计算机工具的类型。始终为 `computer`.
+ computer 工具的类型。始终为 `computer`.
- `"computer"`
@@ -7993,11 +7993,11 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
在互联网上搜索与提示相关的来源。详细了解
- [网页搜索工具](/docs/guides/tools-web-search).
+ [网页搜索 tool](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值之一为 `web_search` 角色提供的指令优先级高于 `web_search_2025_08_26`.
+ 网页搜索 工具的类型。可选值为 `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -8005,22 +8005,22 @@
- `external_web_access: optional boolean`
- 允许 网页搜索 进行实时互联网访问。如果省略,默认值为 true。如果设为 false,网页搜索工具将运行在离线/仅缓存模式下,不会获取新的外部内容。
+ 允许 网页搜索 进行实时互联网访问。省略时默认为 true。当设置为 false 时,网页搜索 工具将以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 搜索的过滤条件。
- `allowed_domains: optional array of string or null`
- 搜索所允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样被允许。
+ 搜索允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名同样允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -8038,7 +8038,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -8046,7 +8046,7 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `type: optional "approximate"`
@@ -8057,11 +8057,11 @@
- `Mcp object { server_label, type, allowed_callers, 9 more }`
通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
+ (MCP) 服务器为模型提供对其他工具的访问权限。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中标识它。
+ 该 MCP 服务器的标签,用于在工具调用中识别它。
- `type: "mcp"`
@@ -8079,39 +8079,39 @@
- `allowed_tools: optional array of string or object { read_only, tool_names } or null`
- 允许的工具名称列表或筛选对象。
+ 允许使用的工具名称列表或筛选器对象。
- `McpAllowedTools = array of string`
- 包含允许的工具名称的字符串数组
+ 允许使用的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可与自定义 MCP
- 服务器 URL 或服务连接器一起使用。你的应用程序
- 必须处理 OAuth 授权流程并在此处提供令牌。
+ 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义
+ MCP 服务器 URL 或服务连接器使用。你的应用程序
+ 必须处理 OAuth 授权流程,并在此处提供令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中提供的连接器。以下之一
- `server_url`, `connector_id`、或 `tunnel_id` 必须提供。了解更多
+ 服务连接器的标识符,例如 ChatGPT 中可用的连接器。
+ `server_url`, `connector_id`,或 `tunnel_id` 中的一个必须提供。了解更多
关于服务连接器的信息 [此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持 `connector_id` 的取值包括:
+ 目前支持 `connector_id` 的值为:
- Dropbox: `connector_dropbox`
- Gmail: `connector_gmail`
@@ -8154,42 +8154,42 @@
- `McpToolApprovalFilter object { always, never }`
指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与需要审批的工具关联的筛选器对象
- 。
+ `always`, `never`,也可以是与工具关联的过滤器对象
+ 这些工具需要审批。
- `always: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `never: optional object { read_only, tool_names }`
- 用于指定允许哪些工具的筛选对象。
+ 用于指定允许使用哪些工具的筛选器对象。
- `read_only: optional boolean`
- 指示工具是否修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 指示工具是否为修改数据还是只读。如果某
+ MCP 服务器被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
,它将匹配此筛选器。
- `tool_names: optional array of string`
- 允许的工具名称列表。
+ 允许使用的工具名称列表。
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定统一的审批策略。取值为 `always` 角色提供的指令优先级高于
- `never`。之一。设置为 `always`,所有工具都将需要审批。设置为
- 时, `never`,所有工具都不需要审批。
+ 为所有工具指定统一的审批策略。可选值之一为 `always` 或
+ `never`。当设置为 `always`,所有工具都将需要审批。当
+ 设置为 `never`,所有工具都将不需要审批。
- `"always"`
@@ -8201,23 +8201,23 @@
- `server_url: optional string`
- MCP 服务器的 URL。二者必须提供 `server_url`, `connector_id`、或
- `tunnel_id` 其一。
+ MCP 服务器的 URL。需要提供以下其中一项 `server_url`, `connector_id`,或
+ `tunnel_id` 。
- `tunnel_id: optional string`
- 用于替代直接服务器 URL 的安全 MCP 隧道 ID。二者必须提供
- `server_url`, `connector_id`、或 `tunnel_id` 其一。
+ 用于代替直接服务器 URL 的安全 MCP 隧道 ID。需要提供以下其中一项
+ `server_url`, `connector_id`,或 `tunnel_id` 。
- `CodeInterpreter object { container, type, allowed_callers }`
- 运行 Python 代码以帮助生成对提示词回应的工具。
+ 运行 Python 代码以帮助生成对提示的响应的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,也可以是指定可供你的代码使用的已上传文件 ID 以及可选的
- 设置的对象。
- 可选的 `memory_limit` 设置。
+ 代码解释器容器。可以是容器 ID 或指定可上传到你的代码中的文件 ID 以及
+ 指定可提供给代码的上传文件 ID,以及
+ 可选的 `memory_limit` 设置的对象。
- `string`
@@ -8225,17 +8225,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定用于运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供你的代码使用的已上传文件的可选列表。
+ 提供给代码的可选上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -8259,7 +8259,7 @@
- `type: "code_interpreter"`
- 代码解释器工具的类型。始终为 `code_interpreter`.
+ 代码解释器工具的类型。固定为 `code_interpreter`.
- `"code_interpreter"`
@@ -8275,7 +8275,7 @@
- `type: "programmatic_tool_calling"`
- 工具的类型。始终为 `programmatic_tool_calling`.
+ 工具的类型。固定为 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -8285,7 +8285,7 @@
- `type: "image_generation"`
- 图像生成工具的类型。始终为 `image_generation`.
+ 图像生成工具的类型。固定为 `image_generation`.
- `"image_generation"`
@@ -8302,10 +8302,10 @@
- `background: optional "transparent" or "opaque" or "auto"`
设置生成图像的背景。可选值为 `transparent`,
- `opaque`、或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该功能处于预览阶段。当使用
- `transparent`,时,请将输出格式设置为 `png` 角色提供的指令优先级高于 `webp`。默认值: `auto`.
+ `opaque`,或 `auto`。之一。支持透明背景的
+ GPT 图像模型可用。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,该功能处于预览阶段。使用
+ `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -8315,7 +8315,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。该参数仅对 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。仅 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本模型支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -8323,8 +8323,8 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于修复的可选蒙版。包含 `image_url`
- (string, optional)和 `file_id` (string, optional)。
+ 可选的修复蒙版。包含 `image_url`
+ (string, optional) 和 `file_id` (string, optional)。
- `file_id: optional string`
@@ -8338,7 +8338,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `string`
@@ -8347,7 +8347,7 @@
要使用的图像生成模型。可选值为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
- `gpt-image-2-2026-04-21`、或 `chatgpt-image-latest`。默认值:
+ `gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
- `"gpt-image-1"`
@@ -8374,7 +8374,7 @@
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图像的输出格式。可选值为 `png`, `webp`、或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -8385,12 +8385,12 @@
- `partial_images: optional number`
- 在流式模式下要生成的局部图像数量,范围为 0(默认值)到 3。
+ 在流式模式下生成的部分图像数量,范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
生成图像的质量。可选值为 `low`, `medium`, `high`,
- 角色提供的指令优先级高于 `auto`。默认值: `auto`.
+ 或 `auto`。默认值: `auto`.
- `"low"`
@@ -8402,13 +8402,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 。宽和高都必须能被 16 整除,并且所请求的宽高比必须介于 1:3 和 3:1 之间。超过 `1536x864`。的分辨率为实验性功能,最大支持的分辨率为 `2560x1440` 。所请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `3840x2160`,以及 `1024x1024`, `1536x1024`,由 GPT 图像模型支持; `1024x1536` 由允许自动尺寸的模型支持。对于; `auto` 同样适用。 `dall-e-2`,请使用以下之一 `256x256`, `512x512`、或 `1024x1024`。有关 `dall-e-3`,请使用以下之一 `1024x1024`, `1792x1024`、或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定的任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度都必须能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 支持用于允许自动调整大小的模型。对于 `dall-e-2`,请使用以下其中之一 `256x256`, `512x512`,或 `1024x1024`。关于 `dall-e-3`,请使用以下其中之一 `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -8478,7 +8478,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -8486,7 +8486,7 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `Namespace object { description, name, tools, type }`
@@ -8502,7 +8502,7 @@
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
- 该命名空间内可用的函数/自定义工具。
+ 此命名空间内可用的 function/custom 工具。
- `Function object { name, type, allowed_callers, 5 more }`
@@ -8522,19 +8522,19 @@
- `defer_loading: optional boolean`
- 是否应延迟此函数并通过工具搜索发现。
+ 该 function 是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 用于描述此函数工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
+ 描述该 function 工具的字符串输出中所编码 JSON 值的 JSON Schema。这并不描述 content 数组形式的输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否启用严格的参数校验。如果省略,响应接口 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。若未指定,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -8560,7 +8560,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟,并通过工具搜索发现。
+ 是否应延迟此工具并通过工具搜索来发现它。
- `description: optional string`
@@ -8568,21 +8568,21 @@
- `format: optional CustomToolInputFormat`
- 自定义工具的输入格式。默认为无约束文本。
+ 自定义工具的输入格式。默认是不受约束的文本。
- `type: "namespace"`
- 工具的类型。始终为 `namespace`.
+ 工具的类型。固定为 `namespace`.
- `"namespace"`
- `ToolSearch object { type, description, execution, parameters }`
- 用于延迟工具的托管或 BYOT 工具搜索配置。
+ 延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
- 工具的类型。始终为 `tool_search`.
+ 工具的类型。固定为 `tool_search`.
- `"tool_search"`
@@ -8592,7 +8592,7 @@
- `execution: optional "server" or "client"`
- 工具搜索由服务端执行还是由客户端执行。
+ 工具搜索是由服务端执行还是由客户端执行。
- `"server"`
@@ -8600,15 +8600,15 @@
- `parameters: optional unknown or null`
- 用于客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数 schema。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
- 此工具会搜索网页以获取与响应相关的结果。了解更多关于 [网页搜索工具](https://platform.openai.com/docs/guides/tools-web-search).
+ 此工具会搜索网页以获取用于回复的相关结果。了解更多关于 [网页搜索 tool](https://platform.openai.com/docs/guides/tools-web-search).
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值之一为 `web_search_preview` 角色提供的指令优先级高于 `web_search_preview_2025_03_11`.
+ 网页搜索 工具的类型。可选值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -8622,7 +8622,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 `low`, `medium`、或 `high`. `medium` 为默认值。
+ 搜索使用的上下文窗口空间的高级指引。可选值为 `low`, `medium`,或 `high`. `medium` 为默认值。
- `"low"`
@@ -8632,7 +8632,7 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户的位置。
+ 用户所在的位置。
- `type: "approximate"`
@@ -8646,7 +8646,7 @@
- `country: optional string or null`
- 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属的国家,例如。 `US`.
+ 两个字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
@@ -8654,15 +8654,15 @@
- `timezone: optional string or null`
- 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) 所属的国家,例如。 `America/Los_Angeles`.
+ 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) ,例如。 `America/Los_Angeles`.
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用统一的差异格式创建、删除或更新文件。
+ 允许助手使用 unified diff 创建、删除或更新文件。
- `type: "apply_patch"`
- 工具的类型。始终为 `apply_patch`.
+ 工具的类型。固定为 `apply_patch`.
- `"apply_patch"`
@@ -8676,12 +8676,12 @@
- `top_p: number or null`
- 温度采样的替代方法,称为核采样(nucleus sampling),
- 模型会考虑概率质量排名前 top_p 的 token 的结果。
- 因此 0.1 意味着仅考虑构成前 10% 概率质量的 token。
- 不会被考虑。
+ 另一种使用 temperature 的采样方式,称为核采样(nucleus sampling),
+ 模型会考虑具有 top_p 概率质量的标记的结果
+ 。因此 0.1 表示仅考虑构成前 10% 概率质量的标记
+ 会被纳入考虑。
- 我们通常建议更改此项或 `temperature` ,但不要同时更改两者。
+ 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。
- `background: optional boolean or null`
@@ -8690,12 +8690,12 @@
- `completed_at: optional number or null`
- 此 Response 完成时的 Unix 时间戳(以秒为单位)。
+ 此响应完成时的 Unix 时间戳(以秒为单位)。
仅当状态为 `completed`.
- `conversation: optional object { id } or null`
- 此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话中。
+ 此响应所属的对话。此响应中的输入项和输出项已自动添加到此对话中。
- `id: string`
@@ -8703,15 +8703,15 @@
- `max_output_tokens: optional number or null`
- 响应可生成 token 数量的上限,包括可见输出 token 和 [推理令牌](/docs/guides/reasoning).
+ 响应可生成的标记数上限,包括可见输出标记和 [推理 tokens](/docs/guides/reasoning).
- `max_tool_calls: optional number or null`
- 响应中可处理的内置工具调用总次数上限。该上限适用于所有内置工具调用,而非单个工具。模型后续对工具的任何调用尝试都将被忽略。
+ 在一次响应中可处理的内置工具调用总次数上限。此上限适用于所有内置工具调用,而非单个工具。模型后续对工具的任何调用尝试都将被忽略。
- `moderation: optional object { input, output } or null`
- 响应输入与输出的审核结果(如果请求了已审核的补全)。
+ 响应输入和输出的审核结果(如果请求了已审核的补全)。
- `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }`
@@ -8719,15 +8719,15 @@
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
- 为响应输入或输出生成的审核结果。
+ 针对响应输入或输出生成的审核结果。
- `categories: map[boolean]`
- 从审核类别到布尔值的映射,如果输入在该类别下被标记则为 True。
+ 审核类别到布尔值的字典,若输入被标记为属于该类别,则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -8735,7 +8735,7 @@
- `category_scores: map[number]`
- 从审核类别到分数的映射。
+ 审核类别到分数的字典。
- `flagged: boolean`
@@ -8743,7 +8743,7 @@
- `model: string`
- 生成该结果的审核模型。
+ 生成此结果的审核模型。
- `type: "moderation_result"`
@@ -8753,7 +8753,7 @@
- `Error object { code, message, type }`
- 尝试对响应输入或输出进行审核时产生的错误。
+ 在尝试对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -8765,7 +8765,7 @@
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` ,用于审核失败的情况。
+ 对象类型,对于成功的审核结果始终为 `error` (针对审核失败)。
- `"error"`
@@ -8775,15 +8775,15 @@
- `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }`
- 为响应输入或输出生成的审核结果。
+ 针对响应输入或输出生成的审核结果。
- `categories: map[boolean]`
- 从审核类别到布尔值的映射,如果输入在该类别下被标记则为 True。
+ 审核类别到布尔值的字典,若输入被标记为属于该类别,则为 True。
- `category_applied_input_types: map[array of "text" or "image"]`
- 每个类别的分数所反映的输入模态。
+ 每个类别的分数所对应的输入模态。
- `"text"`
@@ -8791,7 +8791,7 @@
- `category_scores: map[number]`
- 从审核类别到分数的映射。
+ 审核类别到分数的字典。
- `flagged: boolean`
@@ -8799,7 +8799,7 @@
- `model: string`
- 生成该结果的审核模型。
+ 生成此结果的审核模型。
- `type: "moderation_result"`
@@ -8809,7 +8809,7 @@
- `Error object { code, message, type }`
- 尝试对响应输入或输出进行审核时产生的错误。
+ 在尝试对响应输入或输出进行审核时产生的错误。
- `code: string`
@@ -8821,19 +8821,19 @@
- `type: "error"`
- 对象类型,对于成功的审核结果始终为 `error` ,用于审核失败的情况。
+ 对象类型,对于成功的审核结果始终为 `error` (针对审核失败)。
- `"error"`
- `output_text: optional string or null`
- 仅限 SDK 的便捷属性,包含来自所有
- 项的聚合文本输出 `output_text` 中的 `output` 数组(如果存在)。
+ 仅SDK可用的便捷属性,包含所有
+ 项聚合而成的 `output_text` 文本输出 `output` 数组(如有)。
在 Python 和 JavaScript SDK 中受支持。
- `previous_response_id: optional string or null`
- 模型上一个响应的唯一 ID。使用此字段可以
+ 发给模型的上一条响应的唯一 ID。使用它来
创建多轮对话。详细了解
[对话状态](/docs/guides/conversation-state)。不能与 `conversation`.
@@ -8848,23 +8848,23 @@
- `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null`
- 用于在
- 提示中替换变量的可选值映射。替换值可以是字符串,也可以是其他
- 响应输入类型,例如图像或文件。
+ 用于在你的提示中替换变量的可选值映射。
+ 替换值可以是字符串,也可以是其他
+ Response 输入类型,例如图像或文件。
- `string`
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
- 提供给模型的文本输入。
+ 发送给模型的文本输入。
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 提供给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 发送给模型的图像输入。了解有关 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 发送给模型的输入文件。
- `version: optional string or null`
@@ -8872,11 +8872,11 @@
- `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` 及更高版本的模型。
+ 应用于该响应的提示缓存选项。支持 `gpt-5.6` 及更高版本的模型。
- `mode: "implicit" or "explicit"`
@@ -8896,16 +8896,16 @@
已弃用。请使用 `prompt_cache_options.ttl` 代替。
- 提示缓存的保留策略。设置为 `24h` 以启用扩展提示缓存,可使缓存的前缀保持更长时间的活跃状态,最长可达 24 小时。 [了解更多](/docs/guides/prompt-caching#prompt-cache-retention).
- 此字段表示最长保留策略,而
- `prompt_cache_options.ttl` 表示最短缓存生命周期。两个
- 字段相互独立,不会相互影响。
+ 提示缓存的保留策略。设置为 `24h` 以启用扩展的提示缓存,它会将缓存前缀保持更长时间,最长可达 24 小时。 [了解更多](/docs/guides/prompt-caching#prompt-cache-retention).
+ 该字段表示最大保留策略,而
+ `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 的组织默认使用 `24h`.
+ - 已启用 ZDR 的组织默认使用 `in_memory` 当 `prompt_cache_retention` 未指定时。
- `"in_memory"`
@@ -8913,19 +8913,17 @@
- `reasoning: optional Reasoning or null`
- **gpt-5 和 o 系列模型仅**
-
- 的配置选项
+ 用于
[推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续轮次中哪些推理项会被回传给模型。
- 如果省略或设置为 `auto`,则由模型决定上下文模式。
- `gpt-5.6` 模型系列默认为 `all_turns`;早期模型默认为
+ 控制在后续轮次中将哪些推理项渲染回模型。
+ 如果省略或设置为 `auto`,则由模型决定上下文模式。
+ `gpt-5.6` 模型系列默认采用 `all_turns`;较早的模型默认采用
`current_turn`.
- 在响应中返回时,这是该响应所使用的有效推理上下文模式
+ 在响应中返回时,这是生效的推理上下文模式
用于该响应。
- `"auto"`
@@ -8936,13 +8934,13 @@
- `effort: optional ReasoningEffort or null`
- 约束推理模型在推理上的投入程度。当前支持的
- 取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,由 GPT 图像模型支持; `max`.
- 降低推理投入程度可加快响应速度并减少响应中用于推理的 token
- 数量。并非所有推理模型都支持每个
- 取值。请参阅
+ 对推理模型的推理力度进行约束。目前支持
+ 的取值包括 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理力度可以带来更快的响应,并在响应中减少
+ 用于推理的 token 数量。并非所有推理模型都支持每
+ 个取值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解特定模型的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -8960,11 +8958,11 @@
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已弃用:** 使用 `summary` 代替。
+ **已弃用:** 请使用 `summary` 代替。
- 模型执行的推理摘要。可用于
- 调试和理解模型的推理过程。
- 其一 `auto`, `concise`、或 `detailed`.
+ 对模型执行的推理的摘要。这可以
+ 有助于调试和理解模型的推理过程。
+ 其取值为 `auto`, `concise`,或 `detailed`.
- `"auto"`
@@ -8976,7 +8974,7 @@
控制请求的推理执行模式。
- 在响应中返回时,这是有效的执行模式。
+ 在响应中返回时,这是生效的执行模式。
- `string`
@@ -8984,7 +8982,7 @@
控制请求的推理执行模式。
- 在响应中返回时,这是有效的执行模式。
+ 在响应中返回时,这是生效的执行模式。
- `"standard"`
@@ -8992,11 +8990,11 @@
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型执行的推理摘要。可用于
- 调试和理解模型的推理过程。
- 其一 `auto`, `concise`、或 `detailed`.
+ 对模型执行的推理的摘要。这可以
+ 有助于调试和理解模型的推理过程。
+ 其取值为 `auto`, `concise`,或 `detailed`.
- `concise` 支持 `computer-use-preview` 模型以及之后的所有推理模型 `gpt-5`.
+ `concise` 受支持的模型包括 `computer-use-preview` 模型以及之后的所有推理模型 `gpt-5`.
- `"auto"`
@@ -9006,21 +9004,21 @@
- `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).
- `service_tier: optional ServiceTier or null`
指定用于处理请求的处理类型。
- - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则 Project 将使用 '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` 。
- - 如果设置为 'ultrafast',则请求将通过受访问控制的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过它服务的响应将显示 `service_tier=ultrafast`.
- - 未设置时,默认行为为 'auto'。
+ - 如果设置为 '[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` 。
+ - 如果设置为 'ultrafast',则请求将使用访问受控的 Ultrafast Processing 服务层级进行处理。该层级目前可用于 `gpt-5.6-sol`;通过它返回的响应将显示 `service_tier=ultrafast`.
+ - 当未设置时,默认行为为 'auto'。
- 当设置了 `service_tier` 参数时,响应体将包含基于实际用于处理该请求的处理模式得出的 `service_tier` 值。该响应值可能与参数中设置的值不同。
+ 当设置了 `service_tier` 参数时,响应正文将包含基于实际用于处理请求的处理模式所得到的 `service_tier` 值。该响应值可能与参数中设置的值不同。
- `"auto"`
@@ -9038,8 +9036,8 @@
- `status: optional ResponseStatus`
- 响应生成的状态。取值之一为 `completed`, `failed`,
- `in_progress`, `cancelled`, `queued`、或 `incomplete`.
+ 响应生成的状态。取值为 `completed`, `failed`,
+ `in_progress`, `cancelled`, `queued`,或 `incomplete`.
- `"completed"`
@@ -9055,31 +9053,31 @@
- `text: optional ResponseTextConfig`
- 模型文本响应的配置选项。可以是纯
+ 模型文本响应的配置选项。可以是纯文本或
文本或结构化 JSON 数据。了解更多:
- [文本输入与输出](/docs/guides/text)
- - [Structured Outputs](/docs/guides/structured-outputs)
+ - [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 一个对象,用于指定模型必须输出的格式。
+ 用于指定模型必须输出的格式的对象。
- 配置 `{ "type": "json_schema" }` 启用 Structured Outputs,
- 可确保模型匹配你提供的 JSON schema。详情请参阅
- [Structured Outputs 指南](/docs/guides/structured-outputs).
+ 配置 `{ "type": "json_schema" }` 启用结构化输出,
+ 这将确保模型与你提供的 JSON schema 保持一致。更多信息请参阅
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,且无其他附加选项。
+ 默认格式为 `{ "type": "text" }` ,不包含其他选项。
- **不建议用于 gpt-4o 及更新模型:**
+ **不建议用于 gpt-4o 及更新的模型:**
- 设置为 `{ "type": "json_object" }` 可启用旧版 JSON 模式,该模式
- 可确保模型生成的消息是合法 JSON。对于支持的模型,推荐使用 `json_schema`
- 。
+ 设置为 `{ "type": "json_object" }` 会启用旧的 JSON 模式,该模式
+ 可确保模型生成的消息是有效的 JSON。对于支持 `json_schema`
+ 的模型,建议优先使用。
- `ResponseFormatText object { type }`
- 默认的响应格式。用于生成文本响应。
+ 默认响应格式。用于生成文本响应。
- `type: "text"`
@@ -9090,17 +9088,17 @@
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
JSON Schema 响应格式。用于生成结构化 JSON 响应。
- 详细了解 [Structured Outputs](/docs/guides/structured-outputs).
+ 详细了解 [结构化输出](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
- 下划线和短横线,最大长度为 64。
+ 响应格式的名称。必须为 a-z、A-Z、0-9,或包含
+ 下划线和短横线,且最大长度为 64。
- `schema: map[unknown]`
- 响应格式的架构,以 JSON Schema 对象描述。
- 了解如何构建 JSON 架构 [此处](https://json-schema.org/).
+ 响应格式的架构,以 JSON Schema 对象形式描述。
+ 了解如何构建 JSON Schema [此处](https://json-schema.org/).
- `type: "json_schema"`
@@ -9110,23 +9108,23 @@
- `description: optional string`
- 响应格式用途的描述,供模型用于
- 确定如何以该格式进行响应。
+ 响应格式用途的说明,由模型用于
+ 确定如何按该格式进行响应。
- `strict: optional boolean or null`
- 是否在生成输出时启用严格的架构遵循。
- 如果设置为 true,模型将始终遵循在
- 字段中定义的精确架构。仅支持 JSON Schema 的一个子集,当 `schema` 字段中定义的精确架构时。仅支持 JSON Schema 的一个子集,当
- `strict` 是 `true`。要了解更多信息,请阅读 [Structured Outputs
+ 生成输出时是否启用严格的架构遵循。
+ 如果设置为 true,模型将始终遵循中定义的精确架构
+ 字段。仅支持 JSON Schema 的子集,当 `schema` field. Only a subset of JSON Schema is supported when
+ `strict` 时 `true`。如需了解更多信息,请阅读 [结构化输出
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
- JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 使用 `json_schema` 建议用于支持它的模型。请注意,
+ JSON object 响应格式。一种较旧的生成 JSON 响应的方法。
+ 建议对支持它的模型使用 `json_schema` 。请注意,
模型在没有系统或用户消息指示的情况下不会生成 JSON
- 如此操作。
+ 。
- `type: "json_object"`
@@ -9136,9 +9134,9 @@
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将导致
- 更简洁的响应,而较高的值将导致更冗长的响应。
- 当前支持的值包括 `low`, `medium`,由 GPT 图像模型支持; `high`。默认值为
+ 限制模型响应的详细程度。较低的值会生成
+ 更简洁的响应,而较高的值会生成更详细的响应。
+ 当前支持的值包括 `low`, `medium`,和 `high`. 默认值为
`medium`.
- `"low"`
@@ -9149,8 +9147,8 @@
- `top_logprobs: optional number or null`
- 一个介于 0 到 20 之间的整数,指定在每个 token 位置返回的最多可能的
- tokens 数量,每个 token 都带有对应的对数
+ 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最可能的
+ token 的最大数量,每个 token 都有一个对应的对数
概率。在某些情况下,返回的 token 数量可能会少于
所请求的数量。
@@ -9158,10 +9156,10 @@
用于模型响应的截断策略。
- - `auto`:如果此 Response 的输入超出
- 模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断
- 响应以适应上下文窗口。
- - `disabled` (默认):如果输入大小超过模型的上下文窗口
+ - `auto`: 如果此 Response 的输入超过
+ 模型的上下文窗口大小,模型将通过从对话
+ 开头丢弃条目来截断响应以适应上下文窗口。
+ - `disabled` (默认): 如果输入大小将超过模型的上下文窗口
大小,请求将失败并返回 400 错误。
- `"auto"`
@@ -9170,51 +9168,51 @@
- `usage: optional ResponseUsage`
- 表示令牌使用情况详细信息,包括输入令牌、输出令牌、
- 输出令牌的细分以及所使用的令牌总数。
+ 表示 token 使用详情,包括输入 token、输出 token、
+ 输出 token 的细分以及所使用的 token 总数。
- `input_tokens: number`
- 输入令牌的数量。
+ 输入 token 的数量。
- `input_tokens_details: object { cache_write_tokens, cached_tokens }`
- 输入令牌的详细细分。
+ 输入 token 的详细细分。
- `cache_write_tokens: number`
- 已写入缓存的输入令牌数量。
+ 已写入缓存的输入 token 数量。
- `cached_tokens: number`
- 从缓存中检索到的令牌数量。
- [更多关于提示缓存的信息](/docs/guides/prompt-caching).
+ 从缓存中检索到的 token 数量。
+ [详细了解提示词缓存](/docs/guides/prompt-caching).
- `output_tokens: number`
- 输出令牌的数量。
+ 输出 token 的数量。
- `output_tokens_details: object { reasoning_tokens }`
- 输出令牌的详细细分。
+ 输出 token 的详细细分。
- `reasoning_tokens: number`
- 推理令牌的数量。
+ 推理 token 的数量。
- `total_tokens: number`
- 使用的令牌总数。
+ 使用的 token 总数。
- `compute_units: optional number or null`
- 请求的计算单元。目前可用时为 null。
+ 请求的计算单元。当前可用时为 null。
- `user: optional string`
- 此字段正在被 `safety_identifier` 和 `prompt_cache_key`。取代。请使用 `prompt_cache_key` 以保持缓存优化效果。
- 为最终用户提供的一个稳定标识符。
- 通过更好地将相似请求分组来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
+ 此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。请改用 `prompt_cache_key` 以保持缓存优化。
+ 用于标识最终用户的稳定标识符。
+ 通过更好地对相似请求进行分桶来提升缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers).
### 示例
@@ -9240,7 +9238,7 @@ curl https://api.openai.com/v1/responses/$RESPONSE_ID \
"metadata": {
"foo": "string"
},
- "model": "gpt-5.1",
+ "model": "gpt-5.6-sol",
"object": "response",
"output": [
{
@@ -9417,7 +9415,7 @@ curl https://api.openai.com/v1/responses/resp_123 \
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-4o-2024-08-06",
+ "model": "gpt-5.6-sol",
"output": [
{
"type": "message",
diff --git a/docs/zh/api/reference/resources/responses/streaming-events.md b/docs/zh/api/reference/resources/responses/streaming-events.md
index 1d95357..52c374e 100644
--- a/docs/zh/api/reference/resources/responses/streaming-events.md
+++ b/docs/zh/api/reference/resources/responses/streaming-events.md
@@ -1,13 +1,13 @@
# Responses 流式事件
-> 完整文档索引请参阅 [llms.txt](/llms.txt).可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
+> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 获取文档页面的 Markdown 版本。
-当你 [创建一个 Response](https://developers.openai.com/docs/api-reference/responses/create) 时设置
-`stream` 为 `true`,服务器将在 Response 生成时向
-客户端发送 server-sent events。本节包含服务器所发出的
-各类事件。
+当你 [创建 Response](https://developers.openai.com/docs/api-reference/responses/create) 时,设置
+`stream` 为 `true`,服务端会向
+客户端发送服务器发送事件(server-sent events),这些事件在 Response 生成过程中发出。本节列出了服务端发出的事件。
+服务端所发出的事件。
-[详细了解流式响应](https://developers.openai.com/docs/guides/streaming-responses?api-mode=responses).
+[了解更多关于流式 Response 的信息](https://developers.openai.com/docs/guides/streaming-responses?api-mode=responses).
## response.created
@@ -917,14 +917,14 @@ Schema name: `ResponseCreatedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -1730,7 +1730,7 @@ Schema name: `ResponseCreatedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -7094,7 +7094,7 @@ Schema name: `ResponseCreatedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -54307,7 +54307,7 @@ Schema name: `ResponseCreatedEvent`
"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,
@@ -54336,7 +54336,7 @@ Schema name: `ResponseCreatedEvent`
## response.in_progress
-在响应进行过程中发出。
+当响应正在进行时发出。
### Schema
@@ -55242,14 +55242,14 @@ Schema name: `ResponseInProgressEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -56055,7 +56055,7 @@ Schema name: `ResponseInProgressEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -61419,7 +61419,7 @@ Schema name: `ResponseInProgressEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -108632,7 +108632,7 @@ Schema name: `ResponseInProgressEvent`
"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,
@@ -108661,7 +108661,7 @@ Schema name: `ResponseInProgressEvent`
## response.completed
-在模型响应完成时发出。
+当模型响应完成时发出。
### Schema
@@ -109567,14 +109567,14 @@ Schema name: `ResponseCompletedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -110380,7 +110380,7 @@ Schema name: `ResponseCompletedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -115744,7 +115744,7 @@ Schema name: `ResponseCompletedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -162958,7 +162958,7 @@ Schema name: `ResponseCompletedEvent`
"input": [],
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-4o-mini-2024-07-18",
+ "model": "gpt-5.6-sol",
"output": [
{
"id": "msg_123",
@@ -163003,7 +163003,7 @@ Schema name: `ResponseCompletedEvent`
## response.failed
-当响应失败时发出的事件。
+响应失败时发出的事件。
### Schema
@@ -163909,14 +163909,14 @@ Schema name: `ResponseFailedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -164722,7 +164722,7 @@ Schema name: `ResponseFailedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -170086,7 +170086,7 @@ Schema name: `ResponseFailedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -217302,7 +217302,7 @@ Schema name: `ResponseFailedEvent`
"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,
@@ -217326,7 +217326,7 @@ Schema name: `ResponseFailedEvent`
## response.incomplete
-当响应以不完整状态结束时发出的事件。
+当响应以未完成状态结束时触发的事件。
### Schema
@@ -218232,14 +218232,14 @@ Schema name: `ResponseIncompleteEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -219045,7 +219045,7 @@ Schema name: `ResponseIncompleteEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -224409,7 +224409,7 @@ Schema name: `ResponseIncompleteEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -271624,7 +271624,7 @@ Schema name: `ResponseIncompleteEvent`
},
"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,
@@ -271649,7 +271649,7 @@ Schema name: `ResponseIncompleteEvent`
## response.output_item.added
-在添加新的输出项时发出。
+当添加新的输出项时触发。
### Schema
@@ -318657,7 +318657,7 @@ Schema name: `ResponseOutputItemDoneEvent`
## response.content_part.added
-当新增一个内容部分时发出。
+当添加新的内容部分时触发。
### Schema
@@ -319806,7 +319806,7 @@ Schema name: `ResponseContentPartAddedEvent`
## response.content_part.done
-当某个内容部分完成时发出。
+内容部分完成时发出。
### Schema
@@ -320955,7 +320955,7 @@ Schema name: `ResponseContentPartDoneEvent`
## response.output_text.delta
-当出现额外的文本增量时触发。
+在出现额外的文本增量时发出。
### Schema
@@ -321244,7 +321244,7 @@ Schema name: `ResponseTextDeltaEvent`
## response.output_text.done
-在文本内容最终确定时发出。
+在文本内容完成时发出。
### Schema
@@ -321533,7 +321533,7 @@ Schema name: `ResponseTextDoneEvent`
## response.refusal.delta
-当存在部分拒绝文本时发出。
+当存在部分拒绝文本时触发。
### Schema
@@ -321863,7 +321863,7 @@ Schema name: `ResponseRefusalDoneEvent`
## response.function_call_arguments.delta
-当存在部分函数调用参数的增量时发出。
+当存在函数调用参数的部分增量时发出。
### Schema
@@ -322009,7 +322009,7 @@ Schema name: `ResponseFunctionCallArgumentsDeltaEvent`
## response.function_call_arguments.done
-当函数调用参数最终确定时发出。
+在函数调用参数最终确定时发出。
### Schema
@@ -322173,7 +322173,7 @@ Schema name: `ResponseFunctionCallArgumentsDoneEvent`
## response.file_search_call.in_progress
-在发起 文件搜索 调用时发出。
+当发起一次文件搜索调用时发出。
### Schema
@@ -322300,7 +322300,7 @@ Schema name: `ResponseFileSearchCallInProgressEvent`
## response.file_search_call.searching
-在当前正在执行文件搜索时发出。
+当 文件搜索 正在执行搜索时发出。
### Schema
@@ -322427,7 +322427,7 @@ Schema name: `ResponseFileSearchCallSearchingEvent`
## response.file_search_call.completed
-在文件搜索调用完成(已找到结果)时发出。
+当一次文件搜索调用完成(已找到结果)时发出。
### Schema
@@ -322681,7 +322681,7 @@ Schema name: `ResponseWebSearchCallInProgressEvent`
## response.web_search_call.searching
-在 网页搜索 调用执行时发出。
+当 网页搜索 调用正在执行时发出。
### Schema
@@ -322935,7 +322935,7 @@ Schema name: `ResponseWebSearchCallCompletedEvent`
## response.reasoning_summary_part.added
-添加新的推理摘要分块时触发。
+当新增的推理摘要分片被添加时触发。
### Schema
@@ -323160,7 +323160,7 @@ Schema name: `ResponseReasoningSummaryPartAddedEvent`
## response.reasoning_summary_part.done
-当推理摘要部分完成时发出。
+当推理摘要部分完成时触发。
### Schema
@@ -323420,7 +323420,7 @@ Schema name: `ResponseReasoningSummaryPartDoneEvent`
## response.reasoning_summary_text.delta
-当有增量添加到推理摘要文本时发出。
+当向推理摘要文本添加增量时触发。
### Schema
@@ -323585,7 +323585,7 @@ Schema name: `ResponseReasoningSummaryTextDeltaEvent`
## response.reasoning_summary_text.done
-当推理摘要文本完成时发出。
+在推理摘要文本完成时发出。
### Schema
@@ -323750,7 +323750,7 @@ Schema name: `ResponseReasoningSummaryTextDoneEvent`
## response.reasoning_text.delta
-当向推理文本添加增量时发出。
+当向推理文本添加增量时触发。
### Schema
@@ -323915,7 +323915,7 @@ Schema name: `ResponseReasoningTextDeltaEvent`
## response.reasoning_text.done
-在推理文本完成时发出。
+当一段推理文本完成时发出。
### Schema
@@ -324698,7 +324698,7 @@ Schema name: `ResponseImageGenCallPartialImageEvent`
## response.mcp_call_arguments.delta
-当 MCP 工具调用的参数存在增量(部分更新)时发出。
+在 MCP 工具调用的参数有增量(部分更新)时发出。
### Schema
@@ -324990,7 +324990,7 @@ Schema name: `ResponseMCPCallArgumentsDoneEvent`
## response.mcp_call.completed
-在 MCP 工具调用成功完成时发出。
+当 MCP 工具调用成功完成时发出。
### Schema
@@ -325244,7 +325244,7 @@ Schema name: `ResponseMCPCallFailedEvent`
## response.mcp_call.in_progress
-当 MCP 工具调用正在进行时发出。
+在 MCP 工具调用进行中时发出。
### Schema
@@ -325371,7 +325371,7 @@ Schema name: `ResponseMCPCallInProgressEvent`
## response.mcp_list_tools.completed
-当可用 MCP 工具列表被成功检索时发出。
+当可用 MCP 工具列表成功获取后发出。
### Schema
@@ -325498,7 +325498,7 @@ Schema name: `ResponseMCPListToolsCompletedEvent`
## response.mcp_list_tools.failed
-当尝试列出可用 MCP 工具失败时发出。
+当尝试列出可用的 MCP 工具失败时触发。
### Schema
@@ -325625,7 +325625,7 @@ Schema name: `ResponseMCPListToolsFailedEvent`
## response.mcp_list_tools.in_progress
-在系统正在检索可用的 MCP 工具列表时触发。
+在系统正在检索可用 MCP 工具列表时发出。
### Schema
@@ -326279,7 +326279,7 @@ Schema name: `ResponseCodeInterpreterCallCodeDeltaEvent`
## response.code_interpreter_call_code.done
-当代码片段由代码解释器完成时发出。
+当代码片段由代码解释器完成最终处理时触发。
### Schema
@@ -327151,7 +327151,7 @@ Schema name: `ResponseOutputTextAnnotationAddedEvent`
## response.queued
-当响应被排队等待处理时发出。
+当响应被排入队列并等待处理时触发。
### Schema
@@ -328057,14 +328057,14 @@ Schema name: `ResponseQueuedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -328870,7 +328870,7 @@ Schema name: `ResponseQueuedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -334234,7 +334234,7 @@ Schema name: `ResponseQueuedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -381594,7 +381594,7 @@ Schema name: `ResponseCustomToolCallInputDeltaEvent`
## response.custom_tool_call_input.done
-表示自定义工具调用的输入已完成的事件。
+表示自定义工具调用的输入已完整的事件。
### Schema
@@ -381994,7 +381994,7 @@ Schema name: `ResponseAudioDeltaEvent`
## response.audio.done
-在音频响应完成时发出。
+当音频响应完成时发出。
### Schema
@@ -382084,7 +382084,7 @@ Schema name: `ResponseAudioDoneEvent`
## response.audio.transcript.delta
-当存在音频的部分转录文本时发出。
+在出现音频的部分转写时触发。
### Schema
@@ -382193,7 +382193,7 @@ Schema name: `ResponseAudioTranscriptDeltaEvent`
## response.audio.transcript.done
-当完整音频转写完成时发出。
+在完整音频转录完成时发出。
### Schema
@@ -382283,7 +382283,7 @@ Schema name: `ResponseAudioTranscriptDoneEvent`
## response.shell_call_command.added
-表示一条 shell 命令已添加到工具调用的流事件。
+指示某条 shell 命令已添加到工具调用的流事件。
### Schema
@@ -382430,7 +382430,7 @@ Schema name: `ResponseShellCallCommandAddedStreamingEvent`
## response.shell_call_command.delta
-表示 shell 命令被增量更新的流式事件。
+一个流式事件,指示 shell 命令被增量更新。
### Schema
@@ -382743,7 +382743,7 @@ Schema name: `ResponseShellCallCommandDoneStreamingEvent`
## response.shell_call_output_content.delta
-一个流式事件,表示 shell 调用输出被增量添加。
+一个流式事件,用于表示 shell 调用输出被增量添加。
### Schema
diff --git a/docs/zh/api/reference/resources/responses/subresources/input_tokens.md b/docs/zh/api/reference/resources/responses/subresources/input_tokens.md
index 5ab56c7..b4b7976 100644
--- a/docs/zh/api/reference/resources/responses/subresources/input_tokens.md
+++ b/docs/zh/api/reference/resources/responses/subresources/input_tokens.md
@@ -1,21 +1,21 @@
# Input Tokens
-> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 获取文档页面的 Markdown 版本。
+> 有关完整文档索引,请参阅 [llms.txt](/llms.txt). 文档页面的 Markdown 版本可通过在页面 URL 末尾追加 `.md` 来获取。
-## 获取输入 token 数
+## 获取输入 token 计数
**post** `/responses/input_tokens`
返回请求的输入 token 数。
-返回一个对象,其中 `object` 设置为 `response.input_tokens` 以及一个 `input_tokens` 计数。
+返回一个包含 `object` 设置为 `response.input_tokens` 以及一个 `input_tokens` 数量。
-### 请求体参数
+### 正文参数
- `conversation: optional string or ResponseConversationParam or null`
- 此响应所属的对话。此对话中的项目会预置到 `input_items` 此次响应请求之前。
- 此响应完成后,此响应中的输入项目和输出项目会自动添加到此对话中。
+ 此响应所属的对话。此对话中的项目会添加到 `input_items` 此响应请求之前。
+ 此响应完成后,此响应中的输入项目和输出项目会自动添加到该对话中。
- `ConversationID = string`
@@ -35,19 +35,19 @@
- `string`
- 提供给模型的文本输入,等同于带有 `user` 角色的文本输入。
+ 提供给模型的文本输入,等同于使用以下角色的文本输入: `user` 角色。
- `array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more`
- 提供给模型的一个或多个输入项目列表,包含不同的内容类型。
+ 提供给模型的一个或多个输入项目列表,其中包含不同的内容类型。
- `EasyInputMessage object { content, role, phase, type }`
提供给模型的消息输入,其角色表示指令遵循
- 层级。使用 `developer` 或 `system` 角色提供的指令
- 优先于使用 `user` 角色提供的指令。带有
- `assistant` 角色的消息被视为由模型在之前的
- 交互中生成。
+ 层级。使用以下 `developer` 或 `system` 角色提供的指令优先于使用以下角色提供的指令:
+ 优先于使用以下角色提供的指令: `user` 角色。带有以下
+ `assistant` 角色的消息被视为模型在之前
+ 交互中生成的。
- `content: string or ResponseInputMessageContentList`
@@ -60,7 +60,7 @@
- `ResponseInputMessageContentList = array of ResponseInputContent`
- 一个或多个输入项的列表,发送给模型,包含不同的内容
+ 一个由一项或多项输入项组成的列表,传递给模型,包含不同的内容
类型。
- `ResponseInputText object { text, type, prompt_cache_breakpoint }`
@@ -69,7 +69,7 @@
- `text: string`
- 发送给模型的文本输入。
+ 传递给模型的文本输入。
- `type: "input_text"`
@@ -79,7 +79,7 @@
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会按 token 块取整。
+ 标记可复用提示前缀的精确结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -89,7 +89,7 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 传递给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `detail: ImageDetail`
@@ -111,15 +111,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完整的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像的 URL。可以是完全限定的 URL,或在 data URL 中进行 base64 编码的图像。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会按 token 块取整。
+ 标记可复用提示前缀的精确结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -129,7 +129,7 @@
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 传递给模型的文件输入。
- `type: "input_file"`
@@ -139,7 +139,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 的使用量。使用 `low` 进行较低成本的渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 进行更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -149,23 +149,23 @@
- `file_data: optional string`
- 发送给模型的文件内容。
+ 要发送给模型的文件内容。
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string`
- 发送给模型的文件的 URL。
+ 要发送给模型的文件的 URL。
- `filename: optional string`
- 发送给模型的文件的名称。
+ 要发送给模型的文件名。
- `prompt_cache_breakpoint: optional object { mode }`
- 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会按 token 块取整。
+ 标记可复用提示前缀的精确结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -188,9 +188,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
- 对于类似 `gpt-5.3-codex` 及以后的模型,在发送后续请求时,请在所有助手消息上保留并重新发送
- 阶段——删除它可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
+ 对于 `gpt-5.3-codex` 及更高版本,在发送后续请求时,请在所有助手消息中保留并重新发送
+ 阶段;丢弃它可能导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -198,19 +198,19 @@
- `type: optional "message"`
- 消息输入的类型。始终为 `message`.
+ 消息输入的类型,恒为 `message`.
- `"message"`
- `Message object { content, role, status, type }`
提供给模型的消息输入,其角色表示指令遵循
- 层级。使用 `developer` 或 `system` 角色提供的指令
- 优先于使用 `user` 角色的文本输入。
+ 层级。使用以下 `developer` 或 `system` 角色提供的指令优先于使用以下角色提供的指令:
+ 优先于使用以下角色提供的指令: `user` 角色。
- `content: ResponseInputMessageContentList`
- 一个或多个输入项的列表,发送给模型,包含不同的内容
+ 一个由一项或多项输入项组成的列表,传递给模型,包含不同的内容
类型。
- `role: "user" or "system" or "developer"`
@@ -236,13 +236,13 @@
- `type: optional "message"`
- 消息输入的类型。始终设置为 `message`.
+ 消息输入的类型,始终设置为 `message`.
- `"message"`
- `ResponseOutputMessage object { id, content, role, 3 more }`
- 来自模型的输出消息。
+ 模型的一条输出消息。
- `id: string`
@@ -254,7 +254,7 @@
- `ResponseOutputText object { annotations, logprobs, text, type }`
- 来自模型的文本输出。
+ 模型生成的一条文本输出。
- `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }`
@@ -274,7 +274,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_citation"`
@@ -340,7 +340,7 @@
- `FilePath object { file_id, index, type }`
- 文件路径。
+ 文件的路径。
- `file_id: string`
@@ -348,7 +348,7 @@
- `index: number`
- 文件在文件列表中的索引。
+ 该文件在文件列表中的索引。
- `type: "file_path"`
@@ -384,15 +384,15 @@
- `ResponseOutputRefusal object { refusal, type }`
- 模型返回的拒绝信息。
+ 模型的拒绝内容。
- `refusal: string`
- 模型返回的拒绝原因说明。
+ 模型给出的拒绝原因说明。
- `type: "refusal"`
- 拒绝信息的类型。始终为 `refusal`.
+ 拒绝的类型。始终为 `refusal`.
- `"refusal"`
@@ -404,8 +404,8 @@
- `status: "in_progress" or "completed" or "incomplete"`
- 消息输入的状态。可选值为 `in_progress`, `completed`,或
- `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态,取值为 `in_progress`, `completed`,或
+ `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -421,9 +421,9 @@
- `phase: optional "commentary" or "final_answer" or null`
- 将 `assistant` 消息标记为中间注释(`commentary`)或最终答案(`final_answer`).
- 对于类似 `gpt-5.3-codex` 及以后的模型,在发送后续请求时,请在所有助手消息上保留并重新发送
- 阶段——删除它可能会降低性能。不用于用户消息。
+ 将 `assistant` 消息标记为中间评论(`commentary`)或最终答案(`final_answer`).
+ 对于 `gpt-5.3-codex` 及更高版本,在发送后续请求时,请在所有助手消息中保留并重新发送
+ 阶段;丢弃它可能导致性能下降。不适用于用户消息。
- `"commentary"`
@@ -431,8 +431,8 @@
- `FileSearchCall object { id, queries, status, 2 more }`
- 文件搜索 工具调用的结果。参见
- [文件搜索 指南](/docs/guides/tools-file-search) 了解更多信息。
+ 文件搜索 工具调用的结果。详见
+ [文件搜索 指南](/docs/guides/tools-file-search) 。
- `id: string`
@@ -440,11 +440,11 @@
- `queries: array of string`
- 用于搜索文件的查询。
+ 用于搜索文件的查询语句。
- `status: "in_progress" or "searching" or "completed" or 2 more`
- 文件搜索 工具调用的状态。可选值为 `in_progress`,
+ 文件搜索 工具调用的状态。取值之一为 `in_progress`,
`searching`, `incomplete` 或 `failed`,
- `"in_progress"`
@@ -469,11 +469,11 @@
- `attributes: optional map[string or number or boolean] or null`
- 可附加到对象的一组 16 个键值对。可用于
- 以结构化格式存储对象的附加信息,并通过 API 或仪表板
- 查询对象。键为字符串,
- 最大长度为 64 个字符;值为字符串、布尔值或数字,
- 最大长度为 512 个字符。
+ 可附加到对象的 16 组键值对。可用于
+ 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。键为字符串,
+ 最大长度为 64 个字符;值为字符串、
+ 字符串最大长度为 512 个字符,也可以是布尔值或数字。
+ (已合并至上一项)
- `string`
@@ -491,7 +491,7 @@
- `score: optional number`
- 文件的相关性得分,取值范围为 0 到 1。
+ 文件的相关性评分,取值介于 0 到 1 之间。
- `text: optional string`
@@ -499,8 +499,8 @@
- `ComputerCall object { id, call_id, pending_safety_checks, 4 more }`
- 对计算机使用工具的工具调用。请参阅
- [computer use guide](/docs/guides/tools-computer-use) 了解更多信息。
+ 对 computer use 工具的工具调用。参见
+ [computer use 指南](/docs/guides/tools-computer-use) 。
- `id: string`
@@ -508,11 +508,11 @@
- `call_id: string`
- 用于在响应工具调用并提供输出时使用的标识符。
+ 在向工具调用输出响应时使用的标识符。
- `pending_safety_checks: array of object { id, code, message }`
- 计算机调用的待处理安全检查。
+ 计算机调用待处理的安全检查。
- `id: string`
@@ -524,11 +524,11 @@
- `message: optional string or null`
- 待处理安全检查的详细信息。
+ 关于待处理安全检查的详细信息。
- `status: "in_progress" or "completed" or "incomplete"`
- 条目的状态。可取值为 `in_progress`, `completed`,或
+ 该项的状态。可选值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -553,7 +553,7 @@
- `button: "left" or "right" or "wheel" or 2 more`
- 指示点击时按下的是哪个鼠标按键。可取值为 `left`, `right`, `wheel`, `back`,或 `forward`.
+ 指示点击时按下的是哪个鼠标按钮。可选值为 `left`, `right`, `wheel`, `back`,或 `forward`.
- `"left"`
@@ -581,11 +581,11 @@
- `keys: optional array of string or null`
- 点击时同时按下的按键。
+ 点击时按住的按键。
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 一个双击操作。
- `keys: array of string or null`
@@ -593,7 +593,7 @@
- `type: "double_click"`
- 指定事件类型。对于双击动作,此属性始终设置为 `double_click`.
+ 指定事件类型。对于双击操作,此属性始终设置为 `double_click`.
- `"double_click"`
@@ -607,11 +607,11 @@
- `Drag object { path, type, keys }`
- 拖动动作。
+ 一个拖动操作。
- `path: array of object { x, y }`
- 表示拖动动作路径的坐标数组。坐标将以对象数组的形式呈现,例如
+ 表示拖动操作路径的坐标数组。坐标将以对象数组的形式呈现,例如
```
[
@@ -630,7 +630,7 @@
- `type: "drag"`
- 指定事件类型。对于拖动动作,此属性始终设置为 `drag`.
+ 指定事件类型。对于拖动操作,此属性始终设置为 `drag`.
- `"drag"`
@@ -640,25 +640,25 @@
- `Keypress object { keys, type }`
- 模型希望执行的按键操作的集合。
+ 模型希望执行的一组按键操作。
- `keys: array of string`
- 模型请求按下的按键组合。这是一个字符串数组,每个字符串代表一个按键。
+ 模型请求按下的按键组合。这是一个字符串数组,每个字符串表示一个按键。
- `type: "keypress"`
- 指定事件类型。对于按键动作,此属性始终设置为 `keypress`.
+ 指定事件类型。对于按键操作,此属性始终设置为 `keypress`.
- `"keypress"`
- `Move object { type, x, y, keys }`
- 鼠标移动动作。
+ 一个鼠标移动操作。
- `type: "move"`
- 指定事件类型。对于移动动作,此属性始终设置为 `move`.
+ 指定事件类型。对于移动操作,此属性始终设置为 `move`.
- `"move"`
@@ -676,7 +676,7 @@
- `Screenshot object { type }`
- 截图动作。
+ 一个截图操作。
- `type: "screenshot"`
@@ -704,11 +704,11 @@
- `x: number`
- 发生滚动位置的 x 坐标。
+ 发生滚动处的 x 坐标。
- `y: number`
- 发生滚动位置的 y 坐标。
+ 发生滚动处的 y 坐标。
- `keys: optional array of string or null`
@@ -724,7 +724,7 @@
- `type: "type"`
- 指定事件类型。对于输入操作,此属性始终设置为 `type`.
+ 指定事件类型。对于 type 操作,此属性始终设置为 `type`.
- `"type"`
@@ -734,13 +734,13 @@
- `type: "wait"`
- 指定事件类型。对于等待操作,此属性始终设置为 `wait`.
+ 指定事件类型。对于 wait 操作,此属性始终设置为 `wait`.
- `"wait"`
- `actions: optional ComputerActionList`
- 扁平化批量操作,针对 `computer_use`。每个操作包含一个
+ 已展平的批量操作,作用于 `computer_use`。每个操作都包含一个
`type` 判别字段以及操作专属字段。
- `Click object { button, type, x, 2 more }`
@@ -749,23 +749,23 @@
- `DoubleClick object { keys, type, x, y }`
- 双击动作。
+ 一个双击操作。
- `Drag object { path, type, keys }`
- 拖动动作。
+ 一个拖动操作。
- `Keypress object { keys, type }`
- 模型希望执行的按键操作的集合。
+ 模型希望执行的一组按键操作。
- `Move object { type, x, y, keys }`
- 鼠标移动动作。
+ 一个鼠标移动操作。
- `Screenshot object { type }`
- 截图动作。
+ 一个截图操作。
- `Scroll object { scroll_x, scroll_y, type, 3 more }`
@@ -785,7 +785,7 @@
- `call_id: string`
- 产生该输出的计算机工具调用的 ID。
+ 生成该输出的计算机工具调用的 ID。
- `output: ResponseComputerToolCallOutputScreenshot`
@@ -793,14 +793,14 @@
- `type: "computer_screenshot"`
- 指定事件类型。对于计算机截图,此属性始终
- 始终设置为 `computer_screenshot`.
+ 指定事件类型。对于计算机截图,此属性
+ 始终为 `computer_screenshot`.
- `"computer_screenshot"`
- `file_id: optional string`
- 包含截图的已上传文件的标识符。
+ 包含截图的上传文件的标识符。
- `image_url: optional string`
@@ -818,7 +818,7 @@
- `acknowledged_safety_checks: optional array of object { id, code, message } or null`
- 由 API 报告的、已被开发者确认的安全检查。
+ 开发者已确认的 API 报告的安全检查。
- `id: string`
@@ -830,11 +830,11 @@
- `message: optional string or null`
- 待处理安全检查的详细信息。
+ 关于待处理安全检查的详细信息。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 消息输入的状态。可选值为 `in_progress`, `completed`,或 `incomplete`。当输入项通过 API 返回时填充。
+ 消息输入的状态,取值为 `in_progress`, `completed`,或 `incomplete`。之一。当输入项通过 API 返回时填充。
- `"in_progress"`
@@ -844,8 +844,8 @@
- `WebSearchCall object { id, action, status, type }`
- 网页搜索 工具调用的结果。请参阅
- [网页搜索 指南](/docs/guides/tools-web-search) 了解更多信息。
+ 网页搜索 工具调用的结果。参见
+ [网页搜索 指南](/docs/guides/tools-web-search) 。
- `id: string`
@@ -853,7 +853,7 @@
- `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`
- 描述本次 网页搜索 调用中所执行的具体操作的对象。
+ 描述此 网页搜索 调用中执行的具体操作的对象。
包含模型如何使用网页的详细信息(search、open_page、find_in_page)。
- `Search object { type, queries, query, sources }`
@@ -868,11 +868,11 @@
- `queries: optional array of string`
- 搜索查询。
+ 搜索查询列表。
- `query: optional string`
- 搜索查询语句。
+ 搜索查询。
- `sources: optional array of object { type, url }`
@@ -890,7 +890,7 @@
- `OpenPage object { type, url }`
- 操作类型 "open_page" - 从搜索结果中打开特定 URL。
+ 操作类型 "open_page" - 打开搜索结果中的特定 URL。
- `type: "open_page"`
@@ -908,7 +908,7 @@
- `pattern: string`
- 要在页面内搜索的模式或文本。
+ 要在页面中搜索的模式或文本。
- `type: "find_in_page"`
@@ -918,11 +918,11 @@
- `url: string`
- 在其中搜索该模式的页面 URL。
+ 在其中搜索该模式的网页地址。
- `status: "in_progress" or "searching" or "completed" or "failed"`
- 网页搜索 工具调用的状态。
+ 网页搜索工具调用的状态。
- `"in_progress"`
@@ -934,14 +934,14 @@
- `type: "web_search_call"`
- 网页搜索 工具调用的类型。始终为 `web_search_call`.
+ 网页搜索工具调用的类型。始终为 `web_search_call`.
- `"web_search_call"`
- `FunctionCall object { arguments, call_id, name, 5 more }`
- 用于运行函数的工具调用。参见
- [function calling guide](/docs/guides/function-calling) 了解更多信息。
+ 用于运行函数的工具调用。详见
+ [函数调用指南](/docs/guides/function-calling) 。
- `arguments: string`
@@ -949,7 +949,7 @@
- `call_id: string`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `name: string`
@@ -967,7 +967,7 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -979,7 +979,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -991,7 +991,7 @@
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。可取值为 `in_progress`, `completed`,或
+ 该项的状态。可选值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1006,7 +1006,7 @@
- `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的文本、图像或文件输出。
+ 函数工具调用的文本、图片或文件输出。
- `string`
@@ -1014,7 +1014,7 @@
- `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent`
- 函数工具调用的内容输出(文本、图像、文件)数组。
+ 函数工具调用的内容输出(文本、图片、文件)数组。
- `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }`
@@ -1022,7 +1022,7 @@
- `text: string`
- 发送给模型的文本输入。
+ 传递给模型的文本输入。
- `type: "input_text"`
@@ -1032,7 +1032,7 @@
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会按 token 块取整。
+ 标记可复用提示前缀的精确结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1042,7 +1042,7 @@
- `ResponseInputImageContent object { type, detail, file_id, 2 more }`
- 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision)
+ 传递给模型的图像输入。了解 [图像输入](/docs/guides/vision)
- `type: "input_image"`
@@ -1056,15 +1056,15 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `image_url: optional string or null`
- 发送给模型的图像 URL。可以是完整的 URL,也可以是 data URL 中 base64 编码的图像。
+ 发送给模型的图像的 URL。可以是完全限定的 URL,或在 data URL 中进行 base64 编码的图像。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会按 token 块取整。
+ 标记可复用提示前缀的精确结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1074,7 +1074,7 @@
- `ResponseInputFileContent object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 传递给模型的文件输入。
- `type: "input_file"`
@@ -1084,7 +1084,7 @@
- `detail: optional "auto" or "low" or "high"`
- 发送给模型的文件的细节级别。使用 `auto` 可让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 的使用量。使用 `low` 进行较低成本的渲染,或 `high` 以更高质量渲染文件。默认为 `auto`.
+ 发送给模型的文件的细节级别。使用 `auto` 让系统选择细节级别;对于 GPT-5.6 及更高版本的模型, `auto` 使用高质量渲染,这可能会增加输入 token 使用量。使用 `low` 进行更低成本的渲染,或使用 `high` 以更高质量渲染文件。默认为 `auto`.
- `"auto"`
@@ -1098,19 +1098,19 @@
- `file_id: optional string or null`
- 发送给模型的文件 ID。
+ 发送给模型的文件的 ID。
- `file_url: optional string or null`
- 发送给模型的文件的 URL。
+ 要发送给模型的文件的 URL。
- `filename: optional string or null`
- 发送给模型的文件的名称。
+ 要发送给模型的文件名。
- `prompt_cache_breakpoint: optional object { mode } or null`
- 标记可复用提示前缀的精确结束位置。该断点从请求的 `prompt_cache_options.ttl`;继承其 TTL;边界不会按 token 块取整。
+ 标记可复用提示前缀的精确结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。
- `mode: "explicit"`
@@ -1120,27 +1120,27 @@
- `type: "function_call_output"`
- 函数工具调用输出的类型。始终为 `function_call_output`.
+ 函数工具调用输出的类型。总是为 `function_call_output`.
- `"function_call_output"`
- `id: optional string or null`
- 函数工具调用输出的唯一 ID。当通过 API 返回此条目时填充。
+ 函数工具调用输出的唯一 ID。当此条目通过 API 返回时填充。
- `call_id: optional string or null`
- 由模型生成的函数工具调用的唯一 ID。
+ 模型生成的函数工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
- `type: "direct"`
- 调用方类型。始终为 `direct`.
+ 调用方类型。总是为 `direct`.
- `"direct"`
@@ -1148,25 +1148,25 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
- 调用方类型。始终为 `program`.
+ 调用方类型。总是为 `program`.
- `"program"`
- `name: optional string or null`
- 生成此输出的工具的名称。
+ 生成该输出的工具的名称。
- `namespace: optional string or null`
- 生成此输出的工具的命名空间。
+ 生成该输出的工具的命名空间。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。可取值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充。
+ 该项的状态。可选值为 `in_progress`, `completed`,或 `incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -1182,7 +1182,7 @@
- `type: "tool_search_call"`
- 条目类型。始终为 `tool_search_call`.
+ 条目类型。总是为 `tool_search_call`.
- `"tool_search_call"`
@@ -1196,7 +1196,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -1220,7 +1220,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -1228,15 +1228,15 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型。总是为 `function`.
- `"function"`
@@ -1254,7 +1254,7 @@
- `description: optional string or null`
- 函数的描述。供模型用于决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -1262,11 +1262,11 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,始终 `file_search`.
- `"file_search"`
@@ -1280,24 +1280,24 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定的属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于通过定义的比较运算将指定属性键与给定值进行比较的过滤器。
- `key: string`
- 要与该值进行比较的键。
+ 用于与该值进行比较的键。
- `type: "eq" or "ne" or "gt" or 5 more`
指定比较运算符: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
- - `eq`: 等于
- - `ne`: 不等于
- - `gt`: 大于
- - `gte`: 大于或等于
- - `lt`: 小于
- - `lte`: 小于或等于
- - `in`: 在…中
- - `nin`: 不在…中
+ - `eq`:等于
+ - `ne`:不等于
+ - `gt`:大于
+ - `gte`:大于或等于
+ - `lt`:小于
+ - `lte`:小于或等于
+ - `in`:属于
+ - `nin`:不属于
- `"eq"`
@@ -1317,7 +1317,7 @@
- `value: string or number or boolean or array of string or number`
- 要与属性键进行比较的值;支持字符串、数字或布尔类型。
+ 用于与属性键进行比较的值,支持字符串、数字或布尔类型。
- `string`
@@ -1337,11 +1337,11 @@
- `filters: array of ComparisonFilter or unknown`
- 要组合的过滤器数组。条目可以是 `ComparisonFilter` 或 `CompoundFilter`.
+ 用于组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`.
- `ComparisonFilter object { key, type, value }`
- 用于将指定的属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于通过定义的比较运算将指定属性键与给定值进行比较的过滤器。
- `unknown`
@@ -1355,7 +1355,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数字应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -1363,15 +1363,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于在 reciprocal rank fusion 中平衡语义嵌入匹配与稀疏关键词匹配的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ reciprocal ranking fusion 中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ reciprocal ranking fusion 中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -1383,11 +1383,11 @@
- `score_threshold: optional number`
- 文件搜索的评分阈值,介于 0 到 1 之间的数值。越接近 1 的数值越会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值将尝试仅返回最相关的结果,但可能会返回较少的结果。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
@@ -1397,7 +1397,7 @@
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -1429,12 +1429,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型之一: `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -1442,22 +1442,22 @@
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。若省略,默认值为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许网页搜索进行实时互联网访问。如果省略,默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 用于搜索的过滤器。
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样允许。
+ 搜索所允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指引。取值为以下之一: `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` ,默认值。
- `"low"`
@@ -1467,19 +1467,19 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如。 `San Francisco`.
+ 用户所在城市的自由文本输入,例如 `San Francisco`.
- `country: optional string or null`
- 用户所在国家的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如。 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -1487,18 +1487,18 @@
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程模型上下文协议
+ (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 用于标识该 MCP 服务器的标签,在工具调用中使用。
- `type: "mcp"`
@@ -1520,7 +1520,7 @@
- `McpAllowedTools = array of string`
- 允许的工具名称字符串数组
+ 由允许的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
@@ -1528,9 +1528,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -1538,21 +1538,21 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义 MCP
- 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程并在此提供该令牌。
+ 可用于远程 MCP server 的 OAuth 访问令牌,可配合
+ 自定义 MCP server URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程,并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须
- `server_url`, `connector_id`,或 `tunnel_id` 提供其中之一。详细了解
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中一个。详细了解
服务连接器 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 值包括:
+ 当前支持的 `connector_id` 取值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
- Google Drive: `connector_googledrive`
- Microsoft Teams: `connector_microsoftteams`
- Outlook Calendar: `connector_outlookcalendar`
@@ -1577,22 +1577,22 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟,并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 请求头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤器对象
+ 。
- `always: optional object { read_only, tool_names }`
@@ -1600,9 +1600,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -1614,9 +1614,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -1624,7 +1624,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定一个统一的审批策略。可选值之一为 `always` 或
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
`never`。当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -1634,26 +1634,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务端的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ MCP 服务端的 URL。必须提供 `server_url`, `connector_id`,或
`tunnel_id` 之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,以替代直接服务器 URL。其一
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。取值之一
`server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 用于运行 Python 代码以帮助生成对提示词响应的工具。
+ 运行 Python 代码以帮助生成对提示词的回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,或是一个对象,用于
- 指定可供代码使用的已上传文件 ID,以及一个
+ 代码解释器容器。可以是容器 ID,也可以是一个对象,该对象
+ 指定可供你的代码使用的已上传文件 ID,以及一个
可选的 `memory_limit` 设置。
- `string`
@@ -1662,17 +1662,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定要在其上运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的可选已上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -1702,17 +1702,17 @@
- `allowed_domains: array of string`
- 当类型为 `allowlist`.
+ 当 type 为 `allowlist`.
- `type: "allowlist"`
- 仅允许向指定域进行出站网络访问。始终为 `allowlist`.
+ 仅允许对指定域进行出站网络访问。始终为 `allowlist`.
- `"allowlist"`
- `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret`
- 用于允许列表中域的可选域范围密钥。
+ 用于允许列表中域的可选域作用域密钥。
- `domain: string`
@@ -1750,7 +1750,7 @@
- `ImageGeneration object { type, action, background, 9 more }`
- 使用 GPT 图像模型生成图片的工具。
+ 使用 GPT 图像模型生成图像的工具。
- `type: "image_generation"`
@@ -1760,7 +1760,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -1770,11 +1770,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
+ 设置生成图像的背景。取值之一为 `transparent`,
`opaque`,或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ 支持的 GPT 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,此支持为预览功能。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -1784,7 +1784,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的努力程度。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -1792,20 +1792,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于局部重绘的可选遮罩。包含 `image_url`
+ 用于局部重绘的可选蒙版。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 遮罩图像的文件 ID。
+ 蒙版图像的文件 ID。
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型。取值之一为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -1814,7 +1814,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型。取值之一为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -1831,7 +1831,7 @@
- `moderation: optional "auto" or "low"`
- 生成图片的内容审核级别。默认值: `auto`.
+ 生成图像的审核等级。默认值: `auto`.
- `"auto"`
@@ -1839,11 +1839,11 @@
- `output_compression: optional number`
- 输出图片的压缩级别。默认值:100。
+ 输出图像的压缩等级。默认值:100。
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图片的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -1854,11 +1854,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图片数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的局部图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图片的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -1871,13 +1871,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图片的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT image 系列模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,请求的长宽比必须介于 1:3 与 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足该模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图片的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT image 系列模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,请求的长宽比必须介于 1:3 与 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足该模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -1921,17 +1921,17 @@
- `type: "container_auto"`
- 自动为该请求创建一个容器
+ 自动为本次请求创建一个容器
- `"container_auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的可选已上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
- 容器的内存限制。
+ 容器的内存上限。
- `"1g"`
@@ -1967,7 +1967,7 @@
- `version: optional string`
- 可选的技能版本。使用正整数或 'latest'。省略则使用默认值。
+ 可选的技能版本。使用正整数或 'latest'。省略时使用默认值。
- `InlineSkill object { description, name, source, type }`
@@ -2001,7 +2001,7 @@
- `type: "inline"`
- 为该请求定义一个内联技能。
+ 为本次请求定义一个内联技能。
- `"inline"`
@@ -2027,7 +2027,7 @@
- `path: string`
- 包含技能的目录路径。
+ 指向包含该技能的目录的路径。
- `ContainerReference object { container_id, type }`
@@ -2065,7 +2065,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟并通过工具搜索被发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -2095,7 +2095,7 @@
- `syntax: "lark" or "regex"`
- 语法定义的语法格式。可选值为 `lark` 或 `regex`.
+ 语法定义的语法格式。为以下之一 `lark` 或 `regex`.
- `"lark"`
@@ -2117,7 +2117,7 @@
- `name: string`
- 用于工具调用中的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -2141,19 +2141,19 @@
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索被发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具的字符串输出中编码的 JSON 值的 JSON Schema。该字段不描述内容数组输出。
+ 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -2179,7 +2179,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟并通过工具搜索被发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -2197,7 +2197,7 @@
- `ToolSearch object { type, description, execution, parameters }`
- 针对延迟工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
@@ -2211,7 +2211,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -2219,7 +2219,7 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数架构。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
@@ -2227,7 +2227,7 @@
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型之一: `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -2241,7 +2241,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指引。取值为以下之一: `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` ,默认值。
- `"low"`
@@ -2251,25 +2251,25 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如。 `San Francisco`.
+ 用户所在城市的自由文本输入,例如 `San Francisco`.
- `country: optional string or null`
- 用户所在国家的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如。 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -2277,7 +2277,7 @@
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
@@ -2295,7 +2295,7 @@
- `type: "tool_search_output"`
- 条目类型。始终为 `tool_search_output`.
+ 条目类型。总是为 `tool_search_output`.
- `"tool_search_output"`
@@ -2309,7 +2309,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是由客户端执行的。
+ 工具搜索是由服务端还是客户端执行的。
- `"server"`
@@ -2329,17 +2329,17 @@
- `role: "developer"`
- 提供这些额外工具的角色。仅支持 `developer` 。
+ 提供这些额外工具的角色。仅 `developer` 受支持。
- `"developer"`
- `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`
- 在此项中可用的额外工具列表。
+ 此条目中可用的额外工具列表。
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -2347,15 +2347,15 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型。总是为 `function`.
- `"function"`
@@ -2373,7 +2373,7 @@
- `description: optional string or null`
- 函数的描述。供模型用于决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -2381,11 +2381,11 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,始终 `file_search`.
- `"file_search"`
@@ -2399,7 +2399,7 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定的属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于通过定义的比较运算将指定属性键与给定值进行比较的过滤器。
- `CompoundFilter object { filters, type }`
@@ -2407,7 +2407,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数字应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -2415,15 +2415,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于在 reciprocal rank fusion 中平衡语义嵌入匹配与稀疏关键词匹配的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ reciprocal ranking fusion 中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ reciprocal ranking fusion 中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -2435,11 +2435,11 @@
- `score_threshold: optional number`
- 文件搜索的评分阈值,介于 0 到 1 之间的数值。越接近 1 的数值越会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值将尝试仅返回最相关的结果,但可能会返回较少的结果。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
@@ -2449,7 +2449,7 @@
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -2481,12 +2481,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型之一: `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -2494,22 +2494,22 @@
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。若省略,默认值为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许网页搜索进行实时互联网访问。如果省略,默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 用于搜索的过滤器。
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样允许。
+ 搜索所允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指引。取值为以下之一: `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` ,默认值。
- `"low"`
@@ -2519,19 +2519,19 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如。 `San Francisco`.
+ 用户所在城市的自由文本输入,例如 `San Francisco`.
- `country: optional string or null`
- 用户所在国家的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如。 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -2539,18 +2539,18 @@
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程模型上下文协议
+ (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 用于标识该 MCP 服务器的标签,在工具调用中使用。
- `type: "mcp"`
@@ -2572,7 +2572,7 @@
- `McpAllowedTools = array of string`
- 允许的工具名称字符串数组
+ 由允许的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
@@ -2580,9 +2580,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -2590,21 +2590,21 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义 MCP
- 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程并在此提供该令牌。
+ 可用于远程 MCP server 的 OAuth 访问令牌,可配合
+ 自定义 MCP server URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程,并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须
- `server_url`, `connector_id`,或 `tunnel_id` 提供其中之一。详细了解
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中一个。详细了解
服务连接器 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 值包括:
+ 当前支持的 `connector_id` 取值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
- Google Drive: `connector_googledrive`
- Microsoft Teams: `connector_microsoftteams`
- Outlook Calendar: `connector_outlookcalendar`
@@ -2629,22 +2629,22 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟,并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 请求头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤器对象
+ 。
- `always: optional object { read_only, tool_names }`
@@ -2652,9 +2652,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -2666,9 +2666,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -2676,7 +2676,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定一个统一的审批策略。可选值之一为 `always` 或
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
`never`。当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -2686,26 +2686,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务端的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ MCP 服务端的 URL。必须提供 `server_url`, `connector_id`,或
`tunnel_id` 之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,以替代直接服务器 URL。其一
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。取值之一
`server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 用于运行 Python 代码以帮助生成对提示词响应的工具。
+ 运行 Python 代码以帮助生成对提示词的回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,或是一个对象,用于
- 指定可供代码使用的已上传文件 ID,以及一个
+ 代码解释器容器。可以是容器 ID,也可以是一个对象,该对象
+ 指定可供你的代码使用的已上传文件 ID,以及一个
可选的 `memory_limit` 设置。
- `string`
@@ -2714,17 +2714,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定要在其上运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的可选已上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -2770,7 +2770,7 @@
- `ImageGeneration object { type, action, background, 9 more }`
- 使用 GPT 图像模型生成图片的工具。
+ 使用 GPT 图像模型生成图像的工具。
- `type: "image_generation"`
@@ -2780,7 +2780,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -2790,11 +2790,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
+ 设置生成图像的背景。取值之一为 `transparent`,
`opaque`,或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ 支持的 GPT 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,此支持为预览功能。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -2804,7 +2804,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的努力程度。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -2812,20 +2812,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于局部重绘的可选遮罩。包含 `image_url`
+ 用于局部重绘的可选蒙版。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 遮罩图像的文件 ID。
+ 蒙版图像的文件 ID。
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型。取值之一为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -2834,7 +2834,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型。取值之一为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -2851,7 +2851,7 @@
- `moderation: optional "auto" or "low"`
- 生成图片的内容审核级别。默认值: `auto`.
+ 生成图像的审核等级。默认值: `auto`.
- `"auto"`
@@ -2859,11 +2859,11 @@
- `output_compression: optional number`
- 输出图片的压缩级别。默认值:100。
+ 输出图像的压缩等级。默认值:100。
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图片的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -2874,11 +2874,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图片数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的局部图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图片的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -2891,13 +2891,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图片的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT image 系列模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,请求的长宽比必须介于 1:3 与 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足该模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图片的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT image 系列模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,请求的长宽比必须介于 1:3 与 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足该模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -2967,7 +2967,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟并通过工具搜索被发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -2987,7 +2987,7 @@
- `name: string`
- 用于工具调用中的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -3011,19 +3011,19 @@
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索被发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具的字符串输出中编码的 JSON 值的 JSON Schema。该字段不描述内容数组输出。
+ 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -3049,7 +3049,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟并通过工具搜索被发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -3067,7 +3067,7 @@
- `ToolSearch object { type, description, execution, parameters }`
- 针对延迟工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
@@ -3081,7 +3081,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -3089,7 +3089,7 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数架构。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
@@ -3097,7 +3097,7 @@
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型之一: `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -3111,7 +3111,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指引。取值为以下之一: `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` ,默认值。
- `"low"`
@@ -3121,25 +3121,25 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如。 `San Francisco`.
+ 用户所在城市的自由文本输入,例如 `San Francisco`.
- `country: optional string or null`
- 用户所在国家的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如。 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -3147,7 +3147,7 @@
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
@@ -3165,7 +3165,7 @@
- `type: "additional_tools"`
- 条目类型。始终为 `additional_tools`.
+ 条目类型。总是为 `additional_tools`.
- `"additional_tools"`
@@ -3175,9 +3175,9 @@
- `Reasoning object { id, summary, type, 3 more }`
- 用于描述推理模型在生成响应时所使用的思维链
- 过程。请确保在响应中包含这些项。 `input` 发送到 Responses API
- 用于对话后续轮次,前提是你手动
+ 推理模型在生成响应时所使用的思维链的描述
+ 如果你是手动管理对话,请务必将这些项包含在后续轮次的 `input` 对 Responses API 的请求中
+ 。
[管理上下文](/docs/guides/conversation-state).
- `id: string`
@@ -3190,17 +3190,17 @@
- `text: string`
- 模型到目前为止的推理输出摘要。
+ 到目前为止模型推理输出的摘要。
- `type: "summary_text"`
- 对象的类型。始终为 `summary_text`.
+ 对象的类型,始终为 `summary_text`.
- `"summary_text"`
- `type: "reasoning"`
- 对象的类型。始终为 `reasoning`.
+ 对象的类型,始终为 `reasoning`.
- `"reasoning"`
@@ -3210,7 +3210,7 @@
- `text: string`
- 模型生成的推理文本。
+ 来自模型的推理文本。
- `type: "reasoning_text"`
@@ -3220,19 +3220,19 @@
- `encrypted_content: optional string or null`
- 推理项的加密内容。默认情况下会填充
- 针对由 `POST /v1/responses` 和 WebSocket
- `response.create` 请求返回的推理项。
+ 推理条目的加密内容。默认情况下会填充此项
+ ,用于由 `POST /v1/responses` 和 WebSocket
+ `response.create` 请求返回的推理条目。
- 流式传输时,请在后续请求中使用已完成的推理项及其
- `encrypted_content` ,来自 `response.output_item.done` 事件中的
- 。 `encrypted_content` 中的
- `response.output_item.added` 可能不完整。这一点在
- 时尤其重要: `store` 为 `false` ,或使用 Zero Data Retention 时。
+ 流式传输时,使用已完成的推理条目及其
+ `encrypted_content` 中的 `response.output_item.done` 事件
+ 用于后续请求中的 `encrypted_content` 。
+ `response.output_item.added` 可能不完整。这一点在以下情况
+ 下尤其重要: `store` 为 `false` ,或使用 Zero Data Retention 时。
- `status: optional "in_progress" or "completed" or "incomplete"`
- 条目的状态。可取值为 `in_progress`, `completed`,或
+ 该项的状态。可选值为 `in_progress`, `completed`,或
`incomplete`。当通过 API 返回条目时填充。
- `"in_progress"`
@@ -3243,7 +3243,7 @@
- `Compaction object { encrypted_content, type, id }`
- 由 [`v1/responses/compact` API](/docs/api-reference/responses/compact).
+ 由以下接口生成的压缩条目: [`v1/responses/compact` API](/docs/api-reference/responses/compact).
- `encrypted_content: string`
@@ -3251,7 +3251,7 @@
- `type: "compaction"`
- 该项的类型。始终为 `compaction`.
+ 条目的类型。始终为 `compaction`.
- `"compaction"`
@@ -3336,7 +3336,7 @@
- `url: string`
- 代码解释器输出图像的 URL。
+ 代码解释器输出的图像 URL。
- `status: "in_progress" or "completed" or "incomplete" or 2 more`
@@ -3360,7 +3360,7 @@
- `LocalShellCall object { id, action, call_id, 2 more }`
- 在本地 shell 上运行命令的工具调用。
+ 用于在本地 shell 上运行命令的工具调用。
- `id: string`
@@ -3376,17 +3376,17 @@
- `env: map[string]`
- 要为该命令设置的环境变量。
+ 为该命令设置的环境变量。
- `type: "exec"`
- 本地 shell 操作的类型,始终为 `exec`.
+ 本地 shell 操作的类型。始终为 `exec`.
- `"exec"`
- `timeout_ms: optional number or null`
- 该命令的可选超时时间(以毫秒为单位)。
+ 命令的可选超时时间(毫秒)。
- `user: optional string or null`
@@ -3412,7 +3412,7 @@
- `type: "local_shell_call"`
- 本地 shell 调用的类型,始终为 `local_shell_call`.
+ 本地 shell 调用的类型。始终为 `local_shell_call`.
- `"local_shell_call"`
@@ -3430,13 +3430,13 @@
- `type: "local_shell_call_output"`
- 本地 shell 工具调用输出的类型,始终为 `local_shell_call_output`.
+ 本地 shell 工具调用输出的类型。始终为 `local_shell_call_output`.
- `"local_shell_call_output"`
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- 条目的状态。可取值为 `in_progress`, `completed`,或 `incomplete`.
+ 该项的状态。可选值为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3458,11 +3458,11 @@
- `max_output_length: optional number or null`
- 从合并的 stdout 和 stderr 输出中可捕获的最大 UTF-8 字符数。
+ 从合并后的 stdout 和 stderr 输出中捕获的最大 UTF-8 字符数。
- `timeout_ms: optional number or null`
- 允许 shell 命令运行的最大挂钟时间(以毫秒为单位)。
+ 允许 shell 命令运行的最长墙钟时间(毫秒)。
- `call_id: string`
@@ -3470,23 +3470,23 @@
- `type: "shell_call"`
- 该项的类型。始终为 `shell_call`.
+ 条目的类型。始终为 `shell_call`.
- `"shell_call"`
- `id: optional string or null`
- shell 工具调用的唯一 ID。当此条目通过 API 返回时填充。
+ shell 工具调用的唯一 ID。当通过 API 返回此条目时填充该字段。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
- `type: "direct"`
- 调用方类型。始终为 `direct`.
+ 调用方类型。总是为 `direct`.
- `"direct"`
@@ -3494,17 +3494,17 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
- 调用方类型。始终为 `program`.
+ 调用方类型。总是为 `program`.
- `"program"`
- `environment: optional LocalEnvironment or ContainerReference or null`
- 执行 shell 命令的环境。
+ 用于执行 shell 命令的环境。
- `LocalEnvironment object { type, skills }`
@@ -3512,7 +3512,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or null`
- shell 调用的状态。取值之一 `in_progress`, `completed`,或 `incomplete`.
+ shell 调用的状态。取值之一为 `in_progress`, `completed`,或 `incomplete`.
- `"in_progress"`
@@ -3522,7 +3522,7 @@
- `ShellCallOutput object { call_id, output, type, 4 more }`
- 由 shell 工具调用流式输出的输出项。
+ shell 工具调用产生的流式输出项。
- `call_id: string`
@@ -3530,7 +3530,7 @@
- `output: array of ResponseFunctionShellCallOutputContent`
- 捕获的 stdout 和 stderr 输出块及其关联的结果。
+ 捕获到的 stdout 和 stderr 输出块及其对应的结果。
- `outcome: object { type } or object { exit_code, type }`
@@ -3538,7 +3538,7 @@
- `Timeout object { type }`
- 表示 shell 调用超过了其配置的时间限制。
+ 表示该 shell 调用超出了其配置的时间限制。
- `type: "timeout"`
@@ -3562,31 +3562,31 @@
- `stderr: string`
- 为该 shell 调用捕获的 stderr 输出。
+ 此 shell 调用捕获到的 stderr 输出。
- `stdout: string`
- 为该 shell 调用捕获的 stdout 输出。
+ 此 shell 调用捕获到的 stdout 输出。
- `type: "shell_call_output"`
- 该项的类型。始终为 `shell_call_output`.
+ 条目的类型。始终为 `shell_call_output`.
- `"shell_call_output"`
- `id: optional string or null`
- shell 工具调用输出的唯一 ID。当通过 API 返回该输出项时填充。
+ shell 工具调用输出的唯一 ID。当该项通过 API 返回时会被填充。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
- `type: "direct"`
- 调用方类型。始终为 `direct`.
+ 调用方类型。总是为 `direct`.
- `"direct"`
@@ -3594,17 +3594,17 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
- 调用方类型。始终为 `program`.
+ 调用方类型。总是为 `program`.
- `"program"`
- `max_output_length: optional number or null`
- 为该 shell 调用的合并输出所捕获的最大 UTF-8 字符数。
+ 此 shell 调用合并输出所允许捕获的最大 UTF-8 字符数。
- `status: optional "in_progress" or "completed" or "incomplete" or null`
@@ -3618,7 +3618,7 @@
- `ApplyPatchCall object { call_id, operation, status, 3 more }`
- 表示通过 diff 补丁创建、删除或更新文件的请求的工具调用。
+ 表示通过 diff 补丁创建、删除或更新文件的工具调用。
- `call_id: string`
@@ -3634,11 +3634,11 @@
- `diff: string`
- 创建文件时应用的统一差异(unified diff)内容。
+ 创建文件时应用的统一 diff 内容。
- `path: string`
- 相对于工作区根目录的要创建的文件路径。
+ 相对于工作区根目录的要创建文件的路径。
- `type: "create_file"`
@@ -3652,7 +3652,7 @@
- `path: string`
- 相对于工作区根目录的要删除的文件路径。
+ 相对于工作区根目录的要删除文件路径。
- `type: "delete_file"`
@@ -3670,7 +3670,7 @@
- `path: string`
- 相对于工作区根目录的要更新的文件路径。
+ 相对于工作区根目录的要更新文件路径。
- `type: "update_file"`
@@ -3680,7 +3680,7 @@
- `status: "in_progress" or "completed"`
- apply patch 工具调用的状态。其一为 `in_progress` 或 `completed`.
+ apply patch 工具调用的状态。值为以下之一: `in_progress` 或 `completed`.
- `"in_progress"`
@@ -3688,7 +3688,7 @@
- `type: "apply_patch_call"`
- 该项的类型。始终为 `apply_patch_call`.
+ 条目的类型。始终为 `apply_patch_call`.
- `"apply_patch_call"`
@@ -3698,13 +3698,13 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
- `type: "direct"`
- 调用方类型。始终为 `direct`.
+ 调用方类型。总是为 `direct`.
- `"direct"`
@@ -3712,11 +3712,11 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
- 调用方类型。始终为 `program`.
+ 调用方类型。总是为 `program`.
- `"program"`
@@ -3730,7 +3730,7 @@
- `status: "completed" or "failed"`
- apply patch 工具调用输出的状态。其一为 `completed` 或 `failed`.
+ apply patch 工具调用输出的状态。值为以下之一: `completed` 或 `failed`.
- `"completed"`
@@ -3738,7 +3738,7 @@
- `type: "apply_patch_call_output"`
- 该项的类型。始终为 `apply_patch_call_output`.
+ 条目的类型。始终为 `apply_patch_call_output`.
- `"apply_patch_call_output"`
@@ -3748,13 +3748,13 @@
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
- `type: "direct"`
- 调用方类型。始终为 `direct`.
+ 调用方类型。总是为 `direct`.
- `"direct"`
@@ -3762,17 +3762,17 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
- 调用方类型。始终为 `program`.
+ 调用方类型。总是为 `program`.
- `"program"`
- `output: optional string or null`
- 来自 apply patch 工具的可选人类可读日志文本(例如,补丁结果或错误)。
+ 来自 apply patch 工具的可选人类可读日志文本(例如补丁结果或错误)。
- `McpListTools object { id, server_label, tools, 2 more }`
@@ -3780,7 +3780,7 @@
- `id: string`
- 列表的唯一 ID。
+ 该列表的唯一 ID。
- `server_label: string`
@@ -3796,11 +3796,11 @@
- `name: string`
- 工具的名称。
+ 工具名称。
- `annotations: optional unknown or null`
- 有关该工具的附加注释。
+ 关于该工具的附加注释。
- `description: optional string or null`
@@ -3808,13 +3808,13 @@
- `type: "mcp_list_tools"`
- 该项的类型。始终为 `mcp_list_tools`.
+ 条目的类型。始终为 `mcp_list_tools`.
- `"mcp_list_tools"`
- `error: optional string or null`
- 若服务端无法列出工具,则返回错误信息。
+ 如果服务器无法列出工具时的错误消息。
- `McpApprovalRequest object { id, arguments, name, 2 more }`
@@ -3830,7 +3830,7 @@
- `name: string`
- 要运行的工具名称。
+ 要运行的工具的名称。
- `server_label: string`
@@ -3838,7 +3838,7 @@
- `type: "mcp_approval_request"`
- 该项的类型。始终为 `mcp_approval_request`.
+ 条目的类型。始终为 `mcp_approval_request`.
- `"mcp_approval_request"`
@@ -3848,15 +3848,15 @@
- `approval_request_id: string`
- 正在回复的审批请求的 ID。
+ 正在应答的审批请求的 ID。
- `approve: boolean`
- 请求是否已被批准。
+ 请求是否已获批准。
- `type: "mcp_approval_response"`
- 该项的类型。始终为 `mcp_approval_response`.
+ 条目的类型。始终为 `mcp_approval_response`.
- `"mcp_approval_response"`
@@ -3890,18 +3890,18 @@
- `type: "mcp_call"`
- 该项的类型。始终为 `mcp_call`.
+ 条目的类型。始终为 `mcp_call`.
- `"mcp_call"`
- `approval_request_id: optional string or null`
MCP 工具调用审批请求的唯一标识符。
- 在后续的 `mcp_approval_response` 输入中包含此值,以批准或拒绝相应的工具调用。
+ 在后续的 input 中包含此值,以 `mcp_approval_response` 批准或拒绝相应的工具调用。
- `error: optional McpToolCallError or null`
- 工具调用的错误(若有)。
+ 工具调用的错误(如果有)。
- `McpProtocolError object { code, message, type }`
@@ -3937,7 +3937,7 @@
- `status: optional "in_progress" or "completed" or "incomplete" or 2 more`
- 工具调用的状态。值为以下之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
+ 工具调用的状态。取值为以下之一 `in_progress`, `completed`, `incomplete`, `calling`,或 `failed`.
- `"in_progress"`
@@ -3951,15 +3951,15 @@
- `CustomToolCallOutput object { call_id, output, type, 2 more }`
- 由你的代码生成的自定义工具调用输出,正被发送回模型。
+ 你代码中自定义工具调用的输出,将被发送回模型。
- `call_id: string`
- 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
+ 调用 ID,用于将此自定义工具调用输出映射到对应的自定义工具调用。
- `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile`
- 由你的代码生成的自定义工具调用的输出。
+ 你的代码生成的自定义工具调用的输出。
可以是字符串或输出内容列表。
- `StringOutput = string`
@@ -3976,11 +3976,11 @@
- `ResponseInputImage object { detail, type, file_id, 2 more }`
- 发送给模型的图像输入。了解 [图像输入](/docs/guides/vision).
+ 传递给模型的图像输入。了解 [图像输入](/docs/guides/vision).
- `ResponseInputFile object { type, detail, file_data, 4 more }`
- 发送给模型的文件输入。
+ 传递给模型的文件输入。
- `type: "custom_tool_call_output"`
@@ -3990,17 +3990,17 @@
- `id: optional string`
- OpenAI 平台中此自定义工具调用输出的唯一 ID。
+ 在 OpenAI 平台中此自定义工具调用输出的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
- `type: "direct"`
- 调用方类型。始终为 `direct`.
+ 调用方类型。总是为 `direct`.
- `"direct"`
@@ -4008,17 +4008,17 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
- 调用方类型。始终为 `program`.
+ 调用方类型。总是为 `program`.
- `"program"`
- `CustomToolCall object { call_id, input, name, 4 more }`
- 对模型创建的自定义工具的调用。
+ 模型发起的对自定义工具的调用。
- `call_id: string`
@@ -4040,11 +4040,11 @@
- `id: optional string`
- OpenAI 平台中此自定义工具调用的唯一 ID。
+ 在 OpenAI 平台中此自定义工具调用的唯一 ID。
- `caller: optional object { type } or object { caller_id, type } or null`
- 产生此工具调用的执行上下文。
+ 生成此工具调用的执行上下文。
- `Direct object { type }`
@@ -4056,7 +4056,7 @@
- `caller_id: string`
- 产生此工具调用的程序项的调用 ID。
+ 生成此工具调用的程序项的调用 ID。
- `type: "program"`
@@ -4068,11 +4068,11 @@
- `CompactionTrigger object { type, id }`
- 压缩当前上下文。必须作为最后的输入项。
+ 压缩当前上下文。必须是最后一个输入项。
- `type: "compaction_trigger"`
- 该项的类型。始终为 `compaction_trigger`.
+ 条目的类型。始终为 `compaction_trigger`.
- `"compaction_trigger"`
@@ -4082,15 +4082,15 @@
- `ItemReference object { id, type }`
- 用于引用的项的内部标识符。
+ 用于引用某个条目的内部标识符。
- `id: string`
- 要引用的项目 ID。
+ 要引用的项的 ID。
- `type: optional "item_reference" or null`
- 要引用的项目类型。始终为 `item_reference`.
+ 要引用的项的类型。始终为 `item_reference`.
- `"item_reference"`
@@ -4098,11 +4098,11 @@
- `id: string`
- 该程序项的唯一 ID。
+ 此程序项的唯一 ID。
- `call_id: string`
- 该程序项的稳定调用 ID。
+ 程序项的稳定调用 ID。
- `code: string`
@@ -4114,7 +4114,7 @@
- `type: "program"`
- 条目类型。始终为 `program`.
+ 条目类型。总是为 `program`.
- `"program"`
@@ -4122,7 +4122,7 @@
- `id: string`
- 该程序输出项的唯一 ID。
+ 此程序输出项的唯一 ID。
- `call_id: string`
@@ -4130,11 +4130,11 @@
- `result: string`
- 程序项生成的结果。
+ 程序项产生的结果。
- `status: "completed" or "incomplete"`
- 程序输出的终态状态。
+ 程序输出的终止状态。
- `"completed"`
@@ -4142,18 +4142,18 @@
- `type: "program_output"`
- 条目类型。始终为 `program_output`.
+ 条目类型。总是为 `program_output`.
- `"program_output"`
- `instructions: optional string or null`
- 插入到模型上下文中的一条系统(或开发者)消息。
- 与 `previous_response_id`,一起使用时,先前响应中的指令不会延续到下一个响应。这样可以方便地在新响应中替换系统(或开发者)消息。
+ 插入到模型上下文中的系统(或开发者)消息。
+ 当与 `previous_response_id`,配合使用时,上一次响应中的指令将不会延续到下一次响应。这样可以方便地在新响应中替换系统(或开发者)消息。
- `model: optional string or null`
- 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI 提供了众多在能力、性能特征和价格点上各不相同的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
+ 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI 提供多种具有不同能力、性能特征和价格水平的模型。请参阅 [模型指南](/docs/models) 以浏览和比较可用的模型。
- `parallel_tool_calls: optional boolean or null`
@@ -4161,13 +4161,13 @@
- `personality: optional string or "friendly" or "pragmatic"`
- 应用于此请求的模型自有风格预设。省略此参数以使用模型的默认风格。支持的取值可能会随时间扩展。取值长度不得超过 64 个字符。
+ 应用于本次请求的模型自有样式预设。如果省略此参数,则使用模型的默认样式。受支持的值可能会随时间增加。值的长度最多为 64 个字符。
- `string`
- `"friendly" or "pragmatic"`
- 应用于此请求的模型自有风格预设。省略此参数以使用模型的默认风格。支持的取值可能会随时间扩展。取值长度不得超过 64 个字符。
+ 应用于本次请求的模型自有样式预设。如果省略此参数,则使用模型的默认样式。受支持的值可能会随时间增加。值的长度最多为 64 个字符。
- `"friendly"`
@@ -4175,20 +4175,20 @@
- `previous_response_id: optional string or null`
- 上一次模型响应的唯一 ID。使用它来创建多轮对话。了解有关 [对话状态](/docs/guides/conversation-state)。不能与 `conversation`.
+ 上一次模型响应的唯一 ID。使用它可以创建多轮对话。详细了解 [会话状态](/docs/guides/conversation-state)。无法与以下项同时使用 `conversation`.
- `reasoning: optional Reasoning or null`
- **仅适用于 gpt-5 和 o 系列模型** 的配置选项 [推理模型](https://platform.openai.com/docs/guides/reasoning).
+ **仅限 gpt-5 和 o-series 模型** 用于配置 [推理模型](https://platform.openai.com/docs/guides/reasoning).
- `context: optional "auto" or "current_turn" or "all_turns" or null`
- 控制在后续轮次中哪些推理项会被送回模型。
+ 控制在后续轮次中哪些推理项会被渲染回给模型。
若省略或设置为 `auto`,则由模型决定上下文模式。
`gpt-5.6` 模型系列默认为 `all_turns`;更早的模型默认为
`current_turn`.
- 当在响应中返回时,这是该响应使用的有效推理上下文模式。
+ 在响应中返回时,这是该响应实际使用的推理上下文模式。
用于该响应。
- `"auto"`
@@ -4199,13 +4199,13 @@
- `effort: optional ReasoningEffort or null`
- 限制推理模型在推理上的投入程度。当前支持
- 的取值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
- 降低推理投入程度可以让响应更快,并减少响应中推理所使用的 token。并非所有推理模型都支持每个
- 取值。请参阅
- 中的
+ 约束推理模型在推理上的投入程度。目前支持的值
+ 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`.
+ 降低推理投入程度可以带来更快的响应,并在响应中减少
+ 用于推理的 token 数量。并非所有推理模型都支持每个
+ 值。请参阅
[推理指南](https://platform.openai.com/docs/guides/reasoning)
- 了解具体模型的支持情况。
+ 以了解特定模型的支持情况。
- `"none"`
@@ -4223,10 +4223,10 @@
- `generate_summary: optional "auto" or "concise" or "detailed" or null`
- **已弃用:** 使用 `summary` 改用。
+ **已弃用:** 使用 `summary` 。
- 模型执行的推理摘要。可以使用
- 用于调试和理解模型的推理过程。
+ 模型所执行推理的摘要。这可用于
+ 调试和理解模型的推理过程。
以下之一 `auto`, `concise`,或 `detailed`.
- `"auto"`
@@ -4255,8 +4255,8 @@
- `summary: optional "auto" or "concise" or "detailed" or null`
- 模型执行的推理摘要。可以使用
- 用于调试和理解模型的推理过程。
+ 模型所执行推理的摘要。这可用于
+ 调试和理解模型的推理过程。
以下之一 `auto`, `concise`,或 `detailed`.
`concise` 支持 `computer-use-preview` 模型以及之后的所有推理模型 `gpt-5`.
@@ -4269,27 +4269,27 @@
- `text: optional object { format, verbosity } or null`
- 模型文本响应的配置选项。可以是纯文本
- text 或结构化 JSON 数据。了解更多信息:
+ 模型文本响应的配置选项。可以是纯
+ 文本或结构化 JSON 数据。了解更多:
- - [文本输入和输出](/docs/guides/text)
+ - [文本输入与输出](/docs/guides/text)
- [结构化输出](/docs/guides/structured-outputs)
- `format: optional ResponseFormatTextConfig`
- 用于指定模型必须输出的格式的对象。
+ 指定模型必须输出格式的对象。
- 配置 `{ "type": "json_schema" }` 可启用 Structured Outputs,
- 它可确保模型的输出与你提供的 JSON schema 一致。详细了解请参阅
- [Structured Outputs 指南](/docs/guides/structured-outputs).
+ 配置 `{ "type": "json_schema" }` 可启用结构化输出,
+ 从而确保模型匹配你提供的 JSON schema。更多信息请参阅
+ [结构化输出指南](/docs/guides/structured-outputs).
- 默认格式为 `{ "type": "text" }` ,不包含任何额外选项。
+ 默认格式为 `{ "type": "text" }` 且不包含其他选项。
- **不建议用于 gpt-4o 及更新的模型:**
+ **不推荐用于 gpt-4o 及更新的模型:**
- 设置为 `{ "type": "json_object" }` 会启用旧版 JSON 模式,它
- 确保模型生成的消息是有效的 JSON。对于支持 `json_schema`
- 的模型,建议使用后者。
+ 设置为 `{ "type": "json_object" }` 会启用旧版 JSON 模式,该模式
+ 可确保模型生成的消息是合法的 JSON。对于支持的模型,推荐使用 `json_schema`
+ 。
- `ResponseFormatText object { type }`
@@ -4297,61 +4297,61 @@
- `type: "text"`
- 正在定义的响应格式的类型。始终为 `text`.
+ 所定义的响应格式的类型。始终为 `text`.
- `"text"`
- `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }`
JSON Schema 响应格式。用于生成结构化的 JSON 响应。
- 了解更多关于 [结构化输出](/docs/guides/structured-outputs).
+ 详细了解 [结构化输出](/docs/guides/structured-outputs).
- `name: string`
- 响应格式的名称。必须为 a-z、A-Z、0-9,或者包含
+ 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含
下划线和短横线,最大长度为 64。
- `schema: map[unknown]`
- 响应格式的 schema,以 JSON Schema 对象形式描述。
- 了解如何构建 JSON schema [请参考此处](https://json-schema.org/).
+ 响应格式的架构,以 JSON Schema 对象描述。
+ 了解如何构建 JSON Schema [请参考此处](https://json-schema.org/).
- `type: "json_schema"`
- 正在定义的响应格式的类型。始终为 `json_schema`.
+ 所定义的响应格式的类型。始终为 `json_schema`.
- `"json_schema"`
- `description: optional string`
- 响应格式用途的描述,供模型用于
- 确定如何以该格式进行响应。
+ 响应格式用途的描述,供模型用来
+ 决定如何按该格式进行响应。
- `strict: optional boolean or null`
是否在生成输出时启用严格的 schema 遵循。
- 若设置为 true,模型将始终遵循在
- 字段中定义的精确 schema。仅在 `schema` 为 true 时支持 JSON Schema 的一个子集
- `strict` 为 `true`。了解更多信息,请阅读 [结构化输出
+ 如果设置为 true,模型将始终遵循
+ 字段中定义的 `schema` 确切 schema。当
+ `strict` 为 `true`。要了解更多信息,请阅读 [结构化输出
指南](/docs/guides/structured-outputs).
- `ResponseFormatJSONObject object { type }`
JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。
- 建议对支持 `json_schema` 的模型使用。请注意,如果没有系统或用户消息指示,
- 模型不会生成 JSON。
- 指示它这样做。
+ 使用 `json_schema` 对支持它的模型是推荐的。请注意,
+ 模型在缺少系统或用户消息指示的情况下不会生成 JSON,
+ 这样做。
- `type: "json_object"`
- 正在定义的响应格式的类型。始终为 `json_object`.
+ 所定义的响应格式的类型。始终为 `json_object`.
- `"json_object"`
- `verbosity: optional "low" or "medium" or "high" or null`
- 约束模型响应的详细程度。较低的值将生成
- 更简洁的响应,而较高的值将生成更详细的响应。
+ 限制模型响应的冗余程度。较低的值会产生更简洁的响应,
+ 而较高的值会产生更冗长的响应。
当前支持的值包括 `low`, `medium`,和 `high`。默认值为
`medium`.
@@ -4363,18 +4363,18 @@
- `tool_choice: optional ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more or null`
- 控制模型应使用哪个工具(如果有)。
+ 控制模型应使用的工具(如果有)。
- `ToolChoiceOptions = "none" or "auto" or "required"`
控制模型调用哪个工具(如果有)。
- `none` 表示模型不会调用任何工具,而是生成一条消息。
+ `none` 意味着模型将不调用任何工具,而是生成一条消息。
- `auto` 表示模型可以在生成消息和调用一个或
+ `auto` 意味着模型可以在生成消息或调用一个或
多个工具之间选择。
- `required` 表示模型必须调用一个或多个工具。
+ `required` 意味着模型必须调用一个或多个工具。
- `"none"`
@@ -4384,11 +4384,11 @@
- `ToolChoiceAllowed object { mode, tools, type }`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的一组。
- `mode: "auto" or "required"`
- 将模型可用的工具限制为一组预定义工具。
+ 将模型可用的工具限制为预定义的一组。
`auto` 允许模型从允许的工具中选择并生成一条
消息。
@@ -4401,9 +4401,9 @@
- `tools: array of map[unknown]`
- 允许模型调用的工具定义列表。
+ 模型应被允许调用的工具定义列表。
- 对于 Responses API,工具定义列表可能如下:
+ 对于 Responses API,工具定义列表可能如下所示:
```json
[
@@ -4415,21 +4415,21 @@
- `type: "allowed_tools"`
- 允许的工具配置类型。始终为 `allowed_tools`.
+ 允许的工具配置类型。始终 `allowed_tools`.
- `"allowed_tools"`
- `ToolChoiceTypes object { type }`
指示模型应使用内置工具来生成响应。
- [了解有关内置工具的更多信息](/docs/guides/tools).
+ [了解更多关于内置工具的信息](/docs/guides/tools).
- `type: "file_search" or "web_search_preview" or "computer" or 5 more`
- 模型应使用的托管工具的类型。了解有关
+ 模型应使用的 托管工具 类型。了解更多关于
[内置工具](/docs/guides/tools).
- 允许的值包括:
+ 允许的值为:
- `file_search`
- `web_search_preview`
@@ -4457,7 +4457,7 @@
- `ToolChoiceFunction object { name, type }`
- 使用此选项可强制模型调用特定的函数。
+ 使用此选项强制模型调用特定函数。
- `name: string`
@@ -4471,7 +4471,7 @@
- `ToolChoiceMcp object { server_label, type, name }`
- 使用此选项可强制模型调用远程 MCP 服务器上的特定工具。
+ 使用此选项强制模型调用远程 MCP 服务器上的特定工具。
- `server_label: string`
@@ -4489,7 +4489,7 @@
- `ToolChoiceCustom object { name, type }`
- 使用此选项可强制模型调用特定的自定义工具。
+ 使用此选项强制模型调用特定的自定义工具。
- `name: string`
@@ -4505,7 +4505,7 @@
- `type: "programmatic_tool_calling"`
- 要调用的工具。始终为 `programmatic_tool_calling`.
+ 要调用的工具。始终 `programmatic_tool_calling`.
- `"programmatic_tool_calling"`
@@ -4515,7 +4515,7 @@
- `type: "apply_patch"`
- 要调用的工具。始终为 `apply_patch`.
+ 要调用的工具。始终 `apply_patch`.
- `"apply_patch"`
@@ -4525,7 +4525,7 @@
- `type: "shell"`
- 要调用的工具。始终为 `shell`.
+ 要调用的工具。始终 `shell`.
- `"shell"`
@@ -4535,7 +4535,7 @@
- `Function object { name, parameters, strict, 5 more }`
- 在你自己代码中定义一个可供模型选择调用的函数。详细了解 [函数调用](https://platform.openai.com/docs/guides/function-calling).
+ 定义你自己代码中可供模型选择调用的函数。了解更多关于 [函数调用](https://platform.openai.com/docs/guides/function-calling).
- `name: string`
@@ -4543,15 +4543,15 @@
- `parameters: map[unknown] or null`
- 描述该函数参数的 JSON schema 对象。
+ 描述函数参数的 JSON schema 对象。
- `strict: boolean or null`
- 是否对此函数工具强制执行严格参数校验。
+ 是否对此函数工具强制执行严格的参数校验。
- `type: "function"`
- 函数工具的类型。始终为 `function`.
+ 函数工具的类型。总是为 `function`.
- `"function"`
@@ -4569,7 +4569,7 @@
- `description: optional string or null`
- 函数的描述。供模型用于决定是否调用该函数。
+ 函数的描述,供模型用于判断是否调用该函数。
- `output_schema: optional map[unknown] or null`
@@ -4577,11 +4577,11 @@
- `FileSearch object { type, vector_store_ids, filters, 2 more }`
- 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索工具](https://platform.openai.com/docs/guides/tools-file-search).
+ 用于从已上传文件中搜索相关内容的工具。详细了解 [文件搜索 工具](https://platform.openai.com/docs/guides/tools-file-search).
- `type: "file_search"`
- 文件搜索工具的类型。始终为 `file_search`.
+ 文件搜索 工具的类型,始终 `file_search`.
- `"file_search"`
@@ -4595,7 +4595,7 @@
- `ComparisonFilter object { key, type, value }`
- 用于将指定的属性键与给定值按定义的比较运算进行比较的过滤器。
+ 用于通过定义的比较运算将指定属性键与给定值进行比较的过滤器。
- `CompoundFilter object { filters, type }`
@@ -4603,7 +4603,7 @@
- `max_num_results: optional number`
- 要返回的最大结果数。该数值应介于 1 到 50 之间(含两端)。
+ 要返回的最大结果数。该数字应介于 1 到 50 之间(含端点)。
- `ranking_options: optional object { hybrid_search, ranker, score_threshold }`
@@ -4611,15 +4611,15 @@
- `hybrid_search: optional object { embedding_weight, text_weight }`
- 在启用混合搜索时,用于控制倒数排名融合在语义嵌入匹配与稀疏关键词匹配之间平衡的权重。
+ 在启用混合搜索时,用于在 reciprocal rank fusion 中平衡语义嵌入匹配与稀疏关键词匹配的权重。
- `embedding_weight: number`
- 倒数排名融合中嵌入的权重。
+ reciprocal ranking fusion 中嵌入的权重。
- `text_weight: number`
- 倒数排名融合中文本的权重。
+ reciprocal ranking fusion 中文本的权重。
- `ranker: optional "auto" or "default-2024-11-15"`
@@ -4631,11 +4631,11 @@
- `score_threshold: optional number`
- 文件搜索的评分阈值,介于 0 到 1 之间的数值。越接近 1 的数值越会尝试仅返回最相关的结果,但返回的结果数量可能会更少。
+ 文件搜索的分数阈值,介于 0 到 1 之间的数字。越接近 1 的数值将尝试仅返回最相关的结果,但可能会返回较少的结果。
- `Computer object { type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `type: "computer"`
@@ -4645,7 +4645,7 @@
- `ComputerUsePreview object { display_height, display_width, environment, type }`
- 用于控制虚拟计算机的工具。详细了解 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
+ 用于控制虚拟计算机的工具。了解更多关于 [computer 工具](https://platform.openai.com/docs/guides/tools-computer-use).
- `display_height: number`
@@ -4677,12 +4677,12 @@
- `WebSearch object { type, external_web_access, filters, 2 more }`
- 在互联网上搜索与提示相关的来源。详细了解
+ 在互联网上搜索与提示相关的来源。了解更多关于
[网页搜索工具](/docs/guides/tools-web-search).
- `type: "web_search" or "web_search_2025_08_26"`
- 网页搜索工具的类型。取值为 `web_search` 或 `web_search_2025_08_26`.
+ 网页搜索工具的类型之一: `web_search` 或 `web_search_2025_08_26`.
- `"web_search"`
@@ -4690,22 +4690,22 @@
- `external_web_access: optional boolean`
- 允许网页搜索实时访问互联网。若省略,默认值为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
+ 允许网页搜索进行实时互联网访问。如果省略,默认为 true。当为 false 时,网页搜索工具以离线/仅缓存模式运行,不会获取新的外部内容。
- `filters: optional object { allowed_domains } or null`
- 搜索的筛选条件。
+ 用于搜索的过滤器。
- `allowed_domains: optional array of string or null`
- 搜索允许的域名。如果未提供,则允许所有域名。
- 所提供域名的子域名也同样允许。
+ 搜索所允许的域名。如果未提供,则允许所有域名。
+ 所提供域名的子域名也同样被允许。
示例: `["pubmed.ncbi.nlm.nih.gov"]`
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指引。取值为以下之一: `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` ,默认值。
- `"low"`
@@ -4715,19 +4715,19 @@
- `user_location: optional object { city, country, region, 2 more } or null`
- 用户的近似位置。
+ 用户的大致位置。
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如。 `San Francisco`.
+ 用户所在城市的自由文本输入,例如 `San Francisco`.
- `country: optional string or null`
- 用户所在国家的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如。 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -4735,18 +4735,18 @@
- `type: optional "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `Mcp object { server_label, type, allowed_callers, 9 more }`
- 通过远程 Model Context Protocol
- (MCP) 服务器为模型提供对其他工具的访问。 [详细了解 MCP](/docs/guides/tools-remote-mcp).
+ 通过远程模型上下文协议
+ (MCP) 服务器为模型提供对其他工具的访问。 [了解更多关于 MCP 的信息](/docs/guides/tools-remote-mcp).
- `server_label: string`
- 此 MCP 服务器的标签,用于在工具调用中识别它。
+ 用于标识该 MCP 服务器的标签,在工具调用中使用。
- `type: "mcp"`
@@ -4768,7 +4768,7 @@
- `McpAllowedTools = array of string`
- 允许的工具名称字符串数组
+ 由允许的工具名称组成的字符串数组
- `McpToolFilter object { read_only, tool_names }`
@@ -4776,9 +4776,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -4786,21 +4786,21 @@
- `authorization: optional string`
- 可用于远程 MCP 服务器的 OAuth 访问令牌,可配合自定义 MCP
- 服务器 URL 或服务连接器使用。你的应用
- 必须处理 OAuth 授权流程并在此提供该令牌。
+ 可用于远程 MCP server 的 OAuth 访问令牌,可配合
+ 自定义 MCP server URL 或服务连接器一起使用。你的应用
+ 必须处理 OAuth 授权流程,并在此处提供该令牌。
- `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more`
- 服务连接器的标识符,例如 ChatGPT 中可用的连接器。必须
- `server_url`, `connector_id`,或 `tunnel_id` 提供其中之一。详细了解
+ 服务连接器的标识符,例如 ChatGPT 中提供的那些。
+ `server_url`, `connector_id`,或 `tunnel_id` 必须提供其中一个。详细了解
服务连接器 [请参考此处](/docs/guides/tools-remote-mcp#connectors).
- 当前支持的 `connector_id` 值包括:
+ 当前支持的 `connector_id` 取值包括:
- - Dropbox: `connector_dropbox`
- - Gmail: `connector_gmail`
- - Google Calendar: `connector_googlecalendar`
+ - Dropbox: `connector_dropbox`
+ - Gmail: `connector_gmail`
+ - Google Calendar: `connector_googlecalendar`
- Google Drive: `connector_googledrive`
- Microsoft Teams: `connector_microsoftteams`
- Outlook Calendar: `connector_outlookcalendar`
@@ -4825,22 +4825,22 @@
- `defer_loading: optional boolean`
- 此 MCP 工具是否被延迟,并通过工具搜索发现。
+ 该 MCP 工具是否被延迟,并通过工具搜索被发现。
- `headers: optional map[string] or null`
- 发送到 MCP 服务器的可选 HTTP 标头。用于身份验证
+ 发送到 MCP 服务端的可选 HTTP 请求头。用于身份验证
或其他用途。
- `require_approval: optional object { always, never } or "always" or "never" or null`
- 指定 MCP 服务器中哪些工具需要审批。
+ 指定 MCP 服务端的哪些工具需要审批。
- `McpToolApprovalFilter object { always, never }`
- 指定 MCP 服务器中哪些工具需要审批。可以是
- `always`, `never`,或与工具关联的筛选器对象
- 需要审批的工具。
+ 指定 MCP 服务端的哪些工具需要审批。可以是
+ `always`, `never`,或与需要审批的工具关联的过滤器对象
+ 。
- `always: optional object { read_only, tool_names }`
@@ -4848,9 +4848,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -4862,9 +4862,9 @@
- `read_only: optional boolean`
- 指示工具是否会修改数据或为只读。如果某个
- MCP 服务器被 [标注为 `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
- ,它就会匹配此过滤器。
+ 指示某个工具是否修改数据或为只读。如果某个
+ MCP server 被 [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+ 标记,则它将匹配此过滤条件。
- `tool_names: optional array of string`
@@ -4872,7 +4872,7 @@
- `McpToolApprovalSetting = "always" or "never"`
- 为所有工具指定一个统一的审批策略。可选值之一为 `always` 或
+ 为所有工具指定统一的审批策略。可选值为 `always` 或
`never`。当设置为 `always`,时,所有工具都需要审批。当
设置为 `never`,时,所有工具都不需要审批。
@@ -4882,26 +4882,26 @@
- `server_description: optional string`
- MCP 服务器的可选描述,用于提供更多上下文。
+ MCP 服务端的可选描述,用于提供更多上下文。
- `server_url: optional string`
- MCP 服务器的 URL。必须提供 `server_url`, `connector_id`,或
+ MCP 服务端的 URL。必须提供 `server_url`, `connector_id`,或
`tunnel_id` 之一。
- `tunnel_id: optional string`
- 要使用的 Secure MCP Tunnel ID,以替代直接服务器 URL。其一
+ 用于替代直接服务器 URL 的 Secure MCP Tunnel ID。取值之一
`server_url`, `connector_id`,或 `tunnel_id` 之一。
- `CodeInterpreter object { container, type, allowed_callers }`
- 用于运行 Python 代码以帮助生成对提示词响应的工具。
+ 运行 Python 代码以帮助生成对提示词的回复的工具。
- `container: string or object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器。可以是容器 ID,或是一个对象,用于
- 指定可供代码使用的已上传文件 ID,以及一个
+ 代码解释器容器。可以是容器 ID,也可以是一个对象,该对象
+ 指定可供你的代码使用的已上传文件 ID,以及一个
可选的 `memory_limit` 设置。
- `string`
@@ -4910,17 +4910,17 @@
- `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }`
- 代码解释器容器的配置。可选择指定要在其上运行代码的文件 ID。
+ 代码解释器容器的配置。可选择指定要运行代码的文件 ID。
- `type: "auto"`
- 始终为 `auto`.
+ 始终 `auto`.
- `"auto"`
- `file_ids: optional array of string`
- 可供代码使用的已上传文件的可选列表。
+ 可供你的代码使用的可选已上传文件列表。
- `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
@@ -4966,7 +4966,7 @@
- `ImageGeneration object { type, action, background, 9 more }`
- 使用 GPT 图像模型生成图片的工具。
+ 使用 GPT 图像模型生成图像的工具。
- `type: "image_generation"`
@@ -4976,7 +4976,7 @@
- `action: optional "generate" or "edit" or "auto"`
- 是生成新图像还是编辑现有图像。默认值: `auto`.
+ 生成新图像还是编辑现有图像。默认值: `auto`.
- `"generate"`
@@ -4986,11 +4986,11 @@
- `background: optional "transparent" or "opaque" or "auto"`
- 设置生成图像的背景。可选值为 `transparent`,
+ 设置生成图像的背景。取值之一为 `transparent`,
`opaque`,或 `auto`。透明背景适用于
- 支持的 GPT Image 模型。对于 `gpt-image-2` 和
- `gpt-image-2-2026-04-21`,该支持处于预览阶段。当使用
- `transparent`,时,将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
+ 支持的 GPT 图像模型。对于 `gpt-image-2` 和
+ `gpt-image-2-2026-04-21`,此支持为预览功能。当使用
+ `transparent`,时,请将输出格式设置为 `png` 或 `webp`。默认值: `auto`.
- `"transparent"`
@@ -5000,7 +5000,7 @@
- `input_fidelity: optional "high" or "low" or null`
- 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的精力。此参数仅支持 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
+ 控制模型在匹配输入图像的风格和特征(尤其是面部特征)时所投入的努力程度。此参数仅在 `gpt-image-1` 和 `gpt-image-1.5` 及更高版本的模型中受支持,不支持 `gpt-image-1-mini`。支持 `high` 和 `low`。默认为 `low`.
- `"high"`
@@ -5008,20 +5008,20 @@
- `input_image_mask: optional object { file_id, image_url }`
- 用于局部重绘的可选遮罩。包含 `image_url`
+ 用于局部重绘的可选蒙版。包含 `image_url`
(字符串,可选)和 `file_id` (字符串,可选)。
- `file_id: optional string`
- 遮罩图像的文件 ID。
+ 蒙版图像的文件 ID。
- `image_url: optional string`
- Base64 编码的遮罩图像。
+ Base64 编码的蒙版图像。
- `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型。取值之一为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -5030,7 +5030,7 @@
- `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5" or 2 more`
- 要使用的图像生成模型。可选值为 `gpt-image-1`,
+ 要使用的图像生成模型。取值之一为 `gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
`gpt-image-2-2026-04-21`,或 `chatgpt-image-latest`。默认值:
`gpt-image-1`.
@@ -5047,7 +5047,7 @@
- `moderation: optional "auto" or "low"`
- 生成图片的内容审核级别。默认值: `auto`.
+ 生成图像的审核等级。默认值: `auto`.
- `"auto"`
@@ -5055,11 +5055,11 @@
- `output_compression: optional number`
- 输出图片的压缩级别。默认值:100。
+ 输出图像的压缩等级。默认值:100。
- `output_format: optional "png" or "webp" or "jpeg"`
- 生成图片的输出格式。可选值为 `png`, `webp`,或
+ 生成图像的输出格式。可选值为 `png`, `webp`,或
`jpeg`。默认值: `png`.
- `"png"`
@@ -5070,11 +5070,11 @@
- `partial_images: optional number`
- 在流式模式下生成的部分图片数量,取值范围为 0(默认值)到 3。
+ 在流式模式下要生成的局部图像数量,取值范围为 0(默认值)到 3。
- `quality: optional "low" or "medium" or "high" or "auto"`
- 生成图片的质量。可选值为 `low`, `medium`, `high`,
+ 生成图像的质量。可选值为 `low`, `medium`, `high`,
或 `auto`。默认值: `auto`.
- `"low"`
@@ -5087,13 +5087,13 @@
- `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图片的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT image 系列模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,请求的长宽比必须介于 1:3 与 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足该模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `string`
- `"1024x1024" or "1024x1536" or "1536x1024" or "auto"`
- 生成图片的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以字符串形式指定任意分辨率,例如 `WIDTHxHEIGHT` 字符串,例如 `1536x864`。宽度和高度必须都能被 16 整除,且请求的宽高比必须在 1:3 到 3:1 之间。超过 `2560x1440` 的分辨率为实验性支持,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足模型当前的像素和边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT image 系列模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`. 对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
+ 生成图像的尺寸。对于 `gpt-image-2` 和 `gpt-image-2-2026-04-21`,支持以 `WIDTHxHEIGHT` 字符串形式指定任意分辨率,例如 `1536x864`。宽度和高度必须都能被 16 整除,请求的长宽比必须介于 1:3 与 3:1 之间。高于 `2560x1440` 的分辨率为实验性,最大支持的分辨率为 `3840x2160`。请求的尺寸还必须满足该模型当前的像素与边长限制。标准尺寸 `1024x1024`, `1536x1024`,和 `1024x1536` 由 GPT 图像模型支持; `auto` 由支持自动尺寸的模型支持。对于 `dall-e-2`,请使用以下值之一: `256x256`, `512x512`,或 `1024x1024`。对于 `dall-e-3`,请使用以下值之一: `1024x1024`, `1792x1024`,或 `1024x1792`.
- `"1024x1024"`
@@ -5163,7 +5163,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟并通过工具搜索被发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -5183,7 +5183,7 @@
- `name: string`
- 用于工具调用中的命名空间名称(例如, `crm`).
+ 工具调用中使用的命名空间名称(例如, `crm`).
- `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`
@@ -5207,19 +5207,19 @@
- `defer_loading: optional boolean`
- 此函数是否应被延迟并通过工具搜索被发现。
+ 此函数是否应被延迟并通过工具搜索发现。
- `description: optional string or null`
- `output_schema: optional map[unknown] or null`
- 描述此函数工具的字符串输出中编码的 JSON 值的 JSON Schema。该字段不描述内容数组输出。
+ 用于描述此函数工具字符串输出中编码的 JSON 值的 JSON Schema。这不描述 content 数组输出。
- `parameters: optional unknown or null`
- `strict: optional boolean or null`
- 是否强制执行严格的参数校验。如果省略,Responses 会在 schema 兼容时尝试使用严格校验,否则回退到非严格校验。
+ 是否强制执行严格的参数校验。如果省略,Responses 会尝试在 schema 兼容时使用严格校验,否则回退到非严格校验。
- `Custom object { name, type, allowed_callers, 3 more }`
@@ -5245,7 +5245,7 @@
- `defer_loading: optional boolean`
- 此工具是否应被延迟并通过工具搜索被发现。
+ 此工具是否应被延迟并通过工具搜索发现。
- `description: optional string`
@@ -5263,7 +5263,7 @@
- `ToolSearch object { type, description, execution, parameters }`
- 针对延迟工具的托管或 BYOT 工具搜索配置。
+ 用于延迟工具的托管或 BYOT 工具搜索配置。
- `type: "tool_search"`
@@ -5277,7 +5277,7 @@
- `execution: optional "server" or "client"`
- 工具搜索是由服务端还是客户端执行。
+ 工具搜索由服务端还是客户端执行。
- `"server"`
@@ -5285,7 +5285,7 @@
- `parameters: optional unknown or null`
- 客户端执行的工具搜索工具的参数 schema。
+ 客户端执行的工具搜索工具的参数架构。
- `WebSearchPreview object { type, search_content_types, search_context_size, user_location }`
@@ -5293,7 +5293,7 @@
- `type: "web_search_preview" or "web_search_preview_2025_03_11"`
- 网页搜索工具的类型。取值为 `web_search_preview` 或 `web_search_preview_2025_03_11`.
+ 网页搜索工具的类型之一: `web_search_preview` 或 `web_search_preview_2025_03_11`.
- `"web_search_preview"`
@@ -5307,7 +5307,7 @@
- `search_context_size: optional "low" or "medium" or "high"`
- 用于搜索的上下文窗口空间使用量的高级指引。取值为以下之一: `low`, `medium`,或 `high`. `medium` 为默认值。
+ 用于搜索的上下文窗口空间的高级使用指导。可选值为 `low`, `medium`,或 `high`. `medium` ,默认值。
- `"low"`
@@ -5317,25 +5317,25 @@
- `user_location: optional object { type, city, country, 2 more } or null`
- 用户所在的位置。
+ 用户所在位置。
- `type: "approximate"`
- 位置近似的类型。始终为 `approximate`.
+ 位置近似值的类型。始终为 `approximate`.
- `"approximate"`
- `city: optional string or null`
- 用户所在城市的自由文本输入,例如。 `San Francisco`.
+ 用户所在城市的自由文本输入,例如 `San Francisco`.
- `country: optional string or null`
- 用户所在国家的两位字母 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
+ 两位字母的 [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) ,例如。 `US`.
- `region: optional string or null`
- 用户所在地区的自由文本输入,例如。 `California`.
+ 用户所在地区的自由文本输入,例如 `California`.
- `timezone: optional string or null`
@@ -5343,7 +5343,7 @@
- `ApplyPatch object { type, allowed_callers }`
- 允许助手使用 unified diff 创建、删除或更新文件。
+ 允许助手使用统一差异格式创建、删除或更新文件。
- `type: "apply_patch"`
@@ -5361,13 +5361,13 @@
- `truncation: optional "auto" or "disabled"`
- 用于模型响应的截断策略。- `auto`:如果此响应的输入超出模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断响应以适配上下文窗口。- `disabled` (默认):如果输入大小将超出模型的上下文窗口大小,请求将以 400 错误失败。
+ 用于模型响应的截断策略。- `auto`: 如果此 Response 的输入超过模型的上下文窗口大小,模型将通过从对话开头丢弃条目来截断响应以适应上下文窗口。- `disabled` (默认):如果输入大小将超过模型的上下文窗口大小,请求将失败并返回 400 错误。
- `"auto"`
- `"disabled"`
-### Returns
+### 返回值
- `input_tokens: number`
@@ -5399,7 +5399,7 @@ curl -X POST https://api.openai.com/v1/responses/input_tokens \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
- "model": "gpt-5",
+ "model": "gpt-5.6-sol",
"input": "Tell me a joke."
}'
```
@@ -5413,7 +5413,7 @@ curl -X POST https://api.openai.com/v1/responses/input_tokens \
}
```
-## Domain Types
+## 域类型
### 输入 Token 计数响应
diff --git a/docs/zh/api/reference/resources/responses/websocket-events.md b/docs/zh/api/reference/resources/responses/websocket-events.md
index c20f543..d0cd8e7 100644
--- a/docs/zh/api/reference/resources/responses/websocket-events.md
+++ b/docs/zh/api/reference/resources/responses/websocket-events.md
@@ -1,8 +1,8 @@
# WebSocket 事件
-> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取文档页面的 Markdown 版本。
+> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。
-通过持久的 Responses API WebSocket 连接发送客户端事件并接收服务端事件。 [详细了解 WebSocket 模式。](https://developers.openai.com/api/docs/guides/websocket-mode)
+通过持久 Responses API WebSocket 连接发送客户端事件并接收服务端事件。 [了解有关 WebSocket 模式的更多信息。](https://developers.openai.com/api/docs/guides/websocket-mode)
## 客户端事件
@@ -10,14 +10,14 @@
### response.create
-用于在持久 WebSocket 连接上创建 response 的客户端事件。
-此负载使用与 `POST /v1/responses`,相同的顶层字段,外加
+通过持久 WebSocket 连接创建响应的客户端事件。
+该载荷使用与 `POST /v1/responses`,相同的顶层字段,外加
WebSocket 专属的信封元数据。
备注:
- `stream` 在 WebSocket 上是隐式的,不应发送。
- `background` 在 WebSocket 上不支持。
-- `stream_id` 仅适用于 WebSocket,不属于 `POST /v1/responses`.
+- `stream_id` 仅限 WebSocket,不属于 `POST /v1/responses`.
#### Schema
@@ -1046,14 +1046,14 @@ Schema name: `ResponsesClientEventResponseCreate`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": true,
"nullable": false,
@@ -1223,7 +1223,7 @@ Schema name: `ResponsesClientEventResponseCreate`
"oasRef": "#/components/schemas/CreateResponse/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": "HttpTypeReference",
@@ -4268,7 +4268,7 @@ Schema name: `ResponsesClientEventResponseCreate`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -34746,18 +34746,18 @@ Schema name: `ResponsesClientEventResponseCreate`
{
"type": "response.create",
"stream_id": "agent_1",
- "model": "gpt-5.5",
+ "model": "gpt-5.6-sol",
"input": "Say hello."
}
```
## 服务端事件(仅 WebSocket)
-事件仅通过 Responses API WebSocket 连接发出。
+仅通过 Responses API WebSocket 连接发出事件。
### error
-在处理 Responses WebSocket 请求过程中发生错误时触发。
+在处理 Responses WebSocket 请求时发生错误时触发。
#### Schema
@@ -35958,14 +35958,14 @@ Schema name: `ResponseCreatedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -36771,7 +36771,7 @@ Schema name: `ResponseCreatedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -42135,7 +42135,7 @@ Schema name: `ResponseCreatedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -89348,7 +89348,7 @@ Schema name: `ResponseCreatedEvent`
"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,
@@ -90318,14 +90318,14 @@ Schema name: `ResponseInProgressEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -91131,7 +91131,7 @@ Schema name: `ResponseInProgressEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -96495,7 +96495,7 @@ Schema name: `ResponseInProgressEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -143708,7 +143708,7 @@ Schema name: `ResponseInProgressEvent`
"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,
@@ -143737,7 +143737,7 @@ Schema name: `ResponseInProgressEvent`
### response.completed
-在模型响应完成时发出。
+当模型响应完成时触发。
#### Schema
@@ -144678,14 +144678,14 @@ Schema name: `ResponseCompletedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -145491,7 +145491,7 @@ Schema name: `ResponseCompletedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -150855,7 +150855,7 @@ Schema name: `ResponseCompletedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -198069,7 +198069,7 @@ Schema name: `ResponseCompletedEvent`
"input": [],
"instructions": null,
"max_output_tokens": null,
- "model": "gpt-4o-mini-2024-07-18",
+ "model": "gpt-5.6-sol",
"output": [
{
"id": "msg_123",
@@ -198114,7 +198114,7 @@ Schema name: `ResponseCompletedEvent`
### response.failed
-响应失败时发出的事件。
+当响应失败时触发的事件。
#### Schema
@@ -199055,14 +199055,14 @@ Schema name: `ResponseFailedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -199868,7 +199868,7 @@ Schema name: `ResponseFailedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -205232,7 +205232,7 @@ Schema name: `ResponseFailedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -252448,7 +252448,7 @@ Schema name: `ResponseFailedEvent`
"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,
@@ -252472,7 +252472,7 @@ Schema name: `ResponseFailedEvent`
### response.incomplete
-当响应以未完成状态结束时触发的事件。
+当响应以未完成状态结束时发出的事件。
#### Schema
@@ -253413,14 +253413,14 @@ Schema name: `ResponseIncompleteEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -254226,7 +254226,7 @@ Schema name: `ResponseIncompleteEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -259590,7 +259590,7 @@ Schema name: `ResponseIncompleteEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -306805,7 +306805,7 @@ Schema name: `ResponseIncompleteEvent`
},
"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,
@@ -306830,7 +306830,7 @@ Schema name: `ResponseIncompleteEvent`
### response.output_item.added
-当新增一个输出项时发出。
+当新增输出项时触发。
#### Schema
@@ -330366,7 +330366,7 @@ Schema name: `ResponseOutputItemAddedEvent`
### response.output_item.done
-当某个输出项被标记为完成时发出。
+当输出项被标记为完成时触发。
#### Schema
@@ -353908,7 +353908,7 @@ Schema name: `ResponseOutputItemDoneEvent`
### response.content_part.added
-当添加新的内容片段时发出。
+当添加新的内容部分时发出。
#### Schema
@@ -355092,7 +355092,7 @@ Schema name: `ResponseContentPartAddedEvent`
### response.content_part.done
-当内容部分完成时发出。
+当某个内容部分完成时发出。
#### Schema
@@ -356276,7 +356276,7 @@ Schema name: `ResponseContentPartDoneEvent`
### response.output_text.delta
-当存在额外的文本增量时触发。
+当存在额外的文本增量时发出。
#### Schema
@@ -356600,7 +356600,7 @@ Schema name: `ResponseTextDeltaEvent`
### response.output_text.done
-当文本内容最终确定时发出。
+当文本内容被最终确定时发出。
#### Schema
@@ -356924,7 +356924,7 @@ Schema name: `ResponseTextDoneEvent`
### response.refusal.delta
-当出现部分拒绝文本时触发。
+当存在部分拒答文本时触发。
#### Schema
@@ -357124,7 +357124,7 @@ Schema name: `ResponseRefusalDeltaEvent`
### response.refusal.done
-在拒绝文本最终确定时触发。
+在 refusal 文本最终确定时发出。
#### Schema
@@ -357324,7 +357324,7 @@ Schema name: `ResponseRefusalDoneEvent`
### response.function_call_arguments.delta
-当存在部分函数调用参数的增量时触发。
+当存在部分函数调用参数的增量时发出。
#### Schema
@@ -357505,7 +357505,7 @@ Schema name: `ResponseFunctionCallArgumentsDeltaEvent`
### response.function_call_arguments.done
-当函数调用的参数最终确定时发出。
+当函数调用参数最终确定时触发。
#### Schema
@@ -357704,7 +357704,7 @@ Schema name: `ResponseFunctionCallArgumentsDoneEvent`
### response.file_search_call.in_progress
-在发起文件搜索调用时发出。
+在发起 文件搜索 调用时发出。
#### Schema
@@ -357866,7 +357866,7 @@ Schema name: `ResponseFileSearchCallInProgressEvent`
### response.file_search_call.searching
-在 文件搜索正在进行搜索时发出。
+在 文件搜索 正在搜索时发出。
#### Schema
@@ -358028,7 +358028,7 @@ Schema name: `ResponseFileSearchCallSearchingEvent`
### response.file_search_call.completed
-当 文件搜索 调用完成时(找到结果)发出。
+当文件搜索调用完成(已找到结果)时发出。
#### Schema
@@ -358352,7 +358352,7 @@ Schema name: `ResponseWebSearchCallInProgressEvent`
### response.web_search_call.searching
-在 网页搜索 调用正在执行时发出。
+当一次网页搜索调用正在执行时发出。
#### Schema
@@ -358514,7 +358514,7 @@ Schema name: `ResponseWebSearchCallSearchingEvent`
### response.web_search_call.completed
-当一次网页搜索调用完成时发出。
+在 网页搜索 调用完成时发出。
#### Schema
@@ -358676,7 +358676,7 @@ Schema name: `ResponseWebSearchCallCompletedEvent`
### response.reasoning_summary_part.added
-当新增推理摘要片段时触发。
+当新增一条推理摘要分块时触发。
#### Schema
@@ -358936,7 +358936,7 @@ Schema name: `ResponseReasoningSummaryPartAddedEvent`
### response.reasoning_summary_part.done
-当推理摘要片段完成时发出。
+当推理摘要部分完成时发出。
#### Schema
@@ -359231,7 +359231,7 @@ Schema name: `ResponseReasoningSummaryPartDoneEvent`
### response.reasoning_summary_text.delta
-当向推理摘要文本添加增量时发出。
+当向推理摘要文本添加增量时触发。
#### Schema
@@ -359431,7 +359431,7 @@ Schema name: `ResponseReasoningSummaryTextDeltaEvent`
### response.reasoning_summary_text.done
-在推理摘要文本完成时触发。
+当推理摘要文本完成时发出。
#### Schema
@@ -359631,7 +359631,7 @@ Schema name: `ResponseReasoningSummaryTextDoneEvent`
### response.reasoning_text.delta
-当有增量内容被添加到推理文本时触发。
+在向推理文本添加增量时发出。
#### Schema
@@ -359831,7 +359831,7 @@ Schema name: `ResponseReasoningTextDeltaEvent`
### response.reasoning_text.done
-在推理文本完成时发出。
+当推理文本完成时发出。
#### Schema
@@ -360031,7 +360031,7 @@ Schema name: `ResponseReasoningTextDoneEvent`
### response.image_generation_call.completed
-当图像生成工具调用已完成且最终图像可用时触发。
+当图像生成工具调用完成且最终图像可用时发出。
#### Schema
@@ -360193,7 +360193,7 @@ Schema name: `ResponseImageGenCallCompletedEvent`
### response.image_generation_call.generating
-当图像生成工具调用正在主动生成图像时(中间状态)触发。
+当一个图像生成工具调用正在主动生成图像时触发(中间状态)。
#### Schema
@@ -360789,7 +360789,7 @@ Schema name: `ResponseImageGenCallPartialImageEvent`
### response.mcp_call_arguments.delta
-当 MCP 工具调用的参数出现增量(部分更新)时触发。
+在 MCP 工具调用的参数产生增量(部分更新)时发出。
#### Schema
@@ -360970,7 +360970,7 @@ Schema name: `ResponseMCPCallArgumentsDeltaEvent`
### response.mcp_call_arguments.done
-在 MCP 工具调用的参数确定后发出。
+在 MCP 工具调用的参数最终确定时发出。
#### Schema
@@ -361475,7 +361475,7 @@ Schema name: `ResponseMCPCallFailedEvent`
### response.mcp_call.in_progress
-当 MCP 工具调用正在进行时发出。
+当 MCP 工具调用进行中时发出。
#### Schema
@@ -361637,7 +361637,7 @@ Schema name: `ResponseMCPCallInProgressEvent`
### response.mcp_list_tools.completed
-在成功检索到可用 MCP 工具列表时发出。
+在成功获取可用的 MCP 工具列表时发出。
#### Schema
@@ -361799,7 +361799,7 @@ Schema name: `ResponseMCPListToolsCompletedEvent`
### response.mcp_list_tools.failed
-在尝试列出可用的 MCP 工具失败时触发。
+在尝试列出可用的 MCP 工具失败时发出。
#### Schema
@@ -362123,7 +362123,7 @@ Schema name: `ResponseMCPListToolsInProgressEvent`
### response.code_interpreter_call.in_progress
-当代码解释器调用正在进行时发出。
+在代码解释器调用进行中时发出。
#### Schema
@@ -362285,7 +362285,7 @@ Schema name: `ResponseCodeInterpreterCallInProgressEvent`
### response.code_interpreter_call.interpreting
-当代码解释器正在主动解释代码片段时触发。
+当代码解释器正在主动解释代码片段时发出。
#### Schema
@@ -362609,7 +362609,7 @@ Schema name: `ResponseCodeInterpreterCallCompletedEvent`
### response.code_interpreter_call_code.delta
-当代码解释器流式输出部分代码片段时触发。
+当代码解释器流式传输部分代码片段时触发。
#### Schema
@@ -362790,7 +362790,7 @@ Schema name: `ResponseCodeInterpreterCallCodeDeltaEvent`
### response.code_interpreter_call_code.done
-当代码解释器最终确定代码片段时发出。
+当代码片段由代码解释器最终确定时发出。
#### Schema
@@ -362971,7 +362971,7 @@ Schema name: `ResponseCodeInterpreterCallCodeDoneEvent`
### response.output_text.annotation.added
-当注释被添加到输出文本内容时发出。
+当向输出文本内容添加注解时发出。
#### Schema
@@ -364673,14 +364673,14 @@ Schema name: `ResponseQueuedEvent`
"oasRef": "#/components/schemas/ResponseProperties/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": "HttpTypeReference",
"ident": "ResponsesModel",
"$ref": "(resource) $shared > (model) responses_model > (schema)"
},
"examples": [
- "gpt-5.1"
+ "gpt-5.6-sol"
],
"optional": false,
"nullable": false,
@@ -365486,7 +365486,7 @@ Schema name: `ResponseQueuedEvent`
"oasRef": "#/components/schemas/Response/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": "HttpTypeReference",
@@ -370850,7 +370850,7 @@ Schema name: `ResponseQueuedEvent`
"(resource) $shared > (model) reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/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",
"ident": "Reasoning",
"type": {
"kind": "HttpTypeObject",
@@ -418065,7 +418065,7 @@ Schema name: `ResponseQueuedEvent`
### response.custom_tool_call_input.delta
-表示对自定义工具调用输入进行增量(部分更新)的事件。
+表示对自定义工具调用的输入进行增量(部分更新)的事件。
#### Schema
@@ -418245,7 +418245,7 @@ Schema name: `ResponseCustomToolCallInputDeltaEvent`
### response.custom_tool_call_input.done
-表示自定义工具调用的输入已完成的事件。
+表示自定义工具调用的输入已完整的事件。
#### Schema
@@ -418425,7 +418425,7 @@ Schema name: `ResponseCustomToolCallInputDoneEvent`
### response.audio.delta
-当出现部分音频响应时触发。
+当存在部分音频响应时发出。
#### Schema
@@ -418569,7 +418569,7 @@ Schema name: `ResponseAudioDeltaEvent`
### response.audio.done
-在音频响应完成时发出。
+当音频响应完成时发出。
#### Schema
@@ -418694,7 +418694,7 @@ Schema name: `ResponseAudioDoneEvent`
### response.audio.transcript.delta
-在出现音频的部分转录文本时发出。
+当存在音频的部分转录文本时发出。
#### Schema
@@ -418838,7 +418838,7 @@ Schema name: `ResponseAudioTranscriptDeltaEvent`
### response.audio.transcript.done
-在完整音频转录完成时发出。
+当完整音频转录完成时发出。
#### Schema
@@ -418963,7 +418963,7 @@ Schema name: `ResponseAudioTranscriptDoneEvent`
### response.shell_call_command.added
-一个流式事件,用于指示已将 shell 命令添加到工具调用中。
+表示 shell 命令已添加到工具调用的流事件。
#### Schema
@@ -419145,7 +419145,7 @@ Schema name: `ResponseShellCallCommandAddedStreamingEvent`
### response.shell_call_command.delta
-一个流式事件,指示某个 shell 命令被增量更新。
+指示 shell 命令被增量更新的流事件。
#### Schema
@@ -419346,7 +419346,7 @@ Schema name: `ResponseShellCallCommandDeltaStreamingEvent`
### response.shell_call_command.done
-表示 shell 命令已完成的流式事件。
+指示 shell 命令已完成的流式事件。
#### Schema
@@ -419528,7 +419528,7 @@ Schema name: `ResponseShellCallCommandDoneStreamingEvent`
### response.shell_call_output_content.delta
-一个流式事件,表示 shell 调用输出被增量添加。
+一个流式事件,指示 shell 调用输出被增量添加。
#### Schema