llama-stack-client 0.6.1 → 0.7.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 (332) hide show
  1. package/.github/workflows/ci.yml +16 -10
  2. package/.gitignore +1 -0
  3. package/.release-please-manifest.json +1 -1
  4. package/.stats.yml +4 -4
  5. package/CHANGELOG.md +80 -0
  6. package/CONTRIBUTING.md +2 -2
  7. package/README.md +22 -0
  8. package/api.md +1 -71
  9. package/dist/CHANGELOG.md +80 -0
  10. package/dist/README.md +22 -0
  11. package/dist/core.d.ts +1 -1
  12. package/dist/core.d.ts.map +1 -1
  13. package/dist/core.js +8 -17
  14. package/dist/core.js.map +1 -1
  15. package/dist/core.mjs +8 -17
  16. package/dist/core.mjs.map +1 -1
  17. package/dist/index.d.mts +51 -12
  18. package/dist/index.d.ts +51 -12
  19. package/dist/index.d.ts.map +1 -1
  20. package/dist/index.js +50 -11
  21. package/dist/index.js.map +1 -1
  22. package/dist/index.mjs +50 -11
  23. package/dist/index.mjs.map +1 -1
  24. package/dist/internal/utils/query.d.ts +2 -0
  25. package/dist/internal/utils/query.d.ts.map +1 -0
  26. package/dist/{resources/alpha/post-training/post-training.js → internal/utils/query.js} +6 -24
  27. package/dist/internal/utils/query.js.map +1 -0
  28. package/dist/{resources/alpha/post-training.mjs → internal/utils/query.mjs} +5 -2
  29. package/dist/internal/utils/query.mjs.map +1 -0
  30. package/dist/package.json +1 -1
  31. package/dist/resources/alpha/alpha.d.ts +0 -4
  32. package/dist/resources/alpha/alpha.d.ts.map +1 -1
  33. package/dist/resources/alpha/alpha.js +0 -4
  34. package/dist/resources/alpha/alpha.js.map +1 -1
  35. package/dist/resources/alpha/alpha.mjs +0 -4
  36. package/dist/resources/alpha/alpha.mjs.map +1 -1
  37. package/dist/resources/alpha/eval/eval.d.ts +3 -0
  38. package/dist/resources/alpha/eval/eval.d.ts.map +1 -1
  39. package/dist/resources/alpha/eval/eval.js +3 -0
  40. package/dist/resources/alpha/eval/eval.js.map +1 -1
  41. package/dist/resources/alpha/eval/eval.mjs +3 -0
  42. package/dist/resources/alpha/eval/eval.mjs.map +1 -1
  43. package/dist/resources/alpha/eval/jobs.d.ts +3 -0
  44. package/dist/resources/alpha/eval/jobs.d.ts.map +1 -1
  45. package/dist/resources/alpha/eval/jobs.js +3 -0
  46. package/dist/resources/alpha/eval/jobs.js.map +1 -1
  47. package/dist/resources/alpha/eval/jobs.mjs +3 -0
  48. package/dist/resources/alpha/eval/jobs.mjs.map +1 -1
  49. package/dist/resources/alpha/index.d.ts +0 -1
  50. package/dist/resources/alpha/index.d.ts.map +1 -1
  51. package/dist/resources/alpha/index.js +1 -3
  52. package/dist/resources/alpha/index.js.map +1 -1
  53. package/dist/resources/alpha/index.mjs +0 -1
  54. package/dist/resources/alpha/index.mjs.map +1 -1
  55. package/dist/resources/alpha/inference.d.ts +8 -0
  56. package/dist/resources/alpha/inference.d.ts.map +1 -1
  57. package/dist/resources/alpha/inference.js +8 -0
  58. package/dist/resources/alpha/inference.js.map +1 -1
  59. package/dist/resources/alpha/inference.mjs +8 -0
  60. package/dist/resources/alpha/inference.mjs.map +1 -1
  61. package/dist/resources/batches.d.ts +8 -0
  62. package/dist/resources/batches.d.ts.map +1 -1
  63. package/dist/resources/batches.js +8 -0
  64. package/dist/resources/batches.js.map +1 -1
  65. package/dist/resources/batches.mjs +8 -0
  66. package/dist/resources/batches.mjs.map +1 -1
  67. package/dist/resources/beta/datasets.d.ts +4 -8
  68. package/dist/resources/beta/datasets.d.ts.map +1 -1
  69. package/dist/resources/chat/chat.d.ts +34 -32
  70. package/dist/resources/chat/chat.d.ts.map +1 -1
  71. package/dist/resources/chat/chat.js.map +1 -1
  72. package/dist/resources/chat/chat.mjs.map +1 -1
  73. package/dist/resources/chat/completions.d.ts +321 -713
  74. package/dist/resources/chat/completions.d.ts.map +1 -1
  75. package/dist/resources/chat/completions.js +8 -0
  76. package/dist/resources/chat/completions.js.map +1 -1
  77. package/dist/resources/chat/completions.mjs +8 -0
  78. package/dist/resources/chat/completions.mjs.map +1 -1
  79. package/dist/resources/completions.d.ts +10 -4
  80. package/dist/resources/completions.d.ts.map +1 -1
  81. package/dist/resources/completions.js +8 -0
  82. package/dist/resources/completions.js.map +1 -1
  83. package/dist/resources/completions.mjs +8 -0
  84. package/dist/resources/completions.mjs.map +1 -1
  85. package/dist/resources/conversations/conversations.d.ts +95 -2
  86. package/dist/resources/conversations/conversations.d.ts.map +1 -1
  87. package/dist/resources/conversations/conversations.js +3 -0
  88. package/dist/resources/conversations/conversations.js.map +1 -1
  89. package/dist/resources/conversations/conversations.mjs +3 -0
  90. package/dist/resources/conversations/conversations.mjs.map +1 -1
  91. package/dist/resources/conversations/items.d.ts +371 -8
  92. package/dist/resources/conversations/items.d.ts.map +1 -1
  93. package/dist/resources/conversations/items.js +3 -0
  94. package/dist/resources/conversations/items.js.map +1 -1
  95. package/dist/resources/conversations/items.mjs +3 -0
  96. package/dist/resources/conversations/items.mjs.map +1 -1
  97. package/dist/resources/embeddings.d.ts +8 -0
  98. package/dist/resources/embeddings.d.ts.map +1 -1
  99. package/dist/resources/embeddings.js +8 -0
  100. package/dist/resources/embeddings.js.map +1 -1
  101. package/dist/resources/embeddings.mjs +8 -0
  102. package/dist/resources/embeddings.mjs.map +1 -1
  103. package/dist/resources/files.d.ts +11 -8
  104. package/dist/resources/files.d.ts.map +1 -1
  105. package/dist/resources/files.js +3 -0
  106. package/dist/resources/files.js.map +1 -1
  107. package/dist/resources/files.mjs +3 -0
  108. package/dist/resources/files.mjs.map +1 -1
  109. package/dist/resources/index.d.ts +1 -4
  110. package/dist/resources/index.d.ts.map +1 -1
  111. package/dist/resources/index.js +1 -7
  112. package/dist/resources/index.js.map +1 -1
  113. package/dist/resources/index.mjs +0 -3
  114. package/dist/resources/index.mjs.map +1 -1
  115. package/dist/resources/inspect.d.ts +3 -0
  116. package/dist/resources/inspect.d.ts.map +1 -1
  117. package/dist/resources/inspect.js +3 -0
  118. package/dist/resources/inspect.js.map +1 -1
  119. package/dist/resources/inspect.mjs +3 -0
  120. package/dist/resources/inspect.mjs.map +1 -1
  121. package/dist/resources/models/index.d.ts +1 -1
  122. package/dist/resources/models/index.d.ts.map +1 -1
  123. package/dist/resources/models/index.js.map +1 -1
  124. package/dist/resources/models/index.mjs.map +1 -1
  125. package/dist/resources/models/models.d.ts +7 -65
  126. package/dist/resources/models/models.d.ts.map +1 -1
  127. package/dist/resources/models/models.js +0 -19
  128. package/dist/resources/models/models.js.map +1 -1
  129. package/dist/resources/models/models.mjs +0 -19
  130. package/dist/resources/models/models.mjs.map +1 -1
  131. package/dist/resources/moderations.d.ts +3 -0
  132. package/dist/resources/moderations.d.ts.map +1 -1
  133. package/dist/resources/moderations.js +3 -0
  134. package/dist/resources/moderations.js.map +1 -1
  135. package/dist/resources/moderations.mjs +3 -0
  136. package/dist/resources/moderations.mjs.map +1 -1
  137. package/dist/resources/prompts/prompts.d.ts +3 -0
  138. package/dist/resources/prompts/prompts.d.ts.map +1 -1
  139. package/dist/resources/prompts/prompts.js +3 -0
  140. package/dist/resources/prompts/prompts.js.map +1 -1
  141. package/dist/resources/prompts/prompts.mjs +3 -0
  142. package/dist/resources/prompts/prompts.mjs.map +1 -1
  143. package/dist/resources/prompts/versions.d.ts +3 -0
  144. package/dist/resources/prompts/versions.d.ts.map +1 -1
  145. package/dist/resources/prompts/versions.js +3 -0
  146. package/dist/resources/prompts/versions.js.map +1 -1
  147. package/dist/resources/prompts/versions.mjs +3 -0
  148. package/dist/resources/prompts/versions.mjs.map +1 -1
  149. package/dist/resources/providers.d.ts +3 -0
  150. package/dist/resources/providers.d.ts.map +1 -1
  151. package/dist/resources/providers.js +3 -0
  152. package/dist/resources/providers.js.map +1 -1
  153. package/dist/resources/providers.mjs +3 -0
  154. package/dist/resources/providers.mjs.map +1 -1
  155. package/dist/resources/responses/input-items.d.ts +102 -3
  156. package/dist/resources/responses/input-items.d.ts.map +1 -1
  157. package/dist/resources/responses/responses.d.ts +582 -11
  158. package/dist/resources/responses/responses.d.ts.map +1 -1
  159. package/dist/resources/responses/responses.js.map +1 -1
  160. package/dist/resources/responses/responses.mjs.map +1 -1
  161. package/dist/resources/routes.d.ts +3 -0
  162. package/dist/resources/routes.d.ts.map +1 -1
  163. package/dist/resources/routes.js +3 -0
  164. package/dist/resources/routes.js.map +1 -1
  165. package/dist/resources/routes.mjs +3 -0
  166. package/dist/resources/routes.mjs.map +1 -1
  167. package/dist/resources/safety.d.ts +14 -11
  168. package/dist/resources/safety.d.ts.map +1 -1
  169. package/dist/resources/safety.js +3 -0
  170. package/dist/resources/safety.js.map +1 -1
  171. package/dist/resources/safety.mjs +3 -0
  172. package/dist/resources/safety.mjs.map +1 -1
  173. package/dist/resources/vector-io.d.ts +4 -4
  174. package/dist/resources/vector-stores/file-batches.d.ts +49 -1
  175. package/dist/resources/vector-stores/file-batches.d.ts.map +1 -1
  176. package/dist/resources/vector-stores/file-batches.js.map +1 -1
  177. package/dist/resources/vector-stores/file-batches.mjs.map +1 -1
  178. package/dist/resources/vector-stores/files.d.ts +100 -4
  179. package/dist/resources/vector-stores/files.d.ts.map +1 -1
  180. package/dist/resources/vector-stores/files.js.map +1 -1
  181. package/dist/resources/vector-stores/files.mjs.map +1 -1
  182. package/dist/resources/vector-stores/vector-stores.d.ts +51 -3
  183. package/dist/resources/vector-stores/vector-stores.d.ts.map +1 -1
  184. package/dist/resources/vector-stores/vector-stores.js.map +1 -1
  185. package/dist/resources/vector-stores/vector-stores.mjs.map +1 -1
  186. package/dist/src/core.ts +10 -21
  187. package/dist/src/index.ts +51 -48
  188. package/{src/resources/alpha/post-training.ts → dist/src/internal/utils/query.ts} +5 -1
  189. package/dist/src/resources/alpha/alpha.ts +0 -20
  190. package/dist/src/resources/alpha/eval/eval.ts +3 -0
  191. package/dist/src/resources/alpha/eval/jobs.ts +3 -0
  192. package/dist/src/resources/alpha/index.ts +0 -8
  193. package/dist/src/resources/alpha/inference.ts +8 -0
  194. package/dist/src/resources/batches.ts +8 -0
  195. package/dist/src/resources/beta/datasets.ts +4 -9
  196. package/dist/src/resources/chat/chat.ts +36 -33
  197. package/dist/src/resources/chat/completions.ts +307 -811
  198. package/dist/src/resources/completions.ts +10 -4
  199. package/dist/src/resources/conversations/conversations.ts +121 -1
  200. package/dist/src/resources/conversations/items.ts +477 -6
  201. package/dist/src/resources/embeddings.ts +8 -0
  202. package/dist/src/resources/files.ts +12 -9
  203. package/dist/src/resources/index.ts +0 -18
  204. package/dist/src/resources/inspect.ts +3 -0
  205. package/dist/src/resources/models/index.ts +0 -2
  206. package/dist/src/resources/models/models.ts +7 -82
  207. package/dist/src/resources/moderations.ts +3 -0
  208. package/dist/src/resources/prompts/prompts.ts +3 -0
  209. package/dist/src/resources/prompts/versions.ts +3 -0
  210. package/dist/src/resources/providers.ts +3 -0
  211. package/dist/src/resources/responses/input-items.ts +128 -2
  212. package/dist/src/resources/responses/responses.ts +706 -7
  213. package/dist/src/resources/routes.ts +3 -0
  214. package/dist/src/resources/safety.ts +15 -12
  215. package/dist/src/resources/vector-io.ts +4 -4
  216. package/dist/src/resources/vector-stores/file-batches.ts +57 -0
  217. package/dist/src/resources/vector-stores/files.ts +117 -3
  218. package/dist/src/resources/vector-stores/vector-stores.ts +59 -2
  219. package/dist/src/streaming.ts +24 -6
  220. package/dist/src/version.ts +1 -1
  221. package/dist/streaming.d.ts.map +1 -1
  222. package/dist/streaming.js +21 -6
  223. package/dist/streaming.js.map +1 -1
  224. package/dist/streaming.mjs +21 -6
  225. package/dist/streaming.mjs.map +1 -1
  226. package/dist/version.d.ts +1 -1
  227. package/dist/version.js +1 -1
  228. package/dist/version.mjs +1 -1
  229. package/package.json +1 -1
  230. package/scripts/mock +21 -10
  231. package/scripts/test +8 -8
  232. package/src/core.ts +10 -21
  233. package/src/index.ts +51 -48
  234. package/{dist/src/resources/alpha/post-training.ts → src/internal/utils/query.ts} +5 -1
  235. package/src/resources/alpha/alpha.ts +0 -20
  236. package/src/resources/alpha/eval/eval.ts +3 -0
  237. package/src/resources/alpha/eval/jobs.ts +3 -0
  238. package/src/resources/alpha/index.ts +0 -8
  239. package/src/resources/alpha/inference.ts +8 -0
  240. package/src/resources/batches.ts +8 -0
  241. package/src/resources/beta/datasets.ts +4 -9
  242. package/src/resources/chat/chat.ts +36 -33
  243. package/src/resources/chat/completions.ts +307 -811
  244. package/src/resources/completions.ts +10 -4
  245. package/src/resources/conversations/conversations.ts +121 -1
  246. package/src/resources/conversations/items.ts +477 -6
  247. package/src/resources/embeddings.ts +8 -0
  248. package/src/resources/files.ts +12 -9
  249. package/src/resources/index.ts +0 -18
  250. package/src/resources/inspect.ts +3 -0
  251. package/src/resources/models/index.ts +0 -2
  252. package/src/resources/models/models.ts +7 -82
  253. package/src/resources/moderations.ts +3 -0
  254. package/src/resources/prompts/prompts.ts +3 -0
  255. package/src/resources/prompts/versions.ts +3 -0
  256. package/src/resources/providers.ts +3 -0
  257. package/src/resources/responses/input-items.ts +128 -2
  258. package/src/resources/responses/responses.ts +706 -7
  259. package/src/resources/routes.ts +3 -0
  260. package/src/resources/safety.ts +15 -12
  261. package/src/resources/vector-io.ts +4 -4
  262. package/src/resources/vector-stores/file-batches.ts +57 -0
  263. package/src/resources/vector-stores/files.ts +117 -3
  264. package/src/resources/vector-stores/vector-stores.ts +59 -2
  265. package/src/streaming.ts +24 -6
  266. package/src/version.ts +1 -1
  267. package/tests/api-resources/beta/datasets.test.ts +4 -10
  268. package/tests/api-resources/chat/completions.test.ts +2 -0
  269. package/tests/api-resources/files.test.ts +2 -2
  270. package/tests/api-resources/models/models.test.ts +0 -39
  271. package/tests/api-resources/responses/responses.test.ts +10 -1
  272. package/tests/api-resources/vector-stores/file-batches.test.ts +1 -1
  273. package/tests/api-resources/vector-stores/files.test.ts +1 -1
  274. package/tests/api-resources/vector-stores/vector-stores.test.ts +1 -1
  275. package/tests/stringifyQuery.test.ts +2 -4
  276. package/dist/resources/alpha/post-training/index.d.ts +0 -3
  277. package/dist/resources/alpha/post-training/index.d.ts.map +0 -1
  278. package/dist/resources/alpha/post-training/index.js +0 -15
  279. package/dist/resources/alpha/post-training/index.js.map +0 -1
  280. package/dist/resources/alpha/post-training/index.mjs +0 -10
  281. package/dist/resources/alpha/post-training/index.mjs.map +0 -1
  282. package/dist/resources/alpha/post-training/job.d.ts +0 -104
  283. package/dist/resources/alpha/post-training/job.d.ts.map +0 -1
  284. package/dist/resources/alpha/post-training/job.js +0 -42
  285. package/dist/resources/alpha/post-training/job.js.map +0 -1
  286. package/dist/resources/alpha/post-training/job.mjs +0 -38
  287. package/dist/resources/alpha/post-training/job.mjs.map +0 -1
  288. package/dist/resources/alpha/post-training/post-training.d.ts +0 -269
  289. package/dist/resources/alpha/post-training/post-training.d.ts.map +0 -1
  290. package/dist/resources/alpha/post-training/post-training.js.map +0 -1
  291. package/dist/resources/alpha/post-training/post-training.mjs +0 -30
  292. package/dist/resources/alpha/post-training/post-training.mjs.map +0 -1
  293. package/dist/resources/alpha/post-training.d.ts +0 -2
  294. package/dist/resources/alpha/post-training.d.ts.map +0 -1
  295. package/dist/resources/alpha/post-training.js +0 -25
  296. package/dist/resources/alpha/post-training.js.map +0 -1
  297. package/dist/resources/alpha/post-training.mjs.map +0 -1
  298. package/dist/resources/tool-runtime.d.ts +0 -152
  299. package/dist/resources/tool-runtime.d.ts.map +0 -1
  300. package/dist/resources/tool-runtime.js +0 -30
  301. package/dist/resources/tool-runtime.js.map +0 -1
  302. package/dist/resources/tool-runtime.mjs +0 -26
  303. package/dist/resources/tool-runtime.mjs.map +0 -1
  304. package/dist/resources/toolgroups.d.ts +0 -91
  305. package/dist/resources/toolgroups.d.ts.map +0 -1
  306. package/dist/resources/toolgroups.js +0 -54
  307. package/dist/resources/toolgroups.js.map +0 -1
  308. package/dist/resources/toolgroups.mjs +0 -50
  309. package/dist/resources/toolgroups.mjs.map +0 -1
  310. package/dist/resources/tools.d.ts +0 -26
  311. package/dist/resources/tools.d.ts.map +0 -1
  312. package/dist/resources/tools.js +0 -30
  313. package/dist/resources/tools.js.map +0 -1
  314. package/dist/resources/tools.mjs +0 -26
  315. package/dist/resources/tools.mjs.map +0 -1
  316. package/dist/src/resources/alpha/post-training/index.ts +0 -17
  317. package/dist/src/resources/alpha/post-training/job.ts +0 -161
  318. package/dist/src/resources/alpha/post-training/post-training.ts +0 -385
  319. package/dist/src/resources/tool-runtime.ts +0 -217
  320. package/dist/src/resources/toolgroups.ts +0 -135
  321. package/dist/src/resources/tools.ts +0 -52
  322. package/src/resources/alpha/post-training/index.ts +0 -17
  323. package/src/resources/alpha/post-training/job.ts +0 -161
  324. package/src/resources/alpha/post-training/post-training.ts +0 -385
  325. package/src/resources/tool-runtime.ts +0 -217
  326. package/src/resources/toolgroups.ts +0 -135
  327. package/src/resources/tools.ts +0 -52
  328. package/tests/api-resources/alpha/post-training/job.test.ts +0 -86
  329. package/tests/api-resources/alpha/post-training/post-training.test.ts +0 -134
  330. package/tests/api-resources/tool-runtime.test.ts +0 -68
  331. package/tests/api-resources/toolgroups.test.ts +0 -91
  332. package/tests/api-resources/tools.test.ts +0 -57
