openai 4.8.0 → 4.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (319) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +13 -9
  3. package/_shims/MultipartBody.d.ts +9 -0
  4. package/_shims/MultipartBody.d.ts.map +1 -0
  5. package/_shims/MultipartBody.js +16 -0
  6. package/_shims/MultipartBody.js.map +1 -0
  7. package/_shims/MultipartBody.mjs +12 -0
  8. package/_shims/MultipartBody.mjs.map +1 -0
  9. package/_shims/README.md +46 -0
  10. package/{src/_shims/ReadableStream-node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
  11. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  12. package/_shims/auto/runtime-bun.js +21 -0
  13. package/_shims/auto/runtime-bun.js.map +1 -0
  14. package/_shims/auto/runtime-bun.mjs +2 -0
  15. package/_shims/auto/runtime-bun.mjs.map +1 -0
  16. package/_shims/auto/runtime-node.d.ts +5 -0
  17. package/_shims/auto/runtime-node.d.ts.map +1 -0
  18. package/_shims/auto/runtime-node.js +21 -0
  19. package/_shims/auto/runtime-node.js.map +1 -0
  20. package/_shims/auto/runtime-node.mjs +2 -0
  21. package/_shims/auto/runtime-node.mjs.map +1 -0
  22. package/_shims/auto/runtime.d.ts +5 -0
  23. package/_shims/auto/runtime.d.ts.map +1 -0
  24. package/_shims/auto/runtime.js +21 -0
  25. package/_shims/auto/runtime.js.map +1 -0
  26. package/_shims/auto/runtime.mjs +2 -0
  27. package/_shims/auto/runtime.mjs.map +1 -0
  28. package/_shims/auto/types-node.d.ts +5 -0
  29. package/_shims/auto/types-node.d.ts.map +1 -0
  30. package/_shims/auto/types-node.js +21 -0
  31. package/_shims/auto/types-node.js.map +1 -0
  32. package/_shims/auto/types-node.mjs +2 -0
  33. package/_shims/auto/types-node.mjs.map +1 -0
  34. package/_shims/auto/types.d.ts +99 -0
  35. package/_shims/{ReadableStream.js → auto/types.js} +0 -2
  36. package/{src/_shims/ReadableStream.js → _shims/auto/types.mjs} +0 -2
  37. package/_shims/bun-runtime.d.ts +6 -0
  38. package/_shims/bun-runtime.d.ts.map +1 -0
  39. package/_shims/bun-runtime.js +14 -0
  40. package/_shims/bun-runtime.js.map +1 -0
  41. package/_shims/bun-runtime.mjs +10 -0
  42. package/_shims/bun-runtime.mjs.map +1 -0
  43. package/_shims/index.d.ts +79 -0
  44. package/_shims/index.js +13 -0
  45. package/_shims/index.mjs +7 -0
  46. package/_shims/manual-types.d.ts +12 -0
  47. package/_shims/manual-types.js +3 -0
  48. package/_shims/manual-types.mjs +3 -0
  49. package/_shims/node-runtime.d.ts +3 -0
  50. package/_shims/node-runtime.d.ts.map +1 -0
  51. package/_shims/node-runtime.js +87 -0
  52. package/_shims/node-runtime.js.map +1 -0
  53. package/_shims/node-runtime.mjs +54 -0
  54. package/_shims/node-runtime.mjs.map +1 -0
  55. package/_shims/node-types.d.ts +42 -0
  56. package/_shims/node-types.js +3 -0
  57. package/_shims/node-types.mjs +3 -0
  58. package/_shims/registry.d.ts +35 -0
  59. package/_shims/registry.d.ts.map +1 -0
  60. package/_shims/registry.js +39 -0
  61. package/_shims/registry.js.map +1 -0
  62. package/_shims/registry.mjs +35 -0
  63. package/_shims/registry.mjs.map +1 -0
  64. package/_shims/web-runtime.d.ts +5 -0
  65. package/_shims/web-runtime.d.ts.map +1 -0
  66. package/_shims/web-runtime.js +70 -0
  67. package/_shims/web-runtime.js.map +1 -0
  68. package/_shims/web-runtime.mjs +63 -0
  69. package/_shims/web-runtime.mjs.map +1 -0
  70. package/_shims/web-types.d.ts +82 -0
  71. package/_shims/web-types.js +3 -0
  72. package/_shims/web-types.mjs +3 -0
  73. package/core.d.ts +170 -218
  74. package/core.d.ts.map +1 -1
  75. package/core.js +679 -737
  76. package/core.js.map +1 -1
  77. package/core.mjs +673 -688
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +32 -34
  80. package/error.js +95 -109
  81. package/error.mjs +92 -94
  82. package/index.d.mts +164 -175
  83. package/index.d.ts +164 -175
  84. package/index.d.ts.map +1 -1
  85. package/index.js +110 -161
  86. package/index.mjs +88 -109
  87. package/package.json +31 -58
  88. package/pagination.d.ts +31 -41
  89. package/pagination.js +52 -48
  90. package/pagination.mjs +50 -46
  91. package/resource.d.ts +10 -10
  92. package/resource.js +12 -12
  93. package/resource.mjs +10 -10
  94. package/resources/audio/audio.d.ts +12 -12
  95. package/resources/audio/audio.js +33 -50
  96. package/resources/audio/audio.mjs +11 -11
  97. package/resources/audio/index.d.ts +4 -4
  98. package/resources/audio/index.js +9 -24
  99. package/resources/audio/index.mjs +4 -4
  100. package/resources/audio/transcriptions.d.ts +44 -44
  101. package/resources/audio/transcriptions.js +13 -12
  102. package/resources/audio/transcriptions.mjs +9 -8
  103. package/resources/audio/translations.d.ts +38 -38
  104. package/resources/audio/translations.js +13 -12
  105. package/resources/audio/translations.mjs +9 -8
  106. package/resources/chat/chat.d.ts +17 -17
  107. package/resources/chat/chat.js +30 -47
  108. package/resources/chat/chat.mjs +8 -8
  109. package/resources/chat/completions.d.ts +330 -353
  110. package/resources/chat/completions.js +10 -13
  111. package/resources/chat/completions.mjs +7 -10
  112. package/resources/chat/index.d.ts +3 -17
  113. package/resources/chat/index.js +7 -17
  114. package/resources/chat/index.mjs +3 -3
  115. package/resources/completions.d.ts +216 -232
  116. package/resources/completions.js +10 -13
  117. package/resources/completions.mjs +7 -10
  118. package/resources/edits.d.ts +73 -73
  119. package/resources/edits.js +16 -15
  120. package/resources/edits.mjs +13 -12
  121. package/resources/embeddings.d.ts +73 -76
  122. package/resources/embeddings.js +12 -11
  123. package/resources/embeddings.mjs +9 -8
  124. package/resources/files.d.ts +91 -96
  125. package/resources/files.js +64 -65
  126. package/resources/files.mjs +57 -58
  127. package/resources/fine-tunes.d.ts +277 -290
  128. package/resources/fine-tunes.js +49 -50
  129. package/resources/fine-tunes.mjs +45 -46
  130. package/resources/fine-tuning/fine-tuning.d.ts +12 -12
  131. package/resources/fine-tuning/fine-tuning.js +32 -49
  132. package/resources/fine-tuning/fine-tuning.mjs +10 -10
  133. package/resources/fine-tuning/index.d.ts +3 -12
  134. package/resources/fine-tuning/index.js +9 -29
  135. package/resources/fine-tuning/index.mjs +3 -3
  136. package/resources/fine-tuning/jobs.d.ts +173 -179
  137. package/resources/fine-tuning/jobs.js +50 -47
  138. package/resources/fine-tuning/jobs.mjs +45 -42
  139. package/resources/images.d.ts +116 -119
  140. package/resources/images.js +25 -24
  141. package/resources/images.mjs +21 -20
  142. package/resources/index.d.ts +12 -37
  143. package/resources/index.js +29 -113
  144. package/resources/index.mjs +12 -12
  145. package/resources/models.d.ts +41 -40
  146. package/resources/models.js +30 -28
  147. package/resources/models.mjs +26 -24
  148. package/resources/moderations.d.ts +153 -156
  149. package/resources/moderations.js +12 -11
  150. package/resources/moderations.mjs +9 -8
  151. package/shims/node.d.ts +29 -0
  152. package/shims/node.d.ts.map +1 -0
  153. package/shims/node.js +31 -0
  154. package/shims/node.js.map +1 -0
  155. package/shims/node.mjs +5 -0
  156. package/shims/node.mjs.map +1 -0
  157. package/shims/web.d.ts +26 -0
  158. package/shims/web.d.ts.map +1 -0
  159. package/shims/web.js +31 -0
  160. package/shims/web.js.map +1 -0
  161. package/shims/web.mjs +5 -0
  162. package/shims/web.mjs.map +1 -0
  163. package/src/_shims/MultipartBody.ts +9 -0
  164. package/src/_shims/README.md +46 -0
  165. package/src/_shims/auto/runtime-bun.ts +4 -0
  166. package/src/_shims/auto/runtime-node.ts +4 -0
  167. package/src/_shims/auto/runtime.ts +4 -0
  168. package/src/_shims/auto/types-node.ts +4 -0
  169. package/src/_shims/auto/types.d.ts +99 -0
  170. package/src/_shims/auto/types.js +3 -0
  171. package/src/_shims/auto/types.mjs +3 -0
  172. package/src/_shims/bun-runtime.ts +14 -0
  173. package/src/_shims/index.d.ts +79 -0
  174. package/src/_shims/index.js +13 -0
  175. package/src/_shims/index.mjs +7 -0
  176. package/src/_shims/manual-types.d.ts +12 -0
  177. package/src/_shims/manual-types.js +3 -0
  178. package/src/_shims/manual-types.mjs +3 -0
  179. package/src/_shims/node-runtime.ts +79 -0
  180. package/src/_shims/node-types.d.ts +42 -0
  181. package/src/_shims/node-types.js +3 -0
  182. package/src/_shims/node-types.mjs +3 -0
  183. package/src/_shims/registry.ts +62 -0
  184. package/src/_shims/web-runtime.ts +91 -0
  185. package/src/_shims/web-types.d.ts +82 -0
  186. package/src/_shims/web-types.js +3 -0
  187. package/src/_shims/web-types.mjs +3 -0
  188. package/src/core.ts +34 -17
  189. package/src/error.ts +1 -1
  190. package/src/index.ts +6 -6
  191. package/src/pagination.ts +1 -1
  192. package/src/resource.ts +1 -1
  193. package/src/resources/audio/audio.ts +4 -4
  194. package/src/resources/audio/index.ts +3 -3
  195. package/src/resources/audio/transcriptions.ts +4 -4
  196. package/src/resources/audio/translations.ts +4 -4
  197. package/src/resources/chat/chat.ts +3 -3
  198. package/src/resources/chat/completions.ts +6 -6
  199. package/src/resources/chat/index.ts +2 -2
  200. package/src/resources/completions.ts +5 -5
  201. package/src/resources/edits.ts +4 -4
  202. package/src/resources/embeddings.ts +3 -3
  203. package/src/resources/files.ts +7 -7
  204. package/src/resources/fine-tunes.ts +7 -7
  205. package/src/resources/fine-tuning/fine-tuning.ts +3 -3
  206. package/src/resources/fine-tuning/index.ts +2 -2
  207. package/src/resources/fine-tuning/jobs.ts +6 -6
  208. package/src/resources/images.ts +4 -4
  209. package/src/resources/index.ts +11 -11
  210. package/src/resources/models.ts +4 -4
  211. package/src/resources/moderations.ts +3 -3
  212. package/src/shims/node.ts +50 -0
  213. package/src/shims/web.ts +50 -0
  214. package/src/streaming.ts +1 -1
  215. package/src/uploads.ts +12 -16
  216. package/src/version.ts +1 -1
  217. package/streaming.d.ts +9 -8
  218. package/streaming.d.ts.map +1 -1
  219. package/streaming.js +194 -185
  220. package/streaming.mjs +192 -183
  221. package/uploads.d.ts +23 -39
  222. package/uploads.d.ts.map +1 -1
  223. package/uploads.js +115 -157
  224. package/uploads.js.map +1 -1
  225. package/uploads.mjs +111 -133
  226. package/uploads.mjs.map +1 -1
  227. package/version.d.ts +2 -2
  228. package/version.js +4 -4
  229. package/version.mjs +2 -2
  230. package/_shims/ReadableStream-node.d.ts +0 -6
  231. package/_shims/ReadableStream-node.d.ts.map +0 -1
  232. package/_shims/ReadableStream-node.js +0 -14
  233. package/_shims/ReadableStream-node.js.map +0 -1
  234. package/_shims/ReadableStream-node.mjs +0 -3
  235. package/_shims/ReadableStream-node.mjs.map +0 -1
  236. package/_shims/ReadableStream.d.ts +0 -38
  237. package/_shims/ReadableStream.mjs +0 -7
  238. package/_shims/agent-node.d.ts +0 -7
  239. package/_shims/agent-node.d.ts.map +0 -1
  240. package/_shims/agent-node.js +0 -28
  241. package/_shims/agent-node.js.map +0 -1
  242. package/_shims/agent-node.mjs +0 -16
  243. package/_shims/agent-node.mjs.map +0 -1
  244. package/_shims/agent.d.ts +0 -9
  245. package/_shims/agent.d.ts.map +0 -1
  246. package/_shims/agent.js +0 -14
  247. package/_shims/agent.js.map +0 -1
  248. package/_shims/agent.mjs +0 -10
  249. package/_shims/agent.mjs.map +0 -1
  250. package/_shims/fetch-node.d.ts +0 -64
  251. package/_shims/fetch-node.js +0 -12
  252. package/_shims/fetch-node.mjs +0 -14
  253. package/_shims/fetch.d.ts +0 -60
  254. package/_shims/fetch.js +0 -13
  255. package/_shims/fetch.mjs +0 -15
  256. package/_shims/fileFromPath-node.d.ts +0 -17
  257. package/_shims/fileFromPath-node.d.ts.map +0 -1
  258. package/_shims/fileFromPath-node.js +0 -17
  259. package/_shims/fileFromPath-node.js.map +0 -1
  260. package/_shims/fileFromPath-node.mjs +0 -13
  261. package/_shims/fileFromPath-node.mjs.map +0 -1
  262. package/_shims/fileFromPath.d.ts +0 -22
  263. package/_shims/fileFromPath.d.ts.map +0 -1
  264. package/_shims/fileFromPath.js +0 -16
  265. package/_shims/fileFromPath.js.map +0 -1
  266. package/_shims/fileFromPath.mjs +0 -12
  267. package/_shims/fileFromPath.mjs.map +0 -1
  268. package/_shims/form-data-node.d.ts +0 -45
  269. package/_shims/form-data-node.js +0 -11
  270. package/_shims/form-data-node.mjs +0 -9
  271. package/_shims/form-data.d.ts +0 -43
  272. package/_shims/form-data.js +0 -17
  273. package/_shims/form-data.mjs +0 -20
  274. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  275. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  276. package/_shims/getMultipartRequestOptions-node.js +0 -22
  277. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  278. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  279. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  280. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  281. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  282. package/_shims/getMultipartRequestOptions.js +0 -12
  283. package/_shims/getMultipartRequestOptions.js.map +0 -1
  284. package/_shims/getMultipartRequestOptions.mjs +0 -8
  285. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  286. package/_shims/node-readable-node.d.ts +0 -8
  287. package/_shims/node-readable-node.d.ts.map +0 -1
  288. package/_shims/node-readable-node.js +0 -9
  289. package/_shims/node-readable-node.js.map +0 -1
  290. package/_shims/node-readable-node.mjs +0 -5
  291. package/_shims/node-readable-node.mjs.map +0 -1
  292. package/_shims/node-readable.d.ts +0 -23
  293. package/_shims/node-readable.d.ts.map +0 -1
  294. package/_shims/node-readable.js +0 -11
  295. package/_shims/node-readable.js.map +0 -1
  296. package/_shims/node-readable.mjs +0 -7
  297. package/_shims/node-readable.mjs.map +0 -1
  298. package/src/_shims/ReadableStream.d.ts +0 -38
  299. package/src/_shims/ReadableStream.mjs +0 -7
  300. package/src/_shims/agent-node.ts +0 -22
  301. package/src/_shims/agent.ts +0 -12
  302. package/src/_shims/fetch-node.d.ts +0 -64
  303. package/src/_shims/fetch-node.js +0 -12
  304. package/src/_shims/fetch-node.mjs +0 -14
  305. package/src/_shims/fetch.d.ts +0 -60
  306. package/src/_shims/fetch.js +0 -13
  307. package/src/_shims/fetch.mjs +0 -15
  308. package/src/_shims/fileFromPath-node.ts +0 -29
  309. package/src/_shims/fileFromPath.ts +0 -29
  310. package/src/_shims/form-data-node.d.ts +0 -45
  311. package/src/_shims/form-data-node.js +0 -11
  312. package/src/_shims/form-data-node.mjs +0 -9
  313. package/src/_shims/form-data.d.ts +0 -43
  314. package/src/_shims/form-data.js +0 -17
  315. package/src/_shims/form-data.mjs +0 -20
  316. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  317. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  318. package/src/_shims/node-readable-node.ts +0 -10
  319. package/src/_shims/node-readable.ts +0 -30
@@ -1,18 +1,15 @@
1
- 'use strict';
1
+ "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless.
3
- Object.defineProperty(exports, '__esModule', { value: true });
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Completions = void 0;
5
- const resource_1 = require('openai/resource');
5
+ const resource_1 = require("openai/resource");
6
6
  class Completions extends resource_1.APIResource {
7
- create(body, options) {
8
- var _a;
9
- return this.post('/chat/completions', {
10
- body,
11
- ...options,
12
- stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false,
13
- });
14
- }
7
+ create(body, options) {
8
+ var _a;
9
+ return this.post('/chat/completions', { body, ...options, stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false });
10
+ }
15
11
  }
16
12
  exports.Completions = Completions;
17
- (function (Completions) {})((Completions = exports.Completions || (exports.Completions = {})));
18
- //# sourceMappingURL=completions.js.map
13
+ (function (Completions) {
14
+ })(Completions = exports.Completions || (exports.Completions = {}));
15
+ //# sourceMappingURL=completions.js.map
@@ -1,14 +1,11 @@
1
1
  // File generated from our OpenAPI spec by Stainless.
2
2
  import { APIResource } from 'openai/resource';
3
3
  export class Completions extends APIResource {
4
- create(body, options) {
5
- var _a;
6
- return this.post('/chat/completions', {
7
- body,
8
- ...options,
9
- stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false,
10
- });
11
- }
4
+ create(body, options) {
5
+ var _a;
6
+ return this.post('/chat/completions', { body, ...options, stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false });
7
+ }
12
8
  }
13
- (function (Completions) {})(Completions || (Completions = {}));
14
- //# sourceMappingURL=completions.mjs.map
9
+ (function (Completions) {
10
+ })(Completions || (Completions = {}));
11
+ //# sourceMappingURL=completions.mjs.map
@@ -1,17 +1,3 @@
1
- export { Chat } from './chat.js';
2
- export {
3
- ChatCompletion,
4
- ChatCompletionChunk,
5
- ChatCompletionMessage,
6
- ChatCompletionMessageParam,
7
- ChatCompletionRole,
8
- CreateChatCompletionRequestMessage,
9
- ChatCompletionCreateParams,
10
- CompletionCreateParams,
11
- ChatCompletionCreateParamsNonStreaming,
12
- CompletionCreateParamsNonStreaming,
13
- ChatCompletionCreateParamsStreaming,
14
- CompletionCreateParamsStreaming,
15
- Completions,
16
- } from './completions.js';
17
- //# sourceMappingURL=index.d.ts.map
1
+ export { Chat } from "./chat.js";
2
+ export { ChatCompletion, ChatCompletionChunk, ChatCompletionMessage, ChatCompletionMessageParam, ChatCompletionRole, CreateChatCompletionRequestMessage, ChatCompletionCreateParams, CompletionCreateParams, ChatCompletionCreateParamsNonStreaming, CompletionCreateParamsNonStreaming, ChatCompletionCreateParamsStreaming, CompletionCreateParamsStreaming, Completions, } from "./completions.js";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -1,19 +1,9 @@
1
- 'use strict';
1
+ "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless.
3
- Object.defineProperty(exports, '__esModule', { value: true });
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Completions = exports.Chat = void 0;
5
- var chat_1 = require('./chat.js');
6
- Object.defineProperty(exports, 'Chat', {
7
- enumerable: true,
8
- get: function () {
9
- return chat_1.Chat;
10
- },
11
- });
12
- var completions_1 = require('./completions.js');
13
- Object.defineProperty(exports, 'Completions', {
14
- enumerable: true,
15
- get: function () {
16
- return completions_1.Completions;
17
- },
18
- });
19
- //# sourceMappingURL=index.js.map
5
+ var chat_1 = require("./chat.js");
6
+ Object.defineProperty(exports, "Chat", { enumerable: true, get: function () { return chat_1.Chat; } });
7
+ var completions_1 = require("./completions.js");
8
+ Object.defineProperty(exports, "Completions", { enumerable: true, get: function () { return completions_1.Completions; } });
9
+ //# sourceMappingURL=index.js.map
@@ -1,4 +1,4 @@
1
1
  // File generated from our OpenAPI spec by Stainless.
2
- export { Chat } from './chat.mjs';
3
- export { Completions } from './completions.mjs';
4
- //# sourceMappingURL=index.mjs.map
2
+ export { Chat } from "./chat.mjs";
3
+ export { Completions, } from "./completions.mjs";
4
+ //# sourceMappingURL=index.mjs.map
@@ -1,264 +1,248 @@
1
1
  import * as Core from 'openai/core';
2
2
  import { APIPromise } from 'openai/core';
3
3
  import { APIResource } from 'openai/resource';
4
- import * as API from './index.js';
4
+ import * as API from "./index.js";
5
5
  import { Stream } from 'openai/streaming';
6
6
  export declare class Completions extends APIResource {
7
- /**
8
- * Creates a completion for the provided prompt and parameters.
9
- */
10
- create(body: CompletionCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Completion>;
11
- create(
12
- body: CompletionCreateParamsStreaming,
13
- options?: Core.RequestOptions,
14
- ): APIPromise<Stream<Completion>>;
15
- create(
16
- body: CompletionCreateParamsBase,
17
- options?: Core.RequestOptions,
18
- ): APIPromise<Stream<Completion> | Completion>;
7
+ /**
8
+ * Creates a completion for the provided prompt and parameters.
9
+ */
10
+ create(body: CompletionCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Completion>;
11
+ create(body: CompletionCreateParamsStreaming, options?: Core.RequestOptions): APIPromise<Stream<Completion>>;
12
+ create(body: CompletionCreateParamsBase, options?: Core.RequestOptions): APIPromise<Stream<Completion> | Completion>;
19
13
  }
20
14
  /**
21
15
  * Represents a completion response from the API. Note: both the streamed and
22
16
  * non-streamed response objects share the same shape (unlike the chat endpoint).
23
17
  */
24
18
  export interface Completion {
25
- /**
26
- * A unique identifier for the completion.
27
- */
28
- id: string;
29
- /**
30
- * The list of completion choices the model generated for the input prompt.
31
- */
32
- choices: Array<CompletionChoice>;
33
- /**
34
- * The Unix timestamp (in seconds) of when the completion was created.
35
- */
36
- created: number;
37
- /**
38
- * The model used for completion.
39
- */
40
- model: string;
41
- /**
42
- * The object type, which is always "text_completion"
43
- */
44
- object: string;
45
- /**
46
- * Usage statistics for the completion request.
47
- */
48
- usage?: CompletionUsage;
19
+ /**
20
+ * A unique identifier for the completion.
21
+ */
22
+ id: string;
23
+ /**
24
+ * The list of completion choices the model generated for the input prompt.
25
+ */
26
+ choices: Array<CompletionChoice>;
27
+ /**
28
+ * The Unix timestamp (in seconds) of when the completion was created.
29
+ */
30
+ created: number;
31
+ /**
32
+ * The model used for completion.
33
+ */
34
+ model: string;
35
+ /**
36
+ * The object type, which is always "text_completion"
37
+ */
38
+ object: string;
39
+ /**
40
+ * Usage statistics for the completion request.
41
+ */
42
+ usage?: CompletionUsage;
49
43
  }
50
44
  export interface CompletionChoice {
51
- /**
52
- * The reason the model stopped generating tokens. This will be `stop` if the model
53
- * hit a natural stop point or a provided stop sequence, or `length` if the maximum
54
- * number of tokens specified in the request was reached.
55
- */
56
- finish_reason: 'stop' | 'length';
57
- index: number;
58
- logprobs: CompletionChoice.Logprobs | null;
59
- text: string;
45
+ /**
46
+ * The reason the model stopped generating tokens. This will be `stop` if the model
47
+ * hit a natural stop point or a provided stop sequence, or `length` if the maximum
48
+ * number of tokens specified in the request was reached.
49
+ */
50
+ finish_reason: 'stop' | 'length';
51
+ index: number;
52
+ logprobs: CompletionChoice.Logprobs | null;
53
+ text: string;
60
54
  }
61
55
  export declare namespace CompletionChoice {
62
- interface Logprobs {
63
- text_offset?: Array<number>;
64
- token_logprobs?: Array<number>;
65
- tokens?: Array<string>;
66
- top_logprobs?: Array<Record<string, number>>;
67
- }
56
+ interface Logprobs {
57
+ text_offset?: Array<number>;
58
+ token_logprobs?: Array<number>;
59
+ tokens?: Array<string>;
60
+ top_logprobs?: Array<Record<string, number>>;
61
+ }
68
62
  }
69
63
  /**
70
64
  * Usage statistics for the completion request.
71
65
  */
72
66
  export interface CompletionUsage {
73
- /**
74
- * Number of tokens in the generated completion.
75
- */
76
- completion_tokens: number;
77
- /**
78
- * Number of tokens in the prompt.
79
- */
80
- prompt_tokens: number;
81
- /**
82
- * Total number of tokens used in the request (prompt + completion).
83
- */
84
- total_tokens: number;
67
+ /**
68
+ * Number of tokens in the generated completion.
69
+ */
70
+ completion_tokens: number;
71
+ /**
72
+ * Number of tokens in the prompt.
73
+ */
74
+ prompt_tokens: number;
75
+ /**
76
+ * Total number of tokens used in the request (prompt + completion).
77
+ */
78
+ total_tokens: number;
85
79
  }
86
80
  export type CompletionCreateParams = CompletionCreateParamsNonStreaming | CompletionCreateParamsStreaming;
87
81
  export interface CompletionCreateParamsBase {
88
- /**
89
- * ID of the model to use. You can use the
90
- * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
91
- * see all of your available models, or see our
92
- * [Model overview](https://platform.openai.com/docs/models/overview) for
93
- * descriptions of them.
94
- */
95
- model:
96
- | (string & {})
97
- | 'babbage-002'
98
- | 'davinci-002'
99
- | 'text-davinci-003'
100
- | 'text-davinci-002'
101
- | 'text-davinci-001'
102
- | 'code-davinci-002'
103
- | 'text-curie-001'
104
- | 'text-babbage-001'
105
- | 'text-ada-001';
106
- /**
107
- * The prompt(s) to generate completions for, encoded as a string, array of
108
- * strings, array of tokens, or array of token arrays.
109
- *
110
- * Note that <|endoftext|> is the document separator that the model sees during
111
- * training, so if a prompt is not specified the model will generate as if from the
112
- * beginning of a new document.
113
- */
114
- prompt: string | Array<string> | Array<number> | Array<Array<number>> | null;
115
- /**
116
- * Generates `best_of` completions server-side and returns the "best" (the one with
117
- * the highest log probability per token). Results cannot be streamed.
118
- *
119
- * When used with `n`, `best_of` controls the number of candidate completions and
120
- * `n` specifies how many to return – `best_of` must be greater than `n`.
121
- *
122
- * **Note:** Because this parameter generates many completions, it can quickly
123
- * consume your token quota. Use carefully and ensure that you have reasonable
124
- * settings for `max_tokens` and `stop`.
125
- */
126
- best_of?: number | null;
127
- /**
128
- * Echo back the prompt in addition to the completion
129
- */
130
- echo?: boolean | null;
131
- /**
132
- * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
133
- * existing frequency in the text so far, decreasing the model's likelihood to
134
- * repeat the same line verbatim.
135
- *
136
- * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/gpt/parameter-details)
137
- */
138
- frequency_penalty?: number | null;
139
- /**
140
- * Modify the likelihood of specified tokens appearing in the completion.
141
- *
142
- * Accepts a json object that maps tokens (specified by their token ID in the GPT
143
- * tokenizer) to an associated bias value from -100 to 100. You can use this
144
- * [tokenizer tool](/tokenizer?view=bpe) (which works for both GPT-2 and GPT-3) to
145
- * convert text to token IDs. Mathematically, the bias is added to the logits
146
- * generated by the model prior to sampling. The exact effect will vary per model,
147
- * but values between -1 and 1 should decrease or increase likelihood of selection;
148
- * values like -100 or 100 should result in a ban or exclusive selection of the
149
- * relevant token.
150
- *
151
- * As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
152
- * from being generated.
153
- */
154
- logit_bias?: Record<string, number> | null;
155
- /**
156
- * Include the log probabilities on the `logprobs` most likely tokens, as well the
157
- * chosen tokens. For example, if `logprobs` is 5, the API will return a list of
158
- * the 5 most likely tokens. The API will always return the `logprob` of the
159
- * sampled token, so there may be up to `logprobs+1` elements in the response.
160
- *
161
- * The maximum value for `logprobs` is 5.
162
- */
163
- logprobs?: number | null;
164
- /**
165
- * The maximum number of [tokens](/tokenizer) to generate in the completion.
166
- *
167
- * The token count of your prompt plus `max_tokens` cannot exceed the model's
168
- * context length.
169
- * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)
170
- * for counting tokens.
171
- */
172
- max_tokens?: number | null;
173
- /**
174
- * How many completions to generate for each prompt.
175
- *
176
- * **Note:** Because this parameter generates many completions, it can quickly
177
- * consume your token quota. Use carefully and ensure that you have reasonable
178
- * settings for `max_tokens` and `stop`.
179
- */
180
- n?: number | null;
181
- /**
182
- * Number between -2.0 and 2.0. Positive values penalize new tokens based on
183
- * whether they appear in the text so far, increasing the model's likelihood to
184
- * talk about new topics.
185
- *
186
- * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/gpt/parameter-details)
187
- */
188
- presence_penalty?: number | null;
189
- /**
190
- * Up to 4 sequences where the API will stop generating further tokens. The
191
- * returned text will not contain the stop sequence.
192
- */
193
- stop?: string | null | Array<string>;
194
- /**
195
- * Whether to stream back partial progress. If set, tokens will be sent as
196
- * data-only
197
- * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
198
- * as they become available, with the stream terminated by a `data: [DONE]`
199
- * message.
200
- * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).
201
- */
202
- stream?: boolean | null;
203
- /**
204
- * The suffix that comes after a completion of inserted text.
205
- */
206
- suffix?: string | null;
207
- /**
208
- * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
209
- * make the output more random, while lower values like 0.2 will make it more
210
- * focused and deterministic.
211
- *
212
- * We generally recommend altering this or `top_p` but not both.
213
- */
214
- temperature?: number | null;
215
- /**
216
- * An alternative to sampling with temperature, called nucleus sampling, where the
217
- * model considers the results of the tokens with top_p probability mass. So 0.1
218
- * means only the tokens comprising the top 10% probability mass are considered.
219
- *
220
- * We generally recommend altering this or `temperature` but not both.
221
- */
222
- top_p?: number | null;
223
- /**
224
- * A unique identifier representing your end-user, which can help OpenAI to monitor
225
- * and detect abuse.
226
- * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
227
- */
228
- user?: string;
82
+ /**
83
+ * ID of the model to use. You can use the
84
+ * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
85
+ * see all of your available models, or see our
86
+ * [Model overview](https://platform.openai.com/docs/models/overview) for
87
+ * descriptions of them.
88
+ */
89
+ model: (string & {}) | 'babbage-002' | 'davinci-002' | 'text-davinci-003' | 'text-davinci-002' | 'text-davinci-001' | 'code-davinci-002' | 'text-curie-001' | 'text-babbage-001' | 'text-ada-001';
90
+ /**
91
+ * The prompt(s) to generate completions for, encoded as a string, array of
92
+ * strings, array of tokens, or array of token arrays.
93
+ *
94
+ * Note that <|endoftext|> is the document separator that the model sees during
95
+ * training, so if a prompt is not specified the model will generate as if from the
96
+ * beginning of a new document.
97
+ */
98
+ prompt: string | Array<string> | Array<number> | Array<Array<number>> | null;
99
+ /**
100
+ * Generates `best_of` completions server-side and returns the "best" (the one with
101
+ * the highest log probability per token). Results cannot be streamed.
102
+ *
103
+ * When used with `n`, `best_of` controls the number of candidate completions and
104
+ * `n` specifies how many to return `best_of` must be greater than `n`.
105
+ *
106
+ * **Note:** Because this parameter generates many completions, it can quickly
107
+ * consume your token quota. Use carefully and ensure that you have reasonable
108
+ * settings for `max_tokens` and `stop`.
109
+ */
110
+ best_of?: number | null;
111
+ /**
112
+ * Echo back the prompt in addition to the completion
113
+ */
114
+ echo?: boolean | null;
115
+ /**
116
+ * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
117
+ * existing frequency in the text so far, decreasing the model's likelihood to
118
+ * repeat the same line verbatim.
119
+ *
120
+ * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/gpt/parameter-details)
121
+ */
122
+ frequency_penalty?: number | null;
123
+ /**
124
+ * Modify the likelihood of specified tokens appearing in the completion.
125
+ *
126
+ * Accepts a json object that maps tokens (specified by their token ID in the GPT
127
+ * tokenizer) to an associated bias value from -100 to 100. You can use this
128
+ * [tokenizer tool](/tokenizer?view=bpe) (which works for both GPT-2 and GPT-3) to
129
+ * convert text to token IDs. Mathematically, the bias is added to the logits
130
+ * generated by the model prior to sampling. The exact effect will vary per model,
131
+ * but values between -1 and 1 should decrease or increase likelihood of selection;
132
+ * values like -100 or 100 should result in a ban or exclusive selection of the
133
+ * relevant token.
134
+ *
135
+ * As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
136
+ * from being generated.
137
+ */
138
+ logit_bias?: Record<string, number> | null;
139
+ /**
140
+ * Include the log probabilities on the `logprobs` most likely tokens, as well the
141
+ * chosen tokens. For example, if `logprobs` is 5, the API will return a list of
142
+ * the 5 most likely tokens. The API will always return the `logprob` of the
143
+ * sampled token, so there may be up to `logprobs+1` elements in the response.
144
+ *
145
+ * The maximum value for `logprobs` is 5.
146
+ */
147
+ logprobs?: number | null;
148
+ /**
149
+ * The maximum number of [tokens](/tokenizer) to generate in the completion.
150
+ *
151
+ * The token count of your prompt plus `max_tokens` cannot exceed the model's
152
+ * context length.
153
+ * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)
154
+ * for counting tokens.
155
+ */
156
+ max_tokens?: number | null;
157
+ /**
158
+ * How many completions to generate for each prompt.
159
+ *
160
+ * **Note:** Because this parameter generates many completions, it can quickly
161
+ * consume your token quota. Use carefully and ensure that you have reasonable
162
+ * settings for `max_tokens` and `stop`.
163
+ */
164
+ n?: number | null;
165
+ /**
166
+ * Number between -2.0 and 2.0. Positive values penalize new tokens based on
167
+ * whether they appear in the text so far, increasing the model's likelihood to
168
+ * talk about new topics.
169
+ *
170
+ * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/gpt/parameter-details)
171
+ */
172
+ presence_penalty?: number | null;
173
+ /**
174
+ * Up to 4 sequences where the API will stop generating further tokens. The
175
+ * returned text will not contain the stop sequence.
176
+ */
177
+ stop?: string | null | Array<string>;
178
+ /**
179
+ * Whether to stream back partial progress. If set, tokens will be sent as
180
+ * data-only
181
+ * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
182
+ * as they become available, with the stream terminated by a `data: [DONE]`
183
+ * message.
184
+ * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).
185
+ */
186
+ stream?: boolean | null;
187
+ /**
188
+ * The suffix that comes after a completion of inserted text.
189
+ */
190
+ suffix?: string | null;
191
+ /**
192
+ * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
193
+ * make the output more random, while lower values like 0.2 will make it more
194
+ * focused and deterministic.
195
+ *
196
+ * We generally recommend altering this or `top_p` but not both.
197
+ */
198
+ temperature?: number | null;
199
+ /**
200
+ * An alternative to sampling with temperature, called nucleus sampling, where the
201
+ * model considers the results of the tokens with top_p probability mass. So 0.1
202
+ * means only the tokens comprising the top 10% probability mass are considered.
203
+ *
204
+ * We generally recommend altering this or `temperature` but not both.
205
+ */
206
+ top_p?: number | null;
207
+ /**
208
+ * A unique identifier representing your end-user, which can help OpenAI to monitor
209
+ * and detect abuse.
210
+ * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
211
+ */
212
+ user?: string;
229
213
  }
230
214
  export declare namespace CompletionCreateParams {
231
- type CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
232
- type CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
215
+ type CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
216
+ type CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
233
217
  }
234
218
  export interface CompletionCreateParamsNonStreaming extends CompletionCreateParamsBase {
235
- /**
236
- * Whether to stream back partial progress. If set, tokens will be sent as
237
- * data-only
238
- * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
239
- * as they become available, with the stream terminated by a `data: [DONE]`
240
- * message.
241
- * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).
242
- */
243
- stream?: false | null;
219
+ /**
220
+ * Whether to stream back partial progress. If set, tokens will be sent as
221
+ * data-only
222
+ * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
223
+ * as they become available, with the stream terminated by a `data: [DONE]`
224
+ * message.
225
+ * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).
226
+ */
227
+ stream?: false | null;
244
228
  }
245
229
  export interface CompletionCreateParamsStreaming extends CompletionCreateParamsBase {
246
- /**
247
- * Whether to stream back partial progress. If set, tokens will be sent as
248
- * data-only
249
- * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
250
- * as they become available, with the stream terminated by a `data: [DONE]`
251
- * message.
252
- * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).
253
- */
254
- stream: true;
230
+ /**
231
+ * Whether to stream back partial progress. If set, tokens will be sent as
232
+ * data-only
233
+ * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
234
+ * as they become available, with the stream terminated by a `data: [DONE]`
235
+ * message.
236
+ * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).
237
+ */
238
+ stream: true;
255
239
  }
256
240
  export declare namespace Completions {
257
- export import Completion = API.Completion;
258
- export import CompletionChoice = API.CompletionChoice;
259
- export import CompletionUsage = API.CompletionUsage;
260
- export import CompletionCreateParams = API.CompletionCreateParams;
261
- export import CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
262
- export import CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
241
+ export import Completion = API.Completion;
242
+ export import CompletionChoice = API.CompletionChoice;
243
+ export import CompletionUsage = API.CompletionUsage;
244
+ export import CompletionCreateParams = API.CompletionCreateParams;
245
+ export import CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
246
+ export import CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
263
247
  }
264
- //# sourceMappingURL=completions.d.ts.map
248
+ //# sourceMappingURL=completions.d.ts.map
@@ -1,18 +1,15 @@
1
- 'use strict';
1
+ "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless.
3
- Object.defineProperty(exports, '__esModule', { value: true });
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Completions = void 0;
5
- const resource_1 = require('openai/resource');
5
+ const resource_1 = require("openai/resource");
6
6
  class Completions extends resource_1.APIResource {
7
- create(body, options) {
8
- var _a;
9
- return this.post('/completions', {
10
- body,
11
- ...options,
12
- stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false,
13
- });
14
- }
7
+ create(body, options) {
8
+ var _a;
9
+ return this.post('/completions', { body, ...options, stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false });
10
+ }
15
11
  }
16
12
  exports.Completions = Completions;
17
- (function (Completions) {})((Completions = exports.Completions || (exports.Completions = {})));
18
- //# sourceMappingURL=completions.js.map
13
+ (function (Completions) {
14
+ })(Completions = exports.Completions || (exports.Completions = {}));
15
+ //# sourceMappingURL=completions.js.map