@@ -10,6 +10,9 @@ import { APIResource } from '../../../resource';
10
10
  import * as Core from '../../../core';
11
11
  import * as EvalAPI from './eval';
12
12
 
13
+ /**
14
+ * Llama Stack Evaluation API for running evaluations on model and agent candidates.
15
+ */
13
16
  export class Jobs extends APIResource {
14
17
  /**
15
18
  * Get the result of a job.
@@ -26,11 +26,3 @@ export {
26
26
  type EvalRunEvalAlphaParams,
27
27
  } from './eval/index';
28
28
  export { Inference, type InferenceRerankResponse, type InferenceRerankParams } from './inference';
29
- export {
30
- PostTraining,
31
- type AlgorithmConfig,
32
- type ListPostTrainingJobsResponse,
33
- type PostTrainingJob,
34
- type PostTrainingPreferenceOptimizeParams,
35
- type PostTrainingSupervisedFineTuneParams,
36
- } from './post-training/index';
@@ -9,6 +9,14 @@
9
9
  import { APIResource } from '../../resource';
10
10
  import * as Core from '../../core';
11
11
 
12
+ /**
13
+ * Llama Stack Inference API for generating completions, chat completions, and embeddings.
14
+ *
15
+ * This API provides the raw interface to the underlying models. Three kinds of models are supported:
16
+ * - LLM models: these models generate "raw" and "chat" (conversational) completions.
17
+ * - Embedding models: these models generate embeddings to be used for semantic search.
18
+ * - Rerank models: these models reorder the documents based on their relevance to a query.
19
+ */
12
20
  export class Inference extends APIResource {
13
21
  /**
14
22
  * Rerank a list of documents based on their relevance to a query.
@@ -11,6 +11,14 @@ import { isRequestOptions } from '../core';
11
11
  import * as Core from '../core';
12
12
  import { OpenAICursorPage, type OpenAICursorPageParams } from '../pagination';
13
13
 
14
+ /**
15
+ * The API is designed to allow use of openai client libraries for seamless integration.
16
+ *
17
+ * This API provides the following extensions:
18
+ * - idempotent batch creation
19
+ *
20
+ * Note: This API is currently under active development and may undergo changes.
21
+ */
14
22
  export class Batches extends APIResource {
15
23
  /**
16
24
  * Create a new batch for processing multiple API requests.
@@ -124,7 +124,7 @@ export interface DatasetRetrieveResponse {
124
124
  /**
125
125
  * Purpose of the dataset indicating its intended use
126
126
  */
127
- purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
127
+ purpose: 'eval/question-answer' | 'eval/messages-answer';
128
128
 
129
129
  /**
130
130
  * Data source configuration for the dataset
@@ -205,7 +205,7 @@ export namespace DatasetListResponse {
205
205
  /**
206
206
  * Purpose of the dataset indicating its intended use
207
207
  */
208
- purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
208
+ purpose: 'eval/question-answer' | 'eval/messages-answer';
209
209
 
210
210
  /**
211
211
  * Data source configuration for the dataset
@@ -292,7 +292,7 @@ export interface DatasetRegisterResponse {
292
292
  /**
293
293
  * Purpose of the dataset indicating its intended use
294
294
  */
295
- purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
295
+ purpose: 'eval/question-answer' | 'eval/messages-answer';
296
296
 
297
297
  /**
298
298
  * Data source configuration for the dataset
@@ -351,11 +351,6 @@ export namespace DatasetRegisterResponse {
351
351
  }
352
352
 
353
353
  export interface DatasetAppendrowsParams {
354
- /**
355
- * The ID of the dataset to append the rows to.
356
- */
357
- body_dataset_id: string;
358
-
359
354
  /**
360
355
  * The rows to append to the dataset.
361
356
  */
@@ -378,7 +373,7 @@ export interface DatasetRegisterParams {
378
373
  /**
379
374
  * The purpose of the dataset.
380
375
  */
381
- purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
376
+ purpose: 'eval/question-answer' | 'eval/messages-answer';
382
377
 
383
378
  /**
384
379
  * The data source of the dataset.
@@ -53,7 +53,17 @@ export interface ChatCompletionChunk {
53
53
  object?: 'chat.completion.chunk';
54
54
 
55
55
  /**
56
- * Usage information for OpenAI chat completion.
56
+ * The service tier that was used for this response.
57
+ */
58
+ service_tier?: string | null;
59
+
60
+ /**
61
+ * System fingerprint for this completion chunk.
62
+ */
63
+ system_fingerprint?: string | null;
64
+
65
+ /**
66
+ * Token usage information (typically included in final chunk with stream_options).
57
67
  */
58
68
  usage?: ChatCompletionChunk.Usage | null;
59
69
  }
@@ -79,10 +89,9 @@ export namespace ChatCompletionChunk {
79
89
  finish_reason?: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call' | null;
80
90
 
81
91
  /**
82
- * The log probabilities for the tokens in the message from an OpenAI-compatible
83
- * chat completion response.
92
+ * The log probabilities for the tokens in the message.
84
93
  */
85
- logprobs?: Choice.Logprobs | null;
94
+ logprobs?: Choice.Logprobs;
86
95
  }
87
96
 
88
97
  export namespace Choice {
@@ -108,7 +117,7 @@ export namespace ChatCompletionChunk {
108
117
  /**
109
118
  * The role of the delta.
110
119
  */
111
- role?: string | null;
120
+ role?: 'developer' | 'system' | 'user' | 'assistant' | 'tool' | null;
112
121
 
113
122
  /**
114
123
  * The tool calls of the delta.
@@ -124,45 +133,39 @@ export namespace ChatCompletionChunk {
124
133
  /**
125
134
  * Unique identifier for the tool call.
126
135
  */
127
- id?: string | null;
136
+ id: string;
128
137
 
129
138
  /**
130
- * Function call details for OpenAI-compatible tool calls.
139
+ * Function call details.
131
140
  */
132
- function?: ToolCall.Function | null;
133
-
134
- /**
135
- * Index of the tool call in the list.
136
- */
137
- index?: number | null;
141
+ function: ToolCall.Function;
138
142
 
139
143
  /**
140
144
  * Must be 'function' to identify this as a function call.
141
145
  */
142
- type?: 'function';
146
+ type: 'function';
143
147
  }
144
148
 
145
149
  export namespace ToolCall {
146
150
  /**
147
- * Function call details for OpenAI-compatible tool calls.
151
+ * Function call details.
148
152
  */
149
153
  export interface Function {
150
154
  /**
151
155
  * Arguments to pass to the function as a JSON string.
152
156
  */
153
- arguments?: string | null;
157
+ arguments: string;
154
158
 
155
159
  /**
156
160
  * Name of the function to call.
157
161
  */
158
- name?: string | null;
162
+ name: string;
159
163
  }
160
164
  }
161
165
  }
162
166
 
163
167
  /**
164
- * The log probabilities for the tokens in the message from an OpenAI-compatible
165
- * chat completion response.
168
+ * The log probabilities for the tokens in the message.
166
169
  */
167
170
  export interface Logprobs {
168
171
  /**
@@ -278,54 +281,54 @@ export namespace ChatCompletionChunk {
278
281
  }
279
282
 
280
283
  /**
281
- * Usage information for OpenAI chat completion.
284
+ * Token usage information (typically included in final chunk with stream_options).
282
285
  */
283
286
  export interface Usage {
284
287
  /**
285
288
  * Number of tokens in the completion.
286
289
  */
287
- completion_tokens: number;
290
+ completion_tokens?: number;
288
291
 
289
292
  /**
290
- * Number of tokens in the prompt.
293
+ * Detailed breakdown of output token usage.
291
294
  */
292
- prompt_tokens: number;
295
+ completion_tokens_details?: Usage.CompletionTokensDetails;
293
296
 
294
297
  /**
295
- * Total tokens used (prompt + completion).
298
+ * Number of tokens in the prompt.
296
299
  */
297
- total_tokens: number;
300
+ prompt_tokens?: number;
298
301
 
299
302
  /**
300
- * Token details for output tokens in OpenAI chat completion usage.
303
+ * Detailed breakdown of input token usage.
301
304
  */
302
- completion_tokens_details?: Usage.CompletionTokensDetails | null;
305
+ prompt_tokens_details?: Usage.PromptTokensDetails;
303
306
 
304
307
  /**
305
- * Token details for prompt tokens in OpenAI chat completion usage.
308
+ * Total tokens used (prompt + completion).
306
309
  */
307
- prompt_tokens_details?: Usage.PromptTokensDetails | null;
310
+ total_tokens?: number;
308
311
  }
309
312
 
310
313
  export namespace Usage {
311
314
  /**
312
- * Token details for output tokens in OpenAI chat completion usage.
315
+ * Detailed breakdown of output token usage.
313
316
  */
314
317
  export interface CompletionTokensDetails {
315
318
  /**
316
319
  * Number of tokens used for reasoning (o1/o3 models).
317
320
  */
318
- reasoning_tokens?: number | null;
321
+ reasoning_tokens?: number;
319
322
  }
320
323
 
321
324
  /**
322
- * Token details for prompt tokens in OpenAI chat completion usage.
325
+ * Detailed breakdown of input token usage.
323
326
  */
324
327
  export interface PromptTokensDetails {
325
328
  /**
326
329
  * Number of tokens retrieved from cache.
327
330
  */
328
- cached_tokens?: number | null;
331
+ cached_tokens?: number;
329
332
  }
330
333
  }
331
334
  }