@azure/ai-projects 2.0.2 → 2.1.0

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 (534) hide show
  1. package/README.md +87 -1
  2. package/dist/browser/aiProjectClient.d.ts +8 -4
  3. package/dist/browser/aiProjectClient.d.ts.map +1 -1
  4. package/dist/browser/aiProjectClient.js +39 -7
  5. package/dist/browser/aiProjectClient.js.map +1 -1
  6. package/dist/browser/api/agents/operations.d.ts.map +1 -1
  7. package/dist/browser/api/agents/operations.js +33 -18
  8. package/dist/browser/api/agents/operations.js.map +1 -1
  9. package/dist/browser/api/agents/options.d.ts +11 -1
  10. package/dist/browser/api/agents/options.d.ts.map +1 -1
  11. package/dist/browser/api/agents/options.js.map +1 -1
  12. package/dist/browser/api/beta/agents/index.d.ts +3 -0
  13. package/dist/browser/api/beta/agents/index.d.ts.map +1 -0
  14. package/dist/browser/api/beta/agents/index.js +4 -0
  15. package/dist/browser/api/beta/agents/index.js.map +1 -0
  16. package/dist/browser/api/beta/agents/operations.d.ts +58 -0
  17. package/dist/browser/api/beta/agents/operations.d.ts.map +1 -0
  18. package/dist/browser/api/beta/agents/operations.js +340 -0
  19. package/dist/browser/api/beta/agents/operations.js.map +1 -0
  20. package/dist/browser/api/beta/agents/options.d.ts +78 -0
  21. package/dist/browser/api/beta/agents/options.d.ts.map +1 -0
  22. package/dist/browser/api/beta/agents/options.js +4 -0
  23. package/dist/browser/api/beta/agents/options.js.map +1 -0
  24. package/dist/browser/api/beta/evaluators/index.d.ts +2 -2
  25. package/dist/browser/api/beta/evaluators/index.d.ts.map +1 -1
  26. package/dist/browser/api/beta/evaluators/index.js +1 -1
  27. package/dist/browser/api/beta/evaluators/index.js.map +1 -1
  28. package/dist/browser/api/beta/evaluators/operations.d.ts +5 -5
  29. package/dist/browser/api/beta/evaluators/operations.d.ts.map +1 -1
  30. package/dist/browser/api/beta/evaluators/operations.js +5 -5
  31. package/dist/browser/api/beta/evaluators/operations.js.map +1 -1
  32. package/dist/browser/api/beta/evaluators/options.d.ts +1 -1
  33. package/dist/browser/api/beta/evaluators/options.d.ts.map +1 -1
  34. package/dist/browser/api/beta/evaluators/options.js.map +1 -1
  35. package/dist/browser/api/beta/insights/operations.d.ts +2 -2
  36. package/dist/browser/api/beta/insights/operations.d.ts.map +1 -1
  37. package/dist/browser/api/beta/insights/operations.js +15 -9
  38. package/dist/browser/api/beta/insights/operations.js.map +1 -1
  39. package/dist/browser/api/beta/memoryStores/options.d.ts +2 -2
  40. package/dist/browser/api/beta/memoryStores/options.d.ts.map +1 -1
  41. package/dist/browser/api/beta/memoryStores/options.js +1 -0
  42. package/dist/browser/api/beta/memoryStores/options.js.map +1 -1
  43. package/dist/browser/api/beta/schedules/operations.d.ts.map +1 -1
  44. package/dist/browser/api/beta/schedules/operations.js +4 -2
  45. package/dist/browser/api/beta/schedules/operations.js.map +1 -1
  46. package/dist/browser/api/beta/skills/index.d.ts +3 -0
  47. package/dist/browser/api/beta/skills/index.d.ts.map +1 -0
  48. package/dist/browser/api/beta/skills/index.js +4 -0
  49. package/dist/browser/api/beta/skills/index.js.map +1 -0
  50. package/dist/browser/api/beta/skills/operations.d.ts +34 -0
  51. package/dist/browser/api/beta/skills/operations.d.ts.map +1 -0
  52. package/dist/browser/api/beta/skills/operations.js +245 -0
  53. package/dist/browser/api/beta/skills/operations.js.map +1 -0
  54. package/dist/browser/api/beta/skills/options.d.ts +72 -0
  55. package/dist/browser/api/beta/skills/options.d.ts.map +1 -0
  56. package/dist/browser/api/beta/skills/options.js +4 -0
  57. package/dist/browser/api/beta/skills/options.js.map +1 -0
  58. package/dist/browser/api/beta/toolboxes/index.d.ts +3 -0
  59. package/dist/browser/api/beta/toolboxes/index.d.ts.map +1 -0
  60. package/dist/browser/api/beta/toolboxes/index.js +4 -0
  61. package/dist/browser/api/beta/toolboxes/index.js.map +1 -0
  62. package/dist/browser/api/beta/toolboxes/operations.d.ts +38 -0
  63. package/dist/browser/api/beta/toolboxes/operations.d.ts.map +1 -0
  64. package/dist/browser/api/beta/toolboxes/operations.js +273 -0
  65. package/dist/browser/api/beta/toolboxes/operations.js.map +1 -0
  66. package/dist/browser/api/beta/toolboxes/options.d.ts +77 -0
  67. package/dist/browser/api/beta/toolboxes/options.d.ts.map +1 -0
  68. package/dist/browser/api/beta/toolboxes/options.js +4 -0
  69. package/dist/browser/api/beta/toolboxes/options.js.map +1 -0
  70. package/dist/browser/api/evaluationRules/operations.d.ts.map +1 -1
  71. package/dist/browser/api/evaluationRules/operations.js +5 -24
  72. package/dist/browser/api/evaluationRules/operations.js.map +1 -1
  73. package/dist/browser/api/evaluationRules/options.d.ts +0 -8
  74. package/dist/browser/api/evaluationRules/options.d.ts.map +1 -1
  75. package/dist/browser/api/evaluationRules/options.js.map +1 -1
  76. package/dist/browser/api/index.d.ts +1 -1
  77. package/dist/browser/api/index.d.ts.map +1 -1
  78. package/dist/browser/api/index.js.map +1 -1
  79. package/dist/browser/api/telemetry/operations.d.ts +1 -1
  80. package/dist/browser/api/telemetry/operations.d.ts.map +1 -1
  81. package/dist/browser/api/telemetry/operations.js.map +1 -1
  82. package/dist/browser/azureAgent.interface.d.ts +25 -0
  83. package/dist/browser/azureAgent.interface.d.ts.map +1 -0
  84. package/dist/browser/azureAgent.interface.js +4 -0
  85. package/dist/browser/azureAgent.interface.js.map +1 -0
  86. package/dist/browser/classic/beta/agents/index.d.ts +43 -0
  87. package/dist/browser/classic/beta/agents/index.d.ts.map +1 -0
  88. package/dist/browser/classic/beta/agents/index.js +22 -0
  89. package/dist/browser/classic/beta/agents/index.js.map +1 -0
  90. package/dist/browser/classic/beta/evaluators/index.d.ts +2 -2
  91. package/dist/browser/classic/beta/evaluators/index.d.ts.map +1 -1
  92. package/dist/browser/classic/beta/evaluators/index.js +2 -2
  93. package/dist/browser/classic/beta/evaluators/index.js.map +1 -1
  94. package/dist/browser/classic/beta/index.d.ts +10 -1
  95. package/dist/browser/classic/beta/index.d.ts.map +1 -1
  96. package/dist/browser/classic/beta/index.js +10 -1
  97. package/dist/browser/classic/beta/index.js.map +1 -1
  98. package/dist/browser/classic/beta/insights/index.d.ts +1 -1
  99. package/dist/browser/classic/beta/insights/index.d.ts.map +1 -1
  100. package/dist/browser/classic/beta/insights/index.js +1 -1
  101. package/dist/browser/classic/beta/insights/index.js.map +1 -1
  102. package/dist/browser/classic/beta/skills/index.d.ts +23 -0
  103. package/dist/browser/classic/beta/skills/index.d.ts.map +1 -0
  104. package/dist/browser/classic/beta/skills/index.js +20 -0
  105. package/dist/browser/classic/beta/skills/index.js.map +1 -0
  106. package/dist/browser/classic/beta/toolboxes/index.d.ts +25 -0
  107. package/dist/browser/classic/beta/toolboxes/index.d.ts.map +1 -0
  108. package/dist/browser/classic/beta/toolboxes/index.js +21 -0
  109. package/dist/browser/classic/beta/toolboxes/index.js.map +1 -0
  110. package/dist/browser/classic/index.d.ts +3 -0
  111. package/dist/browser/classic/index.d.ts.map +1 -1
  112. package/dist/browser/classic/index.js.map +1 -1
  113. package/dist/browser/classic/telemetry/index.d.ts +1 -1
  114. package/dist/browser/classic/telemetry/index.d.ts.map +1 -1
  115. package/dist/browser/classic/telemetry/index.js.map +1 -1
  116. package/dist/browser/deprecate.interface.d.ts +13 -0
  117. package/dist/browser/deprecate.interface.d.ts.map +1 -0
  118. package/dist/browser/deprecate.interface.js +4 -0
  119. package/dist/browser/deprecate.interface.js.map +1 -0
  120. package/dist/browser/index.d.ts +9 -3
  121. package/dist/browser/index.d.ts.map +1 -1
  122. package/dist/browser/index.js +1 -0
  123. package/dist/browser/index.js.map +1 -1
  124. package/dist/browser/models/index.d.ts +1 -1
  125. package/dist/browser/models/index.d.ts.map +1 -1
  126. package/dist/browser/models/index.js.map +1 -1
  127. package/dist/browser/models/models.d.ts +704 -157
  128. package/dist/browser/models/models.d.ts.map +1 -1
  129. package/dist/browser/models/models.js +931 -176
  130. package/dist/browser/models/models.js.map +1 -1
  131. package/dist/browser/static-helpers/serialization/get-binary-stream-response.d.ts +12 -0
  132. package/dist/browser/static-helpers/serialization/get-binary-stream-response.d.ts.map +1 -0
  133. package/dist/browser/static-helpers/serialization/get-binary-stream-response.js +17 -0
  134. package/dist/browser/static-helpers/serialization/get-binary-stream-response.js.map +1 -0
  135. package/dist/commonjs/aiProjectClient.d.ts +8 -4
  136. package/dist/commonjs/aiProjectClient.d.ts.map +1 -1
  137. package/dist/commonjs/aiProjectClient.js +36 -5
  138. package/dist/commonjs/aiProjectClient.js.map +2 -2
  139. package/dist/commonjs/api/agents/operations.d.ts.map +1 -1
  140. package/dist/commonjs/api/agents/operations.js +25 -20
  141. package/dist/commonjs/api/agents/operations.js.map +2 -2
  142. package/dist/commonjs/api/agents/options.d.ts +11 -1
  143. package/dist/commonjs/api/agents/options.d.ts.map +1 -1
  144. package/dist/commonjs/api/agents/options.js.map +1 -1
  145. package/dist/commonjs/api/beta/agents/index.d.ts +3 -0
  146. package/dist/commonjs/api/beta/agents/index.d.ts.map +1 -0
  147. package/dist/commonjs/api/beta/agents/index.js +44 -0
  148. package/dist/commonjs/api/beta/agents/index.js.map +7 -0
  149. package/dist/commonjs/api/beta/agents/operations.d.ts +58 -0
  150. package/dist/commonjs/api/beta/agents/operations.d.ts.map +1 -0
  151. package/dist/commonjs/api/beta/agents/operations.js +442 -0
  152. package/dist/commonjs/api/beta/agents/operations.js.map +7 -0
  153. package/dist/commonjs/api/beta/agents/options.d.ts +78 -0
  154. package/dist/commonjs/api/beta/agents/options.d.ts.map +1 -0
  155. package/dist/commonjs/api/beta/agents/options.js +16 -0
  156. package/dist/commonjs/api/beta/agents/options.js.map +7 -0
  157. package/dist/commonjs/api/beta/evaluators/index.d.ts +2 -2
  158. package/dist/commonjs/api/beta/evaluators/index.d.ts.map +1 -1
  159. package/dist/commonjs/api/beta/evaluators/index.js +2 -2
  160. package/dist/commonjs/api/beta/evaluators/index.js.map +1 -1
  161. package/dist/commonjs/api/beta/evaluators/operations.d.ts +5 -5
  162. package/dist/commonjs/api/beta/evaluators/operations.d.ts.map +1 -1
  163. package/dist/commonjs/api/beta/evaluators/operations.js +11 -11
  164. package/dist/commonjs/api/beta/evaluators/operations.js.map +2 -2
  165. package/dist/commonjs/api/beta/evaluators/options.d.ts +1 -1
  166. package/dist/commonjs/api/beta/evaluators/options.d.ts.map +1 -1
  167. package/dist/commonjs/api/beta/evaluators/options.js.map +1 -1
  168. package/dist/commonjs/api/beta/insights/operations.d.ts +2 -2
  169. package/dist/commonjs/api/beta/insights/operations.d.ts.map +1 -1
  170. package/dist/commonjs/api/beta/insights/operations.js +15 -9
  171. package/dist/commonjs/api/beta/insights/operations.js.map +2 -2
  172. package/dist/commonjs/api/beta/memoryStores/options.d.ts +2 -2
  173. package/dist/commonjs/api/beta/memoryStores/options.d.ts.map +1 -1
  174. package/dist/commonjs/api/beta/memoryStores/options.js.map +1 -1
  175. package/dist/commonjs/api/beta/schedules/operations.d.ts.map +1 -1
  176. package/dist/commonjs/api/beta/schedules/operations.js +5 -3
  177. package/dist/commonjs/api/beta/schedules/operations.js.map +2 -2
  178. package/dist/commonjs/api/beta/skills/index.d.ts +3 -0
  179. package/dist/commonjs/api/beta/skills/index.d.ts.map +1 -0
  180. package/dist/commonjs/api/beta/skills/index.js +40 -0
  181. package/dist/commonjs/api/beta/skills/index.js.map +7 -0
  182. package/dist/commonjs/api/beta/skills/operations.d.ts +34 -0
  183. package/dist/commonjs/api/beta/skills/operations.d.ts.map +1 -0
  184. package/dist/commonjs/api/beta/skills/operations.js +336 -0
  185. package/dist/commonjs/api/beta/skills/operations.js.map +7 -0
  186. package/dist/commonjs/api/beta/skills/options.d.ts +72 -0
  187. package/dist/commonjs/api/beta/skills/options.d.ts.map +1 -0
  188. package/dist/commonjs/api/beta/skills/options.js +16 -0
  189. package/dist/commonjs/api/beta/skills/options.js.map +7 -0
  190. package/dist/commonjs/api/beta/toolboxes/index.d.ts +3 -0
  191. package/dist/commonjs/api/beta/toolboxes/index.d.ts.map +1 -0
  192. package/dist/commonjs/api/beta/toolboxes/index.js +42 -0
  193. package/dist/commonjs/api/beta/toolboxes/index.js.map +7 -0
  194. package/dist/commonjs/api/beta/toolboxes/operations.d.ts +38 -0
  195. package/dist/commonjs/api/beta/toolboxes/operations.d.ts.map +1 -0
  196. package/dist/commonjs/api/beta/toolboxes/operations.js +377 -0
  197. package/dist/commonjs/api/beta/toolboxes/operations.js.map +7 -0
  198. package/dist/commonjs/api/beta/toolboxes/options.d.ts +77 -0
  199. package/dist/commonjs/api/beta/toolboxes/options.d.ts.map +1 -0
  200. package/dist/commonjs/api/beta/toolboxes/options.js +16 -0
  201. package/dist/commonjs/api/beta/toolboxes/options.js.map +7 -0
  202. package/dist/commonjs/api/evaluationRules/operations.d.ts.map +1 -1
  203. package/dist/commonjs/api/evaluationRules/operations.js +5 -14
  204. package/dist/commonjs/api/evaluationRules/operations.js.map +2 -2
  205. package/dist/commonjs/api/evaluationRules/options.d.ts +0 -8
  206. package/dist/commonjs/api/evaluationRules/options.d.ts.map +1 -1
  207. package/dist/commonjs/api/evaluationRules/options.js.map +1 -1
  208. package/dist/commonjs/api/index.d.ts +1 -1
  209. package/dist/commonjs/api/index.d.ts.map +1 -1
  210. package/dist/commonjs/api/index.js.map +1 -1
  211. package/dist/commonjs/api/telemetry/operations.d.ts +1 -1
  212. package/dist/commonjs/api/telemetry/operations.d.ts.map +1 -1
  213. package/dist/commonjs/api/telemetry/operations.js.map +1 -1
  214. package/dist/commonjs/azureAgent.interface.d.ts +25 -0
  215. package/dist/commonjs/azureAgent.interface.d.ts.map +1 -0
  216. package/dist/commonjs/azureAgent.interface.js +16 -0
  217. package/dist/commonjs/azureAgent.interface.js.map +7 -0
  218. package/dist/commonjs/classic/beta/agents/index.d.ts +43 -0
  219. package/dist/commonjs/classic/beta/agents/index.d.ts.map +1 -0
  220. package/dist/commonjs/classic/beta/agents/index.js +46 -0
  221. package/dist/commonjs/classic/beta/agents/index.js.map +7 -0
  222. package/dist/commonjs/classic/beta/evaluators/index.d.ts +2 -2
  223. package/dist/commonjs/classic/beta/evaluators/index.d.ts.map +1 -1
  224. package/dist/commonjs/classic/beta/evaluators/index.js +1 -1
  225. package/dist/commonjs/classic/beta/evaluators/index.js.map +2 -2
  226. package/dist/commonjs/classic/beta/index.d.ts +10 -1
  227. package/dist/commonjs/classic/beta/index.d.ts.map +1 -1
  228. package/dist/commonjs/classic/beta/index.js +11 -2
  229. package/dist/commonjs/classic/beta/index.js.map +2 -2
  230. package/dist/commonjs/classic/beta/insights/index.d.ts +1 -1
  231. package/dist/commonjs/classic/beta/insights/index.d.ts.map +1 -1
  232. package/dist/commonjs/classic/beta/insights/index.js +1 -1
  233. package/dist/commonjs/classic/beta/insights/index.js.map +2 -2
  234. package/dist/commonjs/classic/beta/skills/index.d.ts +23 -0
  235. package/dist/commonjs/classic/beta/skills/index.d.ts.map +1 -0
  236. package/dist/commonjs/classic/beta/skills/index.js +44 -0
  237. package/dist/commonjs/classic/beta/skills/index.js.map +7 -0
  238. package/dist/commonjs/classic/beta/toolboxes/index.d.ts +25 -0
  239. package/dist/commonjs/classic/beta/toolboxes/index.d.ts.map +1 -0
  240. package/dist/commonjs/classic/beta/toolboxes/index.js +45 -0
  241. package/dist/commonjs/classic/beta/toolboxes/index.js.map +7 -0
  242. package/dist/commonjs/classic/index.d.ts +3 -0
  243. package/dist/commonjs/classic/index.d.ts.map +1 -1
  244. package/dist/commonjs/classic/index.js.map +1 -1
  245. package/dist/commonjs/classic/telemetry/index.d.ts +1 -1
  246. package/dist/commonjs/classic/telemetry/index.d.ts.map +1 -1
  247. package/dist/commonjs/classic/telemetry/index.js.map +1 -1
  248. package/dist/commonjs/deprecate.interface.d.ts +13 -0
  249. package/dist/commonjs/deprecate.interface.d.ts.map +1 -0
  250. package/dist/commonjs/deprecate.interface.js +16 -0
  251. package/dist/commonjs/deprecate.interface.js.map +7 -0
  252. package/dist/commonjs/index.d.ts +9 -3
  253. package/dist/commonjs/index.d.ts.map +1 -1
  254. package/dist/commonjs/index.js +5 -2
  255. package/dist/commonjs/index.js.map +2 -2
  256. package/dist/commonjs/models/index.d.ts +1 -1
  257. package/dist/commonjs/models/index.d.ts.map +1 -1
  258. package/dist/commonjs/models/index.js.map +1 -1
  259. package/dist/commonjs/models/models.d.ts +704 -157
  260. package/dist/commonjs/models/models.d.ts.map +1 -1
  261. package/dist/commonjs/models/models.js +1084 -207
  262. package/dist/commonjs/models/models.js.map +2 -2
  263. package/dist/commonjs/static-helpers/serialization/get-binary-stream-response.d.ts +12 -0
  264. package/dist/commonjs/static-helpers/serialization/get-binary-stream-response.d.ts.map +1 -0
  265. package/dist/commonjs/static-helpers/serialization/get-binary-stream-response.js +35 -0
  266. package/dist/commonjs/static-helpers/serialization/get-binary-stream-response.js.map +7 -0
  267. package/dist/commonjs/tsdoc-metadata.json +1 -1
  268. package/dist/esm/aiProjectClient.d.ts +8 -4
  269. package/dist/esm/aiProjectClient.d.ts.map +1 -1
  270. package/dist/esm/aiProjectClient.js +39 -7
  271. package/dist/esm/aiProjectClient.js.map +1 -1
  272. package/dist/esm/api/agents/operations.d.ts.map +1 -1
  273. package/dist/esm/api/agents/operations.js +33 -18
  274. package/dist/esm/api/agents/operations.js.map +1 -1
  275. package/dist/esm/api/agents/options.d.ts +11 -1
  276. package/dist/esm/api/agents/options.d.ts.map +1 -1
  277. package/dist/esm/api/agents/options.js.map +1 -1
  278. package/dist/esm/api/beta/agents/index.d.ts +3 -0
  279. package/dist/esm/api/beta/agents/index.d.ts.map +1 -0
  280. package/dist/esm/api/beta/agents/index.js +4 -0
  281. package/dist/esm/api/beta/agents/index.js.map +1 -0
  282. package/dist/esm/api/beta/agents/operations.d.ts +58 -0
  283. package/dist/esm/api/beta/agents/operations.d.ts.map +1 -0
  284. package/dist/esm/api/beta/agents/operations.js +340 -0
  285. package/dist/esm/api/beta/agents/operations.js.map +1 -0
  286. package/dist/esm/api/beta/agents/options.d.ts +78 -0
  287. package/dist/esm/api/beta/agents/options.d.ts.map +1 -0
  288. package/dist/esm/api/beta/agents/options.js +4 -0
  289. package/dist/esm/api/beta/agents/options.js.map +1 -0
  290. package/dist/esm/api/beta/evaluators/index.d.ts +2 -2
  291. package/dist/esm/api/beta/evaluators/index.d.ts.map +1 -1
  292. package/dist/esm/api/beta/evaluators/index.js +1 -1
  293. package/dist/esm/api/beta/evaluators/index.js.map +1 -1
  294. package/dist/esm/api/beta/evaluators/operations.d.ts +5 -5
  295. package/dist/esm/api/beta/evaluators/operations.d.ts.map +1 -1
  296. package/dist/esm/api/beta/evaluators/operations.js +5 -5
  297. package/dist/esm/api/beta/evaluators/operations.js.map +1 -1
  298. package/dist/esm/api/beta/evaluators/options.d.ts +1 -1
  299. package/dist/esm/api/beta/evaluators/options.d.ts.map +1 -1
  300. package/dist/esm/api/beta/evaluators/options.js.map +1 -1
  301. package/dist/esm/api/beta/insights/operations.d.ts +2 -2
  302. package/dist/esm/api/beta/insights/operations.d.ts.map +1 -1
  303. package/dist/esm/api/beta/insights/operations.js +15 -9
  304. package/dist/esm/api/beta/insights/operations.js.map +1 -1
  305. package/dist/esm/api/beta/memoryStores/options.d.ts +2 -2
  306. package/dist/esm/api/beta/memoryStores/options.d.ts.map +1 -1
  307. package/dist/esm/api/beta/memoryStores/options.js +1 -0
  308. package/dist/esm/api/beta/memoryStores/options.js.map +1 -1
  309. package/dist/esm/api/beta/schedules/operations.d.ts.map +1 -1
  310. package/dist/esm/api/beta/schedules/operations.js +4 -2
  311. package/dist/esm/api/beta/schedules/operations.js.map +1 -1
  312. package/dist/esm/api/beta/skills/index.d.ts +3 -0
  313. package/dist/esm/api/beta/skills/index.d.ts.map +1 -0
  314. package/dist/esm/api/beta/skills/index.js +4 -0
  315. package/dist/esm/api/beta/skills/index.js.map +1 -0
  316. package/dist/esm/api/beta/skills/operations.d.ts +34 -0
  317. package/dist/esm/api/beta/skills/operations.d.ts.map +1 -0
  318. package/dist/esm/api/beta/skills/operations.js +245 -0
  319. package/dist/esm/api/beta/skills/operations.js.map +1 -0
  320. package/dist/esm/api/beta/skills/options.d.ts +72 -0
  321. package/dist/esm/api/beta/skills/options.d.ts.map +1 -0
  322. package/dist/esm/api/beta/skills/options.js +4 -0
  323. package/dist/esm/api/beta/skills/options.js.map +1 -0
  324. package/dist/esm/api/beta/toolboxes/index.d.ts +3 -0
  325. package/dist/esm/api/beta/toolboxes/index.d.ts.map +1 -0
  326. package/dist/esm/api/beta/toolboxes/index.js +4 -0
  327. package/dist/esm/api/beta/toolboxes/index.js.map +1 -0
  328. package/dist/esm/api/beta/toolboxes/operations.d.ts +38 -0
  329. package/dist/esm/api/beta/toolboxes/operations.d.ts.map +1 -0
  330. package/dist/esm/api/beta/toolboxes/operations.js +273 -0
  331. package/dist/esm/api/beta/toolboxes/operations.js.map +1 -0
  332. package/dist/esm/api/beta/toolboxes/options.d.ts +77 -0
  333. package/dist/esm/api/beta/toolboxes/options.d.ts.map +1 -0
  334. package/dist/esm/api/beta/toolboxes/options.js +4 -0
  335. package/dist/esm/api/beta/toolboxes/options.js.map +1 -0
  336. package/dist/esm/api/evaluationRules/operations.d.ts.map +1 -1
  337. package/dist/esm/api/evaluationRules/operations.js +5 -24
  338. package/dist/esm/api/evaluationRules/operations.js.map +1 -1
  339. package/dist/esm/api/evaluationRules/options.d.ts +0 -8
  340. package/dist/esm/api/evaluationRules/options.d.ts.map +1 -1
  341. package/dist/esm/api/evaluationRules/options.js.map +1 -1
  342. package/dist/esm/api/index.d.ts +1 -1
  343. package/dist/esm/api/index.d.ts.map +1 -1
  344. package/dist/esm/api/index.js.map +1 -1
  345. package/dist/esm/api/telemetry/operations.d.ts +1 -1
  346. package/dist/esm/api/telemetry/operations.d.ts.map +1 -1
  347. package/dist/esm/api/telemetry/operations.js.map +1 -1
  348. package/dist/esm/azureAgent.interface.d.ts +25 -0
  349. package/dist/esm/azureAgent.interface.d.ts.map +1 -0
  350. package/dist/esm/azureAgent.interface.js +4 -0
  351. package/dist/esm/azureAgent.interface.js.map +1 -0
  352. package/dist/esm/classic/beta/agents/index.d.ts +43 -0
  353. package/dist/esm/classic/beta/agents/index.d.ts.map +1 -0
  354. package/dist/esm/classic/beta/agents/index.js +22 -0
  355. package/dist/esm/classic/beta/agents/index.js.map +1 -0
  356. package/dist/esm/classic/beta/evaluators/index.d.ts +2 -2
  357. package/dist/esm/classic/beta/evaluators/index.d.ts.map +1 -1
  358. package/dist/esm/classic/beta/evaluators/index.js +2 -2
  359. package/dist/esm/classic/beta/evaluators/index.js.map +1 -1
  360. package/dist/esm/classic/beta/index.d.ts +10 -1
  361. package/dist/esm/classic/beta/index.d.ts.map +1 -1
  362. package/dist/esm/classic/beta/index.js +10 -1
  363. package/dist/esm/classic/beta/index.js.map +1 -1
  364. package/dist/esm/classic/beta/insights/index.d.ts +1 -1
  365. package/dist/esm/classic/beta/insights/index.d.ts.map +1 -1
  366. package/dist/esm/classic/beta/insights/index.js +1 -1
  367. package/dist/esm/classic/beta/insights/index.js.map +1 -1
  368. package/dist/esm/classic/beta/skills/index.d.ts +23 -0
  369. package/dist/esm/classic/beta/skills/index.d.ts.map +1 -0
  370. package/dist/esm/classic/beta/skills/index.js +20 -0
  371. package/dist/esm/classic/beta/skills/index.js.map +1 -0
  372. package/dist/esm/classic/beta/toolboxes/index.d.ts +25 -0
  373. package/dist/esm/classic/beta/toolboxes/index.d.ts.map +1 -0
  374. package/dist/esm/classic/beta/toolboxes/index.js +21 -0
  375. package/dist/esm/classic/beta/toolboxes/index.js.map +1 -0
  376. package/dist/esm/classic/index.d.ts +3 -0
  377. package/dist/esm/classic/index.d.ts.map +1 -1
  378. package/dist/esm/classic/index.js.map +1 -1
  379. package/dist/esm/classic/telemetry/index.d.ts +1 -1
  380. package/dist/esm/classic/telemetry/index.d.ts.map +1 -1
  381. package/dist/esm/classic/telemetry/index.js.map +1 -1
  382. package/dist/esm/deprecate.interface.d.ts +13 -0
  383. package/dist/esm/deprecate.interface.d.ts.map +1 -0
  384. package/dist/esm/deprecate.interface.js +4 -0
  385. package/dist/esm/deprecate.interface.js.map +1 -0
  386. package/dist/esm/index.d.ts +9 -3
  387. package/dist/esm/index.d.ts.map +1 -1
  388. package/dist/esm/index.js +1 -0
  389. package/dist/esm/index.js.map +1 -1
  390. package/dist/esm/models/index.d.ts +1 -1
  391. package/dist/esm/models/index.d.ts.map +1 -1
  392. package/dist/esm/models/index.js.map +1 -1
  393. package/dist/esm/models/models.d.ts +704 -157
  394. package/dist/esm/models/models.d.ts.map +1 -1
  395. package/dist/esm/models/models.js +931 -176
  396. package/dist/esm/models/models.js.map +1 -1
  397. package/dist/esm/static-helpers/serialization/get-binary-stream-response.d.ts +12 -0
  398. package/dist/esm/static-helpers/serialization/get-binary-stream-response.d.ts.map +1 -0
  399. package/dist/esm/static-helpers/serialization/get-binary-stream-response.js +17 -0
  400. package/dist/esm/static-helpers/serialization/get-binary-stream-response.js.map +1 -0
  401. package/dist/react-native/aiProjectClient.d.ts +8 -4
  402. package/dist/react-native/aiProjectClient.d.ts.map +1 -1
  403. package/dist/react-native/aiProjectClient.js +39 -7
  404. package/dist/react-native/aiProjectClient.js.map +1 -1
  405. package/dist/react-native/api/agents/operations.d.ts.map +1 -1
  406. package/dist/react-native/api/agents/operations.js +33 -18
  407. package/dist/react-native/api/agents/operations.js.map +1 -1
  408. package/dist/react-native/api/agents/options.d.ts +11 -1
  409. package/dist/react-native/api/agents/options.d.ts.map +1 -1
  410. package/dist/react-native/api/agents/options.js.map +1 -1
  411. package/dist/react-native/api/beta/agents/index.d.ts +3 -0
  412. package/dist/react-native/api/beta/agents/index.d.ts.map +1 -0
  413. package/dist/react-native/api/beta/agents/index.js +4 -0
  414. package/dist/react-native/api/beta/agents/index.js.map +1 -0
  415. package/dist/react-native/api/beta/agents/operations.d.ts +58 -0
  416. package/dist/react-native/api/beta/agents/operations.d.ts.map +1 -0
  417. package/dist/react-native/api/beta/agents/operations.js +340 -0
  418. package/dist/react-native/api/beta/agents/operations.js.map +1 -0
  419. package/dist/react-native/api/beta/agents/options.d.ts +78 -0
  420. package/dist/react-native/api/beta/agents/options.d.ts.map +1 -0
  421. package/dist/react-native/api/beta/agents/options.js +4 -0
  422. package/dist/react-native/api/beta/agents/options.js.map +1 -0
  423. package/dist/react-native/api/beta/evaluators/index.d.ts +2 -2
  424. package/dist/react-native/api/beta/evaluators/index.d.ts.map +1 -1
  425. package/dist/react-native/api/beta/evaluators/index.js +1 -1
  426. package/dist/react-native/api/beta/evaluators/index.js.map +1 -1
  427. package/dist/react-native/api/beta/evaluators/operations.d.ts +5 -5
  428. package/dist/react-native/api/beta/evaluators/operations.d.ts.map +1 -1
  429. package/dist/react-native/api/beta/evaluators/operations.js +5 -5
  430. package/dist/react-native/api/beta/evaluators/operations.js.map +1 -1
  431. package/dist/react-native/api/beta/evaluators/options.d.ts +1 -1
  432. package/dist/react-native/api/beta/evaluators/options.d.ts.map +1 -1
  433. package/dist/react-native/api/beta/evaluators/options.js.map +1 -1
  434. package/dist/react-native/api/beta/insights/operations.d.ts +2 -2
  435. package/dist/react-native/api/beta/insights/operations.d.ts.map +1 -1
  436. package/dist/react-native/api/beta/insights/operations.js +15 -9
  437. package/dist/react-native/api/beta/insights/operations.js.map +1 -1
  438. package/dist/react-native/api/beta/memoryStores/options.d.ts +2 -2
  439. package/dist/react-native/api/beta/memoryStores/options.d.ts.map +1 -1
  440. package/dist/react-native/api/beta/memoryStores/options.js +1 -0
  441. package/dist/react-native/api/beta/memoryStores/options.js.map +1 -1
  442. package/dist/react-native/api/beta/schedules/operations.d.ts.map +1 -1
  443. package/dist/react-native/api/beta/schedules/operations.js +4 -2
  444. package/dist/react-native/api/beta/schedules/operations.js.map +1 -1
  445. package/dist/react-native/api/beta/skills/index.d.ts +3 -0
  446. package/dist/react-native/api/beta/skills/index.d.ts.map +1 -0
  447. package/dist/react-native/api/beta/skills/index.js +4 -0
  448. package/dist/react-native/api/beta/skills/index.js.map +1 -0
  449. package/dist/react-native/api/beta/skills/operations.d.ts +34 -0
  450. package/dist/react-native/api/beta/skills/operations.d.ts.map +1 -0
  451. package/dist/react-native/api/beta/skills/operations.js +245 -0
  452. package/dist/react-native/api/beta/skills/operations.js.map +1 -0
  453. package/dist/react-native/api/beta/skills/options.d.ts +72 -0
  454. package/dist/react-native/api/beta/skills/options.d.ts.map +1 -0
  455. package/dist/react-native/api/beta/skills/options.js +4 -0
  456. package/dist/react-native/api/beta/skills/options.js.map +1 -0
  457. package/dist/react-native/api/beta/toolboxes/index.d.ts +3 -0
  458. package/dist/react-native/api/beta/toolboxes/index.d.ts.map +1 -0
  459. package/dist/react-native/api/beta/toolboxes/index.js +4 -0
  460. package/dist/react-native/api/beta/toolboxes/index.js.map +1 -0
  461. package/dist/react-native/api/beta/toolboxes/operations.d.ts +38 -0
  462. package/dist/react-native/api/beta/toolboxes/operations.d.ts.map +1 -0
  463. package/dist/react-native/api/beta/toolboxes/operations.js +273 -0
  464. package/dist/react-native/api/beta/toolboxes/operations.js.map +1 -0
  465. package/dist/react-native/api/beta/toolboxes/options.d.ts +77 -0
  466. package/dist/react-native/api/beta/toolboxes/options.d.ts.map +1 -0
  467. package/dist/react-native/api/beta/toolboxes/options.js +4 -0
  468. package/dist/react-native/api/beta/toolboxes/options.js.map +1 -0
  469. package/dist/react-native/api/evaluationRules/operations.d.ts.map +1 -1
  470. package/dist/react-native/api/evaluationRules/operations.js +5 -24
  471. package/dist/react-native/api/evaluationRules/operations.js.map +1 -1
  472. package/dist/react-native/api/evaluationRules/options.d.ts +0 -8
  473. package/dist/react-native/api/evaluationRules/options.d.ts.map +1 -1
  474. package/dist/react-native/api/evaluationRules/options.js.map +1 -1
  475. package/dist/react-native/api/index.d.ts +1 -1
  476. package/dist/react-native/api/index.d.ts.map +1 -1
  477. package/dist/react-native/api/index.js.map +1 -1
  478. package/dist/react-native/api/telemetry/operations.d.ts +1 -1
  479. package/dist/react-native/api/telemetry/operations.d.ts.map +1 -1
  480. package/dist/react-native/api/telemetry/operations.js.map +1 -1
  481. package/dist/react-native/azureAgent.interface.d.ts +25 -0
  482. package/dist/react-native/azureAgent.interface.d.ts.map +1 -0
  483. package/dist/react-native/azureAgent.interface.js +4 -0
  484. package/dist/react-native/azureAgent.interface.js.map +1 -0
  485. package/dist/react-native/classic/beta/agents/index.d.ts +43 -0
  486. package/dist/react-native/classic/beta/agents/index.d.ts.map +1 -0
  487. package/dist/react-native/classic/beta/agents/index.js +22 -0
  488. package/dist/react-native/classic/beta/agents/index.js.map +1 -0
  489. package/dist/react-native/classic/beta/evaluators/index.d.ts +2 -2
  490. package/dist/react-native/classic/beta/evaluators/index.d.ts.map +1 -1
  491. package/dist/react-native/classic/beta/evaluators/index.js +2 -2
  492. package/dist/react-native/classic/beta/evaluators/index.js.map +1 -1
  493. package/dist/react-native/classic/beta/index.d.ts +10 -1
  494. package/dist/react-native/classic/beta/index.d.ts.map +1 -1
  495. package/dist/react-native/classic/beta/index.js +10 -1
  496. package/dist/react-native/classic/beta/index.js.map +1 -1
  497. package/dist/react-native/classic/beta/insights/index.d.ts +1 -1
  498. package/dist/react-native/classic/beta/insights/index.d.ts.map +1 -1
  499. package/dist/react-native/classic/beta/insights/index.js +1 -1
  500. package/dist/react-native/classic/beta/insights/index.js.map +1 -1
  501. package/dist/react-native/classic/beta/skills/index.d.ts +23 -0
  502. package/dist/react-native/classic/beta/skills/index.d.ts.map +1 -0
  503. package/dist/react-native/classic/beta/skills/index.js +20 -0
  504. package/dist/react-native/classic/beta/skills/index.js.map +1 -0
  505. package/dist/react-native/classic/beta/toolboxes/index.d.ts +25 -0
  506. package/dist/react-native/classic/beta/toolboxes/index.d.ts.map +1 -0
  507. package/dist/react-native/classic/beta/toolboxes/index.js +21 -0
  508. package/dist/react-native/classic/beta/toolboxes/index.js.map +1 -0
  509. package/dist/react-native/classic/index.d.ts +3 -0
  510. package/dist/react-native/classic/index.d.ts.map +1 -1
  511. package/dist/react-native/classic/index.js.map +1 -1
  512. package/dist/react-native/classic/telemetry/index.d.ts +1 -1
  513. package/dist/react-native/classic/telemetry/index.d.ts.map +1 -1
  514. package/dist/react-native/classic/telemetry/index.js.map +1 -1
  515. package/dist/react-native/deprecate.interface.d.ts +13 -0
  516. package/dist/react-native/deprecate.interface.d.ts.map +1 -0
  517. package/dist/react-native/deprecate.interface.js +4 -0
  518. package/dist/react-native/deprecate.interface.js.map +1 -0
  519. package/dist/react-native/index.d.ts +9 -3
  520. package/dist/react-native/index.d.ts.map +1 -1
  521. package/dist/react-native/index.js +1 -0
  522. package/dist/react-native/index.js.map +1 -1
  523. package/dist/react-native/models/index.d.ts +1 -1
  524. package/dist/react-native/models/index.d.ts.map +1 -1
  525. package/dist/react-native/models/index.js.map +1 -1
  526. package/dist/react-native/models/models.d.ts +704 -157
  527. package/dist/react-native/models/models.d.ts.map +1 -1
  528. package/dist/react-native/models/models.js +931 -176
  529. package/dist/react-native/models/models.js.map +1 -1
  530. package/dist/react-native/static-helpers/serialization/get-binary-stream-response.d.ts +12 -0
  531. package/dist/react-native/static-helpers/serialization/get-binary-stream-response.d.ts.map +1 -0
  532. package/dist/react-native/static-helpers/serialization/get-binary-stream-response.js +17 -0
  533. package/dist/react-native/static-helpers/serialization/get-binary-stream-response.js.map +1 -0
  534. package/package.json +4 -3
@@ -14,6 +14,15 @@ export interface Agent {
14
14
  versions: {
15
15
  latest: AgentVersion;
16
16
  };
17
+ /** The endpoint configuration for the agent */
18
+ agent_endpoint?: AgentEndpoint;
19
+ /** The instance identity of the agent */
20
+ readonly instance_identity?: AgentIdentity;
21
+ /** The blueprint for the agent */
22
+ readonly blueprint?: AgentIdentity;
23
+ /** The blueprint for the agent */
24
+ readonly blueprint_reference?: AgentBlueprintReferenceUnion;
25
+ agent_card?: AgentCard;
17
26
  }
18
27
  export declare function agentDeserializer(item: any): Agent;
19
28
  /**
@@ -51,6 +60,16 @@ export interface AgentVersion {
51
60
  created_at: Date;
52
61
  /** The definition of the agent. */
53
62
  definition: AgentDefinitionUnion;
63
+ /** The instance identity of the agent */
64
+ readonly instance_identity?: AgentIdentity;
65
+ /** The blueprint for the agent */
66
+ readonly blueprint?: AgentIdentity;
67
+ /** The blueprint for the agent */
68
+ readonly blueprint_reference?: AgentBlueprintReferenceUnion;
69
+ /** The current status of the agent version. */
70
+ status?: "creating" | "active" | "failed" | "deleting" | "deleted";
71
+ /** The unique GUID identifier of the agent. */
72
+ readonly agent_guid?: string;
54
73
  }
55
74
  export declare function agentVersionDeserializer(item: any): AgentVersion;
56
75
  /**
@@ -69,7 +88,7 @@ export declare function agentDefinitionDeserializer(item: any): AgentDefinition;
69
88
  * Union type for all agent definition types.
70
89
  * Supports workflow, hosted, container app, and prompt agents.
71
90
  */
72
- export type AgentDefinitionUnion = PromptAgentDefinition | WorkflowAgentDefinition | HostedAgentDefinition | AgentDefinition;
91
+ export type AgentDefinitionUnion = HostedAgentDefinition | PromptAgentDefinition | WorkflowAgentDefinition | AgentDefinition;
73
92
  export declare function agentDefinitionUnionSerializer(item: AgentDefinitionUnion): any;
74
93
  export declare function agentDefinitionUnionDeserializer(item: any): AgentDefinitionUnion;
75
94
  /**
@@ -84,74 +103,33 @@ export interface RaiConfig {
84
103
  }
85
104
  export declare function raiConfigSerializer(item: RaiConfig): any;
86
105
  export declare function raiConfigDeserializer(item: any): RaiConfig;
87
- /** The prompt agent definition */
88
- export interface PromptAgentDefinition extends AgentDefinition {
89
- /** The kind discriminator, always 'prompt'. */
90
- kind: "prompt";
91
- /** The model deployment to use for this agent. */
92
- model: string;
93
- /** A system (or developer) message inserted into the model's context. */
94
- instructions?: string;
95
- /**
96
- * 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.
97
- * We generally recommend altering this or `top_p` but not both.
98
- */
99
- temperature?: number;
100
- /**
101
- * An alternative to sampling with temperature, called nucleus sampling,
102
- * where the model considers the results of the tokens with top_p probability
103
- * mass. So 0.1 means only the tokens comprising the top 10% probability mass
104
- * are considered.
105
- *
106
- * We generally recommend altering this or `temperature` but not both.
107
- */
108
- top_p?: number;
109
- /** The reasoning configuration for the prompt agent. */
110
- reasoning?: Reasoning;
106
+ /** The hosted agent definition. */
107
+ export interface HostedAgentDefinition extends AgentDefinition {
108
+ kind: "hosted";
111
109
  /**
112
- * An array of tools the model may call while generating a response. You
110
+ * An array of tools the hosted agent's model may call while generating a response. You
113
111
  * can specify which tool to use by setting the `tool_choice` parameter.
114
112
  */
115
113
  tools?: ToolUnion[];
116
- /**
117
- * How the model should select which tool (or tools) to use when generating a response.
118
- * See the `tools` parameter to see how to specify which tools the model can call.
119
- */
120
- tool_choice?: string | ToolChoiceParamUnion;
121
- /** Configuration options for a text response from the model. Can be plain text or structured JSON data. */
122
- text?: PromptAgentDefinitionTextOptions;
123
- /** Set of structured inputs that can participate in prompt template substitution or tool argument bindings. */
124
- structured_inputs?: Record<string, StructuredInputDefinition>;
125
- }
126
- export declare function promptAgentDefinitionSerializer(item: PromptAgentDefinition): any;
127
- export declare function promptAgentDefinitionDeserializer(item: any): PromptAgentDefinition;
128
- /**
129
- * **gpt-5 and o-series models only**
130
- * Configuration options for
131
- * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
132
- */
133
- export interface Reasoning {
134
- /** The reasoning effort level. */
135
- effort?: ReasoningEffort;
136
- /** The reasoning summary text. */
137
- summary?: "auto" | "concise" | "detailed";
138
- /** Whether to generate a summary of the reasoning process. */
139
- generate_summary?: "auto" | "concise" | "detailed";
114
+ /** The protocols that the agent supports for ingress communication of the containers. */
115
+ container_protocol_versions?: ProtocolVersionRecord[];
116
+ /** The CPU configuration for the hosted agent. */
117
+ cpu: string;
118
+ /** The memory configuration for the hosted agent. */
119
+ memory: string;
120
+ /** Environment variables to set in the hosted agent container. */
121
+ environment_variables?: Record<string, string>;
122
+ /** The image ID for the agent, applicable to image-based hosted agents. */
123
+ image?: string;
124
+ /** Container-based deployment configuration. Provide this for image-based deployments. Mutually exclusive with code_configuration — the service validates that exactly one is set. */
125
+ container_configuration?: ContainerConfiguration;
126
+ /** The protocols that the agent supports for ingress communication. */
127
+ protocol_versions?: ProtocolVersionRecord[];
128
+ /** Code-based deployment configuration. Provide this for code-based deployments. Mutually exclusive with container_configuration — the service validates that exactly one is set. */
129
+ code_configuration?: CodeConfiguration;
140
130
  }
141
- export declare function reasoningSerializer(item: Reasoning): any;
142
- export declare function reasoningDeserializer(item: any): Reasoning;
143
- /**
144
- * Constrains effort on reasoning for
145
- * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
146
- * Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing
147
- * reasoning effort can result in faster responses and fewer tokens used
148
- * on reasoning in a response.
149
- * - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
150
- * - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
151
- * - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
152
- * - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
153
- */
154
- export type ReasoningEffort = "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
131
+ export declare function hostedAgentDefinitionSerializer(item: HostedAgentDefinition): any;
132
+ export declare function hostedAgentDefinitionDeserializer(item: any): HostedAgentDefinition;
155
133
  export declare function toolUnionArraySerializer(result: Array<ToolUnion>): any[];
156
134
  export declare function toolUnionArrayDeserializer(result: Array<ToolUnion>): any[];
157
135
  /** A tool that can be used to generate a response. */
@@ -162,11 +140,11 @@ export interface Tool {
162
140
  export declare function toolSerializer(item: Tool): any;
163
141
  export declare function toolDeserializer(item: any): Tool;
164
142
  /** Alias for ToolUnion */
165
- export type ToolUnion = BingGroundingTool | MicrosoftFabricPreviewTool | SharepointPreviewTool | AzureAISearchTool | OpenApiTool | BingCustomSearchPreviewTool | BrowserAutomationPreviewTool | AzureFunctionTool | CaptureStructuredOutputsTool | A2APreviewTool | MemorySearchPreviewTool | CodeInterpreterTool | FunctionTool | FileSearchTool | ComputerUsePreviewTool | WebSearchTool | MCPTool | ImageGenTool | LocalShellToolParam | FunctionShellToolParam | CustomToolParam | WebSearchPreviewTool | ApplyPatchToolParam | Tool;
143
+ export type ToolUnion = BingGroundingTool | MicrosoftFabricPreviewTool | SharepointPreviewTool | AzureAISearchTool | OpenApiTool | BingCustomSearchPreviewTool | BrowserAutomationPreviewTool | AzureFunctionTool | CaptureStructuredOutputsTool | A2APreviewTool | WorkIQPreviewTool | MemorySearchPreviewTool | CodeInterpreterTool | FunctionTool | FileSearchTool | ComputerUsePreviewTool | WebSearchTool | MCPTool | ImageGenTool | LocalShellToolParam | FunctionShellToolParam | CustomToolParam | WebSearchPreviewTool | ApplyPatchToolParam | ComputerTool | NamespaceToolParam | ToolSearchToolParam | Tool;
166
144
  export declare function toolUnionSerializer(item: ToolUnion): any;
167
145
  export declare function toolUnionDeserializer(item: any): ToolUnion;
168
146
  /** Type of ToolType */
169
- export type ToolType = "function" | "file_search" | "computer_use_preview" | "web_search" | "mcp" | "code_interpreter" | "image_generation" | "local_shell" | "shell" | "custom" | "web_search_preview" | "apply_patch" | "a2a_preview" | "bing_custom_search_preview" | "browser_automation_preview" | "fabric_dataagent_preview" | "sharepoint_grounding_preview" | "memory_search_preview" | "azure_ai_search" | "azure_function" | "bing_grounding" | "capture_structured_outputs" | "openapi";
147
+ export type ToolType = "function" | "file_search" | "computer" | "computer_use_preview" | "web_search" | "mcp" | "code_interpreter" | "image_generation" | "local_shell" | "shell" | "custom" | "namespace" | "tool_search" | "web_search_preview" | "apply_patch" | "a2a_preview" | "bing_custom_search_preview" | "browser_automation_preview" | "fabric_dataagent_preview" | "sharepoint_grounding_preview" | "memory_search_preview" | "work_iq_preview" | "azure_ai_search" | "azure_function" | "bing_grounding" | "capture_structured_outputs" | "openapi";
170
148
  /** The input definition information for a bing grounding search tool as used to configure an agent. */
171
149
  export interface BingGroundingTool extends Tool {
172
150
  /** The object type, which is always 'bing_grounding'. */
@@ -507,6 +485,10 @@ export declare function azureFunctionStorageQueueDeserializer(item: any): AzureF
507
485
  export interface CaptureStructuredOutputsTool extends Tool {
508
486
  /** The type of the tool. Always `capture_structured_outputs`. */
509
487
  type: "capture_structured_outputs";
488
+ /** Optional user-defined name for this tool or configuration. */
489
+ name?: string;
490
+ /** Optional user-defined description for this tool or configuration. */
491
+ description?: string;
510
492
  /** The structured outputs to capture from the model. */
511
493
  outputs: StructuredOutputDefinition;
512
494
  }
@@ -544,6 +526,26 @@ export interface A2APreviewTool extends Tool {
544
526
  }
545
527
  export declare function a2APreviewToolSerializer(item: A2APreviewTool): any;
546
528
  export declare function a2APreviewToolDeserializer(item: any): A2APreviewTool;
529
+ /** A WorkIQ server-side tool. */
530
+ export interface WorkIQPreviewTool extends Tool {
531
+ /** The object type, which is always 'work_iq_preview'. */
532
+ type: "work_iq_preview";
533
+ /** Optional user-defined name for this tool or configuration. */
534
+ name?: string;
535
+ /** Optional user-defined description for this tool or configuration. */
536
+ description?: string;
537
+ /** The WorkIQ tool parameters. */
538
+ work_iq_preview: WorkIQPreviewToolParameters;
539
+ }
540
+ export declare function workIQPreviewToolSerializer(item: WorkIQPreviewTool): any;
541
+ export declare function workIQPreviewToolDeserializer(item: any): WorkIQPreviewTool;
542
+ /** The WorkIQ tool parameters. */
543
+ export interface WorkIQPreviewToolParameters {
544
+ /** The ID of the WorkIQ project connection. */
545
+ project_connection_id: string;
546
+ }
547
+ export declare function workIQPreviewToolParametersSerializer(item: WorkIQPreviewToolParameters): any;
548
+ export declare function workIQPreviewToolParametersDeserializer(item: any): WorkIQPreviewToolParameters;
547
549
  /** A tool for integrating memories into the agent. */
548
550
  export interface MemorySearchPreviewTool extends Tool {
549
551
  /** The type of the tool. Always `memory_search_preview`. */
@@ -574,6 +576,10 @@ export declare function memorySearchOptionsDeserializer(item: any): MemorySearch
574
576
  export interface CodeInterpreterTool extends Tool {
575
577
  /** The type of the code interpreter tool. Always `code_interpreter`. */
576
578
  type: "code_interpreter";
579
+ /** Optional user-defined name for this tool or configuration. */
580
+ name?: string;
581
+ /** Optional user-defined description for this tool or configuration. */
582
+ description?: string;
577
583
  /**
578
584
  * The code interpreter container. Can be a container ID or an object that
579
585
  * specifies uploaded file IDs to make available to your code, along with an
@@ -659,6 +665,8 @@ export interface FunctionTool extends Tool {
659
665
  parameters: Record<string, unknown>;
660
666
  /** Whether the function arguments must strictly match the parameters schema. */
661
667
  strict: boolean;
668
+ /** Whether this function is deferred and loaded via tool search. */
669
+ defer_loading?: boolean;
662
670
  }
663
671
  export declare function functionToolSerializer(item: FunctionTool): any;
664
672
  export declare function functionToolDeserializer(item: any): FunctionTool;
@@ -674,6 +682,10 @@ export interface FileSearchTool extends Tool {
674
682
  ranking_options?: RankingOptions;
675
683
  /** Filters to apply to the file search. */
676
684
  filters?: Filters;
685
+ /** Optional user-defined name for this tool or configuration. */
686
+ name?: string;
687
+ /** Optional user-defined description for this tool or configuration. */
688
+ description?: string;
677
689
  }
678
690
  export declare function fileSearchToolSerializer(item: FileSearchTool): any;
679
691
  export declare function fileSearchToolDeserializer(item: any): FileSearchTool;
@@ -716,7 +728,7 @@ export interface ComparisonFilter {
716
728
  * - `in`: in
717
729
  * - `nin`: not in
718
730
  */
719
- type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
731
+ type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "in" | "nin";
720
732
  /** The key to compare against the value. */
721
733
  key: string;
722
734
  /** The value to compare against the attribute key; supports string, number, or boolean types. */
@@ -777,6 +789,10 @@ export interface WebSearchTool extends Tool {
777
789
  user_location?: WebSearchApproximateLocation;
778
790
  /** High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. */
779
791
  search_context_size?: "low" | "medium" | "high";
792
+ /** Optional user-defined name for this tool or configuration. */
793
+ name?: string;
794
+ /** Optional user-defined description for this tool or configuration. */
795
+ description?: string;
780
796
  /**
781
797
  * The project connections attached to this tool. There can be a maximum of 1 connection
782
798
  * resource attached to the tool.
@@ -859,6 +875,8 @@ export interface MCPTool extends Tool {
859
875
  allowed_tools?: string[] | MCPToolFilter;
860
876
  /** The approval requirements for the MCP tool. */
861
877
  require_approval?: MCPToolRequireApproval | "always" | "never";
878
+ /** Whether this MCP tool is deferred and discovered via tool search. */
879
+ defer_loading?: boolean;
862
880
  /** The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. */
863
881
  project_connection_id?: string;
864
882
  }
@@ -899,7 +917,7 @@ export interface ImageGenTool extends Tool {
899
917
  /** The type of the image generation tool. Always `image_generation`. */
900
918
  type: "image_generation";
901
919
  /** The model to use for image generation. */
902
- model?: "gpt-image-1" | "gpt-image-1-mini";
920
+ model?: "gpt-image-1" | "gpt-image-1-mini" | "gpt-image-1.5";
903
921
  /**
904
922
  * The quality of the generated image. One of `low`, `medium`, `high`,
905
923
  * or `auto`. Default: `auto`.
@@ -935,10 +953,14 @@ export interface ImageGenTool extends Tool {
935
953
  partial_images?: number;
936
954
  /** Whether to generate a new image or edit an existing image. Default: `auto`. */
937
955
  action?: ImageGenAction;
956
+ /** Optional user-defined name for this tool or configuration. */
957
+ name?: string;
958
+ /** Optional user-defined description for this tool or configuration. */
959
+ description?: string;
938
960
  }
939
961
  export declare function imageGenToolSerializer(item: ImageGenTool): any;
940
962
  export declare function imageGenToolDeserializer(item: any): ImageGenTool;
941
- /** Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`. */
963
+ /** Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`. */
942
964
  export type InputFidelity = "high" | "low";
943
965
  /** model interface ImageGenToolInputImageMask */
944
966
  export interface ImageGenToolInputImageMask {
@@ -955,6 +977,10 @@ export type ImageGenAction = "generate" | "edit" | "auto";
955
977
  export interface LocalShellToolParam extends Tool {
956
978
  /** The type of the local shell tool. Always `local_shell`. */
957
979
  type: "local_shell";
980
+ /** Optional user-defined name for this tool or configuration. */
981
+ name?: string;
982
+ /** Optional user-defined description for this tool or configuration. */
983
+ description?: string;
958
984
  }
959
985
  export declare function localShellToolParamSerializer(item: LocalShellToolParam): any;
960
986
  export declare function localShellToolParamDeserializer(item: any): LocalShellToolParam;
@@ -964,6 +990,10 @@ export interface FunctionShellToolParam extends Tool {
964
990
  type: "shell";
965
991
  /** The environment configuration for the function shell tool. */
966
992
  environment?: FunctionShellToolParamEnvironmentUnion;
993
+ /** Optional user-defined name for this tool or configuration. */
994
+ name?: string;
995
+ /** Optional user-defined description for this tool or configuration. */
996
+ description?: string;
967
997
  }
968
998
  export declare function functionShellToolParamSerializer(item: FunctionShellToolParam): any;
969
999
  export declare function functionShellToolParamDeserializer(item: any): FunctionShellToolParam;
@@ -1030,7 +1060,7 @@ export declare function containerSkillUnionArraySerializer(result: Array<Contain
1030
1060
  export declare function containerSkillUnionArrayDeserializer(result: Array<ContainerSkillUnion>): any[];
1031
1061
  /** model interface ContainerSkill */
1032
1062
  export interface ContainerSkill {
1033
- /** The type discriminator, always 'container'. */
1063
+ /** The type discriminator for the container skill. */
1034
1064
  type: ContainerSkillType;
1035
1065
  }
1036
1066
  export declare function containerSkillSerializer(item: ContainerSkill): any;
@@ -1086,6 +1116,8 @@ export interface CustomToolParam extends Tool {
1086
1116
  description?: string;
1087
1117
  /** The input format for the custom tool. Default is unconstrained text. */
1088
1118
  format?: CustomToolParamFormatUnion;
1119
+ /** Whether this tool should be deferred and discovered via tool search. */
1120
+ defer_loading?: boolean;
1089
1121
  }
1090
1122
  export declare function customToolParamSerializer(item: CustomToolParam): any;
1091
1123
  export declare function customToolParamDeserializer(item: any): CustomToolParam;
@@ -1130,6 +1162,7 @@ export interface WebSearchPreviewTool extends Tool {
1130
1162
  user_location?: ApproximateLocation;
1131
1163
  /** High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. */
1132
1164
  search_context_size?: SearchContextSize;
1165
+ search_content_types?: SearchContentType[];
1133
1166
  }
1134
1167
  export declare function webSearchPreviewToolSerializer(item: WebSearchPreviewTool): any;
1135
1168
  export declare function webSearchPreviewToolDeserializer(item: any): WebSearchPreviewTool;
@@ -1150,6 +1183,8 @@ export declare function approximateLocationSerializer(item: ApproximateLocation)
1150
1183
  export declare function approximateLocationDeserializer(item: any): ApproximateLocation;
1151
1184
  /** Type of SearchContextSize */
1152
1185
  export type SearchContextSize = "low" | "medium" | "high";
1186
+ /** Type of SearchContentType */
1187
+ export type SearchContentType = "text" | "image";
1153
1188
  /** Allows the assistant to create, delete, or update files using unified diffs. */
1154
1189
  export interface ApplyPatchToolParam extends Tool {
1155
1190
  /** The type of the tool. Always `apply_patch`. */
@@ -1157,6 +1192,154 @@ export interface ApplyPatchToolParam extends Tool {
1157
1192
  }
1158
1193
  export declare function applyPatchToolParamSerializer(item: ApplyPatchToolParam): any;
1159
1194
  export declare function applyPatchToolParamDeserializer(item: any): ApplyPatchToolParam;
1195
+ /** A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). */
1196
+ export interface ComputerTool extends Tool {
1197
+ /** The type of the computer tool. Always `computer`. */
1198
+ type: "computer";
1199
+ }
1200
+ export declare function computerToolSerializer(item: ComputerTool): any;
1201
+ export declare function computerToolDeserializer(item: any): ComputerTool;
1202
+ /** Groups function/custom tools under a shared namespace. */
1203
+ export interface NamespaceToolParam extends Tool {
1204
+ /** The type of the tool. Always `namespace`. */
1205
+ type: "namespace";
1206
+ /** The namespace name used in tool calls (for example, `crm`). */
1207
+ name: string;
1208
+ /** A description of the namespace shown to the model. */
1209
+ description: string;
1210
+ /** The function/custom tools available inside this namespace. */
1211
+ tools: (FunctionToolParam | CustomToolParam)[];
1212
+ }
1213
+ export declare function namespaceToolParamSerializer(item: NamespaceToolParam): any;
1214
+ export declare function namespaceToolParamDeserializer(item: any): NamespaceToolParam;
1215
+ export declare function _namespaceToolParamToolArraySerializer(result: Array<_NamespaceToolParamTool>): any[];
1216
+ export declare function _namespaceToolParamToolArrayDeserializer(result: Array<_NamespaceToolParamTool>): any[];
1217
+ /** Alias for _NamespaceToolParamTool */
1218
+ export type _NamespaceToolParamTool = FunctionToolParam | CustomToolParam;
1219
+ export declare function _namespaceToolParamToolSerializer(item: _NamespaceToolParamTool): any;
1220
+ export declare function _namespaceToolParamToolDeserializer(item: any): _NamespaceToolParamTool;
1221
+ /** model interface FunctionToolParam */
1222
+ export interface FunctionToolParam {
1223
+ name: string;
1224
+ description?: string;
1225
+ parameters?: EmptyModelParam;
1226
+ strict?: boolean;
1227
+ type: "function";
1228
+ /** Whether this function should be deferred and discovered via tool search. */
1229
+ defer_loading?: boolean;
1230
+ }
1231
+ export declare function functionToolParamSerializer(item: FunctionToolParam): any;
1232
+ export declare function functionToolParamDeserializer(item: any): FunctionToolParam;
1233
+ /** model interface EmptyModelParam */
1234
+ export interface EmptyModelParam {
1235
+ }
1236
+ export declare function emptyModelParamSerializer(_item: EmptyModelParam): any;
1237
+ export declare function emptyModelParamDeserializer(item: any): EmptyModelParam;
1238
+ /** Hosted or BYOT tool search configuration for deferred tools. */
1239
+ export interface ToolSearchToolParam extends Tool {
1240
+ /** The type of the tool. Always `tool_search`. */
1241
+ type: "tool_search";
1242
+ /** Whether tool search is executed by the server or by the client. */
1243
+ execution?: ToolSearchExecutionType;
1244
+ description?: string;
1245
+ parameters?: EmptyModelParam;
1246
+ }
1247
+ export declare function toolSearchToolParamSerializer(item: ToolSearchToolParam): any;
1248
+ export declare function toolSearchToolParamDeserializer(item: any): ToolSearchToolParam;
1249
+ /** Type of ToolSearchExecutionType */
1250
+ export type ToolSearchExecutionType = "server" | "client";
1251
+ export declare function protocolVersionRecordArraySerializer(result: Array<ProtocolVersionRecord>): any[];
1252
+ export declare function protocolVersionRecordArrayDeserializer(result: Array<ProtocolVersionRecord>): any[];
1253
+ /** A record mapping for a single protocol and its version. */
1254
+ export interface ProtocolVersionRecord {
1255
+ /** The protocol type. */
1256
+ protocol: AgentProtocol;
1257
+ /** The version string for the protocol, e.g. 'v0.1.1'. */
1258
+ version: string;
1259
+ }
1260
+ export declare function protocolVersionRecordSerializer(item: ProtocolVersionRecord): any;
1261
+ export declare function protocolVersionRecordDeserializer(item: any): ProtocolVersionRecord;
1262
+ /** Type of AgentProtocol */
1263
+ export type AgentProtocol = "activity_protocol" | "responses" | "invocations";
1264
+ /** Container-based deployment configuration for a hosted agent. */
1265
+ export interface ContainerConfiguration {
1266
+ /** The container image for the hosted agent. */
1267
+ image: string;
1268
+ }
1269
+ export declare function containerConfigurationSerializer(item: ContainerConfiguration): any;
1270
+ export declare function containerConfigurationDeserializer(item: any): ContainerConfiguration;
1271
+ /** Code-based deployment configuration for a hosted agent. */
1272
+ export interface CodeConfiguration {
1273
+ /** The runtime identifier for code execution (e.g., 'python_3_11', 'python_3_12', 'python_3_13'). */
1274
+ runtime: string;
1275
+ /** The entry point command and arguments for the code execution. */
1276
+ entry_point: string[];
1277
+ }
1278
+ export declare function codeConfigurationSerializer(item: CodeConfiguration): any;
1279
+ export declare function codeConfigurationDeserializer(item: any): CodeConfiguration;
1280
+ /** The prompt agent definition */
1281
+ export interface PromptAgentDefinition extends AgentDefinition {
1282
+ kind: "prompt";
1283
+ /** The model deployment to use for this agent. */
1284
+ model: string;
1285
+ /** A system (or developer) message inserted into the model's context. */
1286
+ instructions?: string;
1287
+ /**
1288
+ * 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.
1289
+ * We generally recommend altering this or `top_p` but not both.
1290
+ */
1291
+ temperature?: number;
1292
+ /**
1293
+ * An alternative to sampling with temperature, called nucleus sampling,
1294
+ * where the model considers the results of the tokens with top_p probability
1295
+ * mass. So 0.1 means only the tokens comprising the top 10% probability mass
1296
+ * are considered.
1297
+ *
1298
+ * We generally recommend altering this or `temperature` but not both.
1299
+ */
1300
+ top_p?: number;
1301
+ reasoning?: Reasoning;
1302
+ /**
1303
+ * An array of tools the model may call while generating a response. You
1304
+ * can specify which tool to use by setting the `tool_choice` parameter.
1305
+ */
1306
+ tools?: ToolUnion[];
1307
+ /**
1308
+ * How the model should select which tool (or tools) to use when generating a response.
1309
+ * See the `tools` parameter to see how to specify which tools the model can call.
1310
+ */
1311
+ tool_choice?: string | ToolChoiceParamUnion;
1312
+ /** Configuration options for a text response from the model. Can be plain text or structured JSON data. */
1313
+ text?: PromptAgentDefinitionTextOptions;
1314
+ /** Set of structured inputs that can participate in prompt template substitution or tool argument bindings. */
1315
+ structured_inputs?: Record<string, StructuredInputDefinition>;
1316
+ }
1317
+ export declare function promptAgentDefinitionSerializer(item: PromptAgentDefinition): any;
1318
+ export declare function promptAgentDefinitionDeserializer(item: any): PromptAgentDefinition;
1319
+ /**
1320
+ * **gpt-5 and o-series models only**
1321
+ * Configuration options for
1322
+ * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
1323
+ */
1324
+ export interface Reasoning {
1325
+ effort?: ReasoningEffort;
1326
+ summary?: "auto" | "concise" | "detailed";
1327
+ generate_summary?: "auto" | "concise" | "detailed";
1328
+ }
1329
+ export declare function reasoningSerializer(item: Reasoning): any;
1330
+ export declare function reasoningDeserializer(item: any): Reasoning;
1331
+ /**
1332
+ * Constrains effort on reasoning for
1333
+ * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
1334
+ * Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing
1335
+ * reasoning effort can result in faster responses and fewer tokens used
1336
+ * on reasoning in a response.
1337
+ * - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
1338
+ * - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
1339
+ * - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
1340
+ * - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
1341
+ */
1342
+ export type ReasoningEffort = "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
1160
1343
  /** Alias for _PromptAgentDefinitionToolChoice */
1161
1344
  export type _PromptAgentDefinitionToolChoice = string | ToolChoiceParamUnion;
1162
1345
  export declare function _promptAgentDefinitionToolChoiceSerializer(item: _PromptAgentDefinitionToolChoice): any;
@@ -1167,17 +1350,16 @@ export declare function _promptAgentDefinitionToolChoiceDeserializer(item: any):
1167
1350
  * the model can call.
1168
1351
  */
1169
1352
  export interface ToolChoiceParam {
1170
- /** The type discriminator for the tool choice. */
1171
1353
  type: ToolChoiceParamType;
1172
1354
  }
1173
1355
  export declare function toolChoiceParamSerializer(item: ToolChoiceParam): any;
1174
1356
  export declare function toolChoiceParamDeserializer(item: any): ToolChoiceParam;
1175
1357
  /** Alias for ToolChoiceParamUnion */
1176
- export type ToolChoiceParamUnion = ToolChoiceAllowed | ToolChoiceFunction | ToolChoiceMCP | ToolChoiceCustom | SpecificApplyPatchParam | SpecificFunctionShellParam | ToolChoiceFileSearch | ToolChoiceWebSearchPreview | ToolChoiceComputerUsePreview | ToolChoiceWebSearchPreview20250311 | ToolChoiceImageGeneration | ToolChoiceCodeInterpreter | ToolChoiceParam;
1358
+ export type ToolChoiceParamUnion = ToolChoiceAllowed | ToolChoiceFunction | ToolChoiceMCP | ToolChoiceCustom | SpecificApplyPatchParam | SpecificFunctionShellParam | ToolChoiceFileSearch | ToolChoiceWebSearchPreview | ToolChoiceComputerUsePreview | ToolChoiceWebSearchPreview20250311 | ToolChoiceImageGeneration | ToolChoiceCodeInterpreter | ToolChoiceComputer | ToolChoiceComputerUse | ToolChoiceParam;
1177
1359
  export declare function toolChoiceParamUnionSerializer(item: ToolChoiceParamUnion): any;
1178
1360
  export declare function toolChoiceParamUnionDeserializer(item: any): ToolChoiceParamUnion;
1179
1361
  /** Type of ToolChoiceParamType */
1180
- export type ToolChoiceParamType = "allowed_tools" | "function" | "mcp" | "custom" | "apply_patch" | "shell" | "file_search" | "web_search_preview" | "computer_use_preview" | "web_search_preview_2025_03_11" | "image_generation" | "code_interpreter";
1362
+ export type ToolChoiceParamType = "allowed_tools" | "function" | "mcp" | "custom" | "apply_patch" | "shell" | "file_search" | "web_search_preview" | "computer_use_preview" | "web_search_preview_2025_03_11" | "image_generation" | "code_interpreter" | "computer" | "computer_use";
1181
1363
  /** Constrains the tools available to the model to a pre-defined set. */
1182
1364
  export interface ToolChoiceAllowed extends ToolChoiceParam {
1183
1365
  /** Allowed tool configuration type. Always `allowed_tools`. */
@@ -1219,7 +1401,6 @@ export interface ToolChoiceMCP extends ToolChoiceParam {
1219
1401
  type: "mcp";
1220
1402
  /** The label of the MCP server to use. */
1221
1403
  server_label: string;
1222
- /** The name of the MCP server to use. */
1223
1404
  name?: string;
1224
1405
  }
1225
1406
  export declare function toolChoiceMCPSerializer(item: ToolChoiceMCP): any;
@@ -1252,7 +1433,6 @@ export declare function specificFunctionShellParamDeserializer(item: any): Speci
1252
1433
  * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1253
1434
  */
1254
1435
  export interface ToolChoiceFileSearch extends ToolChoiceParam {
1255
- /** The type discriminator, always 'file_search'. */
1256
1436
  type: "file_search";
1257
1437
  }
1258
1438
  export declare function toolChoiceFileSearchSerializer(item: ToolChoiceFileSearch): any;
@@ -1262,7 +1442,6 @@ export declare function toolChoiceFileSearchDeserializer(item: any): ToolChoiceF
1262
1442
  * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1263
1443
  */
1264
1444
  export interface ToolChoiceWebSearchPreview extends ToolChoiceParam {
1265
- /** The type discriminator, always 'web_search_preview'. */
1266
1445
  type: "web_search_preview";
1267
1446
  }
1268
1447
  export declare function toolChoiceWebSearchPreviewSerializer(item: ToolChoiceWebSearchPreview): any;
@@ -1272,7 +1451,6 @@ export declare function toolChoiceWebSearchPreviewDeserializer(item: any): ToolC
1272
1451
  * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1273
1452
  */
1274
1453
  export interface ToolChoiceComputerUsePreview extends ToolChoiceParam {
1275
- /** The type discriminator, always 'computer_use_preview'. */
1276
1454
  type: "computer_use_preview";
1277
1455
  }
1278
1456
  export declare function toolChoiceComputerUsePreviewSerializer(item: ToolChoiceComputerUsePreview): any;
@@ -1282,7 +1460,6 @@ export declare function toolChoiceComputerUsePreviewDeserializer(item: any): Too
1282
1460
  * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1283
1461
  */
1284
1462
  export interface ToolChoiceWebSearchPreview20250311 extends ToolChoiceParam {
1285
- /** The type discriminator, always 'web_search_preview_2025_03_11'. */
1286
1463
  type: "web_search_preview_2025_03_11";
1287
1464
  }
1288
1465
  export declare function toolChoiceWebSearchPreview20250311Serializer(item: ToolChoiceWebSearchPreview20250311): any;
@@ -1292,7 +1469,6 @@ export declare function toolChoiceWebSearchPreview20250311Deserializer(item: any
1292
1469
  * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1293
1470
  */
1294
1471
  export interface ToolChoiceImageGeneration extends ToolChoiceParam {
1295
- /** The type discriminator, always 'image_generation'. */
1296
1472
  type: "image_generation";
1297
1473
  }
1298
1474
  export declare function toolChoiceImageGenerationSerializer(item: ToolChoiceImageGeneration): any;
@@ -1302,15 +1478,31 @@ export declare function toolChoiceImageGenerationDeserializer(item: any): ToolCh
1302
1478
  * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1303
1479
  */
1304
1480
  export interface ToolChoiceCodeInterpreter extends ToolChoiceParam {
1305
- /** The type discriminator, always 'code_interpreter'. */
1306
1481
  type: "code_interpreter";
1307
1482
  }
1308
1483
  export declare function toolChoiceCodeInterpreterSerializer(item: ToolChoiceCodeInterpreter): any;
1309
1484
  export declare function toolChoiceCodeInterpreterDeserializer(item: any): ToolChoiceCodeInterpreter;
1485
+ /**
1486
+ * Indicates that the model should use a built-in tool to generate a response.
1487
+ * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1488
+ */
1489
+ export interface ToolChoiceComputer extends ToolChoiceParam {
1490
+ type: "computer";
1491
+ }
1492
+ export declare function toolChoiceComputerSerializer(item: ToolChoiceComputer): any;
1493
+ export declare function toolChoiceComputerDeserializer(item: any): ToolChoiceComputer;
1494
+ /**
1495
+ * Indicates that the model should use a built-in tool to generate a response.
1496
+ * [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
1497
+ */
1498
+ export interface ToolChoiceComputerUse extends ToolChoiceParam {
1499
+ type: "computer_use";
1500
+ }
1501
+ export declare function toolChoiceComputerUseSerializer(item: ToolChoiceComputerUse): any;
1502
+ export declare function toolChoiceComputerUseDeserializer(item: any): ToolChoiceComputerUse;
1310
1503
  /** Configuration options for a text response from the model. Can be plain text or structured JSON data. */
1311
1504
  export interface PromptAgentDefinitionTextOptions {
1312
- /** The text format options for the prompt agent. */
1313
- format?: TextResponseFormatConfigurationUnion;
1505
+ format?: TextResponseFormatUnion;
1314
1506
  }
1315
1507
  export declare function promptAgentDefinitionTextOptionsSerializer(item: PromptAgentDefinitionTextOptions): any;
1316
1508
  export declare function promptAgentDefinitionTextOptionsDeserializer(item: any): PromptAgentDefinitionTextOptions;
@@ -1318,30 +1510,29 @@ export declare function promptAgentDefinitionTextOptionsDeserializer(item: any):
1318
1510
  * An object specifying the format that the model must output.
1319
1511
  * Configuring `{ "type": "json_schema" }` enables Structured Outputs,
1320
1512
  * which ensures the model will match your supplied JSON schema. Learn more in the
1321
- * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
1513
+ * [Structured Outputs guide](/docs/guides/structured-outputs).
1322
1514
  * The default format is `{ "type": "text" }` with no additional options.
1323
1515
  * *Not recommended for gpt-4o and newer models:**
1324
1516
  * Setting to `{ "type": "json_object" }` enables the older JSON mode, which
1325
1517
  * ensures the message the model generates is valid JSON. Using `json_schema`
1326
1518
  * is preferred for models that support it.
1327
1519
  */
1328
- export interface TextResponseFormatConfiguration {
1329
- /** The type discriminator, always 'text'. */
1520
+ export interface TextResponseFormat {
1330
1521
  type: TextResponseFormatConfigurationType;
1331
1522
  }
1332
- export declare function textResponseFormatConfigurationSerializer(item: TextResponseFormatConfiguration): any;
1333
- export declare function textResponseFormatConfigurationDeserializer(item: any): TextResponseFormatConfiguration;
1334
- /** Alias for TextResponseFormatConfigurationUnion */
1335
- export type TextResponseFormatConfigurationUnion = TextResponseFormatJsonSchema | TextResponseFormatConfigurationResponseFormatText | TextResponseFormatConfigurationResponseFormatJsonObject | TextResponseFormatConfiguration;
1336
- export declare function textResponseFormatConfigurationUnionSerializer(item: TextResponseFormatConfigurationUnion): any;
1337
- export declare function textResponseFormatConfigurationUnionDeserializer(item: any): TextResponseFormatConfigurationUnion;
1523
+ export declare function textResponseFormatSerializer(item: TextResponseFormat): any;
1524
+ export declare function textResponseFormatDeserializer(item: any): TextResponseFormat;
1525
+ /** Alias for TextResponseFormatUnion */
1526
+ export type TextResponseFormatUnion = TextResponseFormatJsonSchema | TextResponseFormatText | TextResponseFormatJsonObject | TextResponseFormat;
1527
+ export declare function textResponseFormatUnionSerializer(item: TextResponseFormatUnion): any;
1528
+ export declare function textResponseFormatUnionDeserializer(item: any): TextResponseFormatUnion;
1338
1529
  /** Type of TextResponseFormatConfigurationType */
1339
1530
  export type TextResponseFormatConfigurationType = "text" | "json_schema" | "json_object";
1340
1531
  /**
1341
1532
  * JSON Schema response format. Used to generate structured JSON responses.
1342
- * Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
1533
+ * Learn more about [Structured Outputs](/docs/guides/structured-outputs).
1343
1534
  */
1344
- export interface TextResponseFormatJsonSchema extends TextResponseFormatConfiguration {
1535
+ export interface TextResponseFormatJsonSchema extends TextResponseFormat {
1345
1536
  /** The type of response format being defined. Always `json_schema`. */
1346
1537
  type: "json_schema";
1347
1538
  /**
@@ -1354,32 +1545,30 @@ export interface TextResponseFormatJsonSchema extends TextResponseFormatConfigur
1354
1545
  * underscores and dashes, with a maximum length of 64.
1355
1546
  */
1356
1547
  name: string;
1357
- /** The JSON schema that the response must conform to. */
1358
1548
  schema: Record<string, unknown>;
1359
- /** Whether the response must strictly conform to the schema. */
1360
1549
  strict?: boolean;
1361
1550
  }
1362
1551
  export declare function textResponseFormatJsonSchemaSerializer(item: TextResponseFormatJsonSchema): any;
1363
1552
  export declare function textResponseFormatJsonSchemaDeserializer(item: any): TextResponseFormatJsonSchema;
1364
1553
  /** Default response format. Used to generate text responses. */
1365
- export interface TextResponseFormatConfigurationResponseFormatText extends TextResponseFormatConfiguration {
1554
+ export interface TextResponseFormatText extends TextResponseFormat {
1366
1555
  /** The type of response format being defined. Always `text`. */
1367
1556
  type: "text";
1368
1557
  }
1369
- export declare function textResponseFormatConfigurationResponseFormatTextSerializer(item: TextResponseFormatConfigurationResponseFormatText): any;
1370
- export declare function textResponseFormatConfigurationResponseFormatTextDeserializer(item: any): TextResponseFormatConfigurationResponseFormatText;
1558
+ export declare function textResponseFormatTextSerializer(item: TextResponseFormatText): any;
1559
+ export declare function textResponseFormatTextDeserializer(item: any): TextResponseFormatText;
1371
1560
  /**
1372
1561
  * JSON object response format. An older method of generating JSON responses.
1373
1562
  * Using `json_schema` is recommended for models that support it. Note that the
1374
1563
  * model will not generate JSON without a system or user message instructing it
1375
1564
  * to do so.
1376
1565
  */
1377
- export interface TextResponseFormatConfigurationResponseFormatJsonObject extends TextResponseFormatConfiguration {
1566
+ export interface TextResponseFormatJsonObject extends TextResponseFormat {
1378
1567
  /** The type of response format being defined. Always `json_object`. */
1379
1568
  type: "json_object";
1380
1569
  }
1381
- export declare function textResponseFormatConfigurationResponseFormatJsonObjectSerializer(item: TextResponseFormatConfigurationResponseFormatJsonObject): any;
1382
- export declare function textResponseFormatConfigurationResponseFormatJsonObjectDeserializer(item: any): TextResponseFormatConfigurationResponseFormatJsonObject;
1570
+ export declare function textResponseFormatJsonObjectSerializer(item: TextResponseFormatJsonObject): any;
1571
+ export declare function textResponseFormatJsonObjectDeserializer(item: any): TextResponseFormatJsonObject;
1383
1572
  export declare function structuredInputDefinitionRecordSerializer(item: Record<string, StructuredInputDefinition>): Record<string, any>;
1384
1573
  export declare function structuredInputDefinitionRecordDeserializer(item: Record<string, any>): Record<string, StructuredInputDefinition>;
1385
1574
  /** An structured input that can participate in prompt template substitutions and tool argument binding. */
@@ -1397,48 +1586,172 @@ export declare function structuredInputDefinitionSerializer(item: StructuredInpu
1397
1586
  export declare function structuredInputDefinitionDeserializer(item: any): StructuredInputDefinition;
1398
1587
  /** The workflow agent definition. */
1399
1588
  export interface WorkflowAgentDefinition extends AgentDefinition {
1400
- /** The kind discriminator, always 'workflow'. */
1401
1589
  kind: "workflow";
1402
1590
  /** The CSDL YAML definition of the workflow. */
1403
1591
  workflow?: string;
1404
1592
  }
1405
1593
  export declare function workflowAgentDefinitionSerializer(item: WorkflowAgentDefinition): any;
1406
1594
  export declare function workflowAgentDefinitionDeserializer(item: any): WorkflowAgentDefinition;
1407
- /** The hosted agent definition. */
1408
- export interface HostedAgentDefinition extends AgentDefinition {
1409
- /** The kind discriminator, always 'hosted'. */
1410
- kind: "hosted";
1411
- /**
1412
- * An array of tools the hosted agent's model may call while generating a response. You
1413
- * can specify which tool to use by setting the `tool_choice` parameter.
1414
- */
1415
- tools?: ToolUnion[];
1416
- /** The protocols that the agent supports for ingress communication of the containers. */
1417
- container_protocol_versions: ProtocolVersionRecord[];
1418
- /** The CPU configuration for the hosted agent. */
1419
- cpu: string;
1420
- /** The memory configuration for the hosted agent. */
1421
- memory: string;
1422
- /** Environment variables to set in the hosted agent container. */
1423
- environment_variables?: Record<string, string>;
1424
- /** The image ID for the agent, applicable to image-based hosted agents. */
1425
- image?: string;
1426
- }
1427
- export declare function hostedAgentDefinitionSerializer(item: HostedAgentDefinition): any;
1428
- export declare function hostedAgentDefinitionDeserializer(item: any): HostedAgentDefinition;
1429
- export declare function protocolVersionRecordArraySerializer(result: Array<ProtocolVersionRecord>): any[];
1430
- export declare function protocolVersionRecordArrayDeserializer(result: Array<ProtocolVersionRecord>): any[];
1431
- /** A record mapping for a single protocol and its version. */
1432
- export interface ProtocolVersionRecord {
1433
- /** The protocol type. */
1434
- protocol: AgentProtocol;
1435
- /** The version string for the protocol, e.g. 'v0.1.1'. */
1595
+ /** model interface AgentIdentity */
1596
+ export interface AgentIdentity {
1597
+ /** The principal ID of the agent instance */
1598
+ principal_id: string;
1599
+ /** The client ID of the agent instance. Also referred to as the instance ID */
1600
+ client_id: string;
1601
+ }
1602
+ export declare function agentIdentityDeserializer(item: any): AgentIdentity;
1603
+ /** model interface AgentBlueprintReference */
1604
+ export interface AgentBlueprintReference {
1605
+ type: AgentBlueprintReferenceType;
1606
+ }
1607
+ export declare function agentBlueprintReferenceSerializer(item: AgentBlueprintReference): any;
1608
+ export declare function agentBlueprintReferenceDeserializer(item: any): AgentBlueprintReference;
1609
+ /** Alias for AgentBlueprintReferenceUnion */
1610
+ export type AgentBlueprintReferenceUnion = ManagedAgentIdentityBlueprintReference | AgentBlueprintReference;
1611
+ export declare function agentBlueprintReferenceUnionSerializer(item: AgentBlueprintReferenceUnion): any;
1612
+ export declare function agentBlueprintReferenceUnionDeserializer(item: any): AgentBlueprintReferenceUnion;
1613
+ /** Type of AgentBlueprintReferenceType */
1614
+ export type AgentBlueprintReferenceType = "ManagedAgentIdentityBlueprint";
1615
+ /** model interface ManagedAgentIdentityBlueprintReference */
1616
+ export interface ManagedAgentIdentityBlueprintReference extends AgentBlueprintReference {
1617
+ type: "ManagedAgentIdentityBlueprint";
1618
+ /** The ID of the managed blueprint */
1619
+ blueprint_id: string;
1620
+ }
1621
+ export declare function managedAgentIdentityBlueprintReferenceSerializer(item: ManagedAgentIdentityBlueprintReference): any;
1622
+ export declare function managedAgentIdentityBlueprintReferenceDeserializer(item: any): ManagedAgentIdentityBlueprintReference;
1623
+ /** model interface AgentEndpoint */
1624
+ export interface AgentEndpoint {
1625
+ /** The version selector of the agent endpoint determines how traffic is routed to different versions of the agent. */
1626
+ version_selector?: VersionSelector;
1627
+ /** The protocols that the agent supports */
1628
+ protocols?: AgentEndpointProtocol[];
1629
+ /** The authorization schemes supported by the agent endpoint */
1630
+ authorization_schemes?: AgentEndpointAuthorizationSchemeUnion[];
1631
+ }
1632
+ export declare function agentEndpointSerializer(item: AgentEndpoint): any;
1633
+ export declare function agentEndpointDeserializer(item: any): AgentEndpoint;
1634
+ /** model interface VersionSelector */
1635
+ export interface VersionSelector {
1636
+ version_selection_rules: VersionSelectionRuleUnion[];
1637
+ }
1638
+ export declare function versionSelectorSerializer(item: VersionSelector): any;
1639
+ export declare function versionSelectorDeserializer(item: any): VersionSelector;
1640
+ export declare function versionSelectionRuleUnionArraySerializer(result: Array<VersionSelectionRuleUnion>): any[];
1641
+ export declare function versionSelectionRuleUnionArrayDeserializer(result: Array<VersionSelectionRuleUnion>): any[];
1642
+ /** model interface VersionSelectionRule */
1643
+ export interface VersionSelectionRule {
1644
+ type: VersionSelectorType;
1645
+ /** The agent version to route traffic to */
1646
+ agent_version: string;
1647
+ }
1648
+ export declare function versionSelectionRuleSerializer(item: VersionSelectionRule): any;
1649
+ export declare function versionSelectionRuleDeserializer(item: any): VersionSelectionRule;
1650
+ /** Alias for VersionSelectionRuleUnion */
1651
+ export type VersionSelectionRuleUnion = FixedRatioVersionSelectionRule | VersionSelectionRule;
1652
+ export declare function versionSelectionRuleUnionSerializer(item: VersionSelectionRuleUnion): any;
1653
+ export declare function versionSelectionRuleUnionDeserializer(item: any): VersionSelectionRuleUnion;
1654
+ /** Type of VersionSelectorType */
1655
+ export type VersionSelectorType = "FixedRatio";
1656
+ /** model interface FixedRatioVersionSelectionRule */
1657
+ export interface FixedRatioVersionSelectionRule extends VersionSelectionRule {
1658
+ type: "FixedRatio";
1659
+ /** The percentage of traffic to route to the version. Must be between 0 and 100. */
1660
+ traffic_percentage: number;
1661
+ }
1662
+ export declare function fixedRatioVersionSelectionRuleSerializer(item: FixedRatioVersionSelectionRule): any;
1663
+ export declare function fixedRatioVersionSelectionRuleDeserializer(item: any): FixedRatioVersionSelectionRule;
1664
+ /** Type of AgentEndpointProtocol */
1665
+ export type AgentEndpointProtocol = "activity" | "responses" | "a2a" | "invocations";
1666
+ export declare function agentEndpointAuthorizationSchemeUnionArraySerializer(result: Array<AgentEndpointAuthorizationSchemeUnion>): any[];
1667
+ export declare function agentEndpointAuthorizationSchemeUnionArrayDeserializer(result: Array<AgentEndpointAuthorizationSchemeUnion>): any[];
1668
+ /** model interface AgentEndpointAuthorizationScheme */
1669
+ export interface AgentEndpointAuthorizationScheme {
1670
+ type: AgentEndpointAuthorizationSchemeType;
1671
+ }
1672
+ export declare function agentEndpointAuthorizationSchemeSerializer(item: AgentEndpointAuthorizationScheme): any;
1673
+ export declare function agentEndpointAuthorizationSchemeDeserializer(item: any): AgentEndpointAuthorizationScheme;
1674
+ /** Alias for AgentEndpointAuthorizationSchemeUnion */
1675
+ export type AgentEndpointAuthorizationSchemeUnion = EntraAuthorizationScheme | BotServiceAuthorizationScheme | BotServiceRbacAuthorizationScheme | AgentEndpointAuthorizationScheme;
1676
+ export declare function agentEndpointAuthorizationSchemeUnionSerializer(item: AgentEndpointAuthorizationSchemeUnion): any;
1677
+ export declare function agentEndpointAuthorizationSchemeUnionDeserializer(item: any): AgentEndpointAuthorizationSchemeUnion;
1678
+ /** Type of AgentEndpointAuthorizationSchemeType */
1679
+ export type AgentEndpointAuthorizationSchemeType = "Entra" | "BotService" | "BotServiceRbac";
1680
+ /** model interface EntraAuthorizationScheme */
1681
+ export interface EntraAuthorizationScheme extends AgentEndpointAuthorizationScheme {
1682
+ type: "Entra";
1683
+ isolation_key_source: IsolationKeySourceUnion;
1684
+ }
1685
+ export declare function entraAuthorizationSchemeSerializer(item: EntraAuthorizationScheme): any;
1686
+ export declare function entraAuthorizationSchemeDeserializer(item: any): EntraAuthorizationScheme;
1687
+ /** model interface IsolationKeySource */
1688
+ export interface IsolationKeySource {
1689
+ kind: IsolationKeySourceKind;
1690
+ }
1691
+ export declare function isolationKeySourceSerializer(item: IsolationKeySource): any;
1692
+ export declare function isolationKeySourceDeserializer(item: any): IsolationKeySource;
1693
+ /** Alias for IsolationKeySourceUnion */
1694
+ export type IsolationKeySourceUnion = EntraIsolationKeySource | HeaderIsolationKeySource | IsolationKeySource;
1695
+ export declare function isolationKeySourceUnionSerializer(item: IsolationKeySourceUnion): any;
1696
+ export declare function isolationKeySourceUnionDeserializer(item: any): IsolationKeySourceUnion;
1697
+ /** Type of IsolationKeySourceKind */
1698
+ export type IsolationKeySourceKind = "Entra" | "Header";
1699
+ /** model interface EntraIsolationKeySource */
1700
+ export interface EntraIsolationKeySource extends IsolationKeySource {
1701
+ kind: "Entra";
1702
+ }
1703
+ export declare function entraIsolationKeySourceSerializer(item: EntraIsolationKeySource): any;
1704
+ export declare function entraIsolationKeySourceDeserializer(item: any): EntraIsolationKeySource;
1705
+ /** model interface HeaderIsolationKeySource */
1706
+ export interface HeaderIsolationKeySource extends IsolationKeySource {
1707
+ kind: "Header";
1708
+ /** The user isolation key header value */
1709
+ user_isolation_key: string;
1710
+ /** The chat isolation key header value */
1711
+ chat_isolation_key: string;
1712
+ }
1713
+ export declare function headerIsolationKeySourceSerializer(item: HeaderIsolationKeySource): any;
1714
+ export declare function headerIsolationKeySourceDeserializer(item: any): HeaderIsolationKeySource;
1715
+ /** model interface BotServiceAuthorizationScheme */
1716
+ export interface BotServiceAuthorizationScheme extends AgentEndpointAuthorizationScheme {
1717
+ type: "BotService";
1718
+ }
1719
+ export declare function botServiceAuthorizationSchemeSerializer(item: BotServiceAuthorizationScheme): any;
1720
+ export declare function botServiceAuthorizationSchemeDeserializer(item: any): BotServiceAuthorizationScheme;
1721
+ /** model interface BotServiceRbacAuthorizationScheme */
1722
+ export interface BotServiceRbacAuthorizationScheme extends AgentEndpointAuthorizationScheme {
1723
+ type: "BotServiceRbac";
1724
+ }
1725
+ export declare function botServiceRbacAuthorizationSchemeSerializer(item: BotServiceRbacAuthorizationScheme): any;
1726
+ export declare function botServiceRbacAuthorizationSchemeDeserializer(item: any): BotServiceRbacAuthorizationScheme;
1727
+ /** model interface AgentCard */
1728
+ export interface AgentCard {
1729
+ /** The version of the agent card. */
1436
1730
  version: string;
1731
+ /** The description of the agent card. */
1732
+ description?: string;
1733
+ /** The set of skills that an agent can perform. */
1734
+ skills: AgentCardSkill[];
1735
+ }
1736
+ export declare function agentCardSerializer(item: AgentCard): any;
1737
+ export declare function agentCardDeserializer(item: any): AgentCard;
1738
+ export declare function agentCardSkillArraySerializer(result: Array<AgentCardSkill>): any[];
1739
+ export declare function agentCardSkillArrayDeserializer(result: Array<AgentCardSkill>): any[];
1740
+ /** model interface AgentCardSkill */
1741
+ export interface AgentCardSkill {
1742
+ /** a unique identifier for the skill */
1743
+ id: string;
1744
+ /** The name of the skill */
1745
+ name: string;
1746
+ /** A description of the skill */
1747
+ description?: string;
1748
+ /** set of tagwords describing classes of capabilities for the skill */
1749
+ tags?: string[];
1750
+ /** A list of example scenarios that the skill can perform. */
1751
+ examples?: string[];
1437
1752
  }
1438
- export declare function protocolVersionRecordSerializer(item: ProtocolVersionRecord): any;
1439
- export declare function protocolVersionRecordDeserializer(item: any): ProtocolVersionRecord;
1440
- /** Type of AgentProtocol */
1441
- export type AgentProtocol = "activity_protocol" | "responses";
1753
+ export declare function agentCardSkillSerializer(item: AgentCardSkill): any;
1754
+ export declare function agentCardSkillDeserializer(item: any): AgentCardSkill;
1442
1755
  /** Error response for API failures. */
1443
1756
  export interface ApiErrorResponse {
1444
1757
  /** The error details. */
@@ -1549,7 +1862,7 @@ export declare function evaluationRuleActionUnionDeserializer(item: any): Evalua
1549
1862
  export type EvaluationRuleActionType = "continuousEvaluation" | "humanEvaluationPreview";
1550
1863
  /** Evaluation rule action for continuous evaluation. */
1551
1864
  export interface ContinuousEvaluationRuleAction extends EvaluationRuleAction {
1552
- /** The type discriminator, always 'continuous_evaluation'. */
1865
+ /** The type discriminator, always 'continuousEvaluation'. */
1553
1866
  type: "continuousEvaluation";
1554
1867
  /** Eval Id to add continuous evaluation runs to. */
1555
1868
  evalId: string;
@@ -1560,7 +1873,7 @@ export declare function continuousEvaluationRuleActionSerializer(item: Continuou
1560
1873
  export declare function continuousEvaluationRuleActionDeserializer(item: any): ContinuousEvaluationRuleAction;
1561
1874
  /** Evaluation rule action for human evaluation. */
1562
1875
  export interface HumanEvaluationPreviewRuleAction extends EvaluationRuleAction {
1563
- /** The type discriminator, always 'human_evaluation_preview'. */
1876
+ /** The type discriminator, always 'humanEvaluationPreview'. */
1564
1877
  type: "humanEvaluationPreview";
1565
1878
  /** Human evaluation template Id. */
1566
1879
  templateId: string;
@@ -1923,6 +2236,89 @@ export interface EmbeddingConfiguration {
1923
2236
  }
1924
2237
  export declare function embeddingConfigurationSerializer(item: EmbeddingConfiguration): any;
1925
2238
  export declare function embeddingConfigurationDeserializer(item: any): EmbeddingConfiguration;
2239
+ /** Version indicator determining which agent version backs the session. */
2240
+ export interface VersionIndicator {
2241
+ /** The type of version indicator. */
2242
+ /** The discriminator possible values: version_ref */
2243
+ type: VersionIndicatorType;
2244
+ }
2245
+ export declare function versionIndicatorSerializer(item: VersionIndicator): any;
2246
+ export declare function versionIndicatorDeserializer(item: any): VersionIndicator;
2247
+ /** Alias for VersionIndicatorUnion */
2248
+ export type VersionIndicatorUnion = VersionRefIndicator | VersionIndicator;
2249
+ export declare function versionIndicatorUnionSerializer(item: VersionIndicatorUnion): any;
2250
+ export declare function versionIndicatorUnionDeserializer(item: any): VersionIndicatorUnion;
2251
+ /** The type of version indicator used to determine the agent version backing a session. */
2252
+ export type VersionIndicatorType = "version_ref";
2253
+ /** Version indicator that references a specific agent version by name. */
2254
+ export interface VersionRefIndicator extends VersionIndicator {
2255
+ /** Discriminator value for version_ref. */
2256
+ type: "version_ref";
2257
+ /** The agent version identifier returned by the agent version APIs. */
2258
+ agent_version: string;
2259
+ }
2260
+ export declare function versionRefIndicatorSerializer(item: VersionRefIndicator): any;
2261
+ export declare function versionRefIndicatorDeserializer(item: any): VersionRefIndicator;
2262
+ /** An agent session providing a long-lived compute sandbox for hosted agent invocations. */
2263
+ export interface AgentSessionResource {
2264
+ /** The session identifier. */
2265
+ agent_session_id: string;
2266
+ /** The version indicator determining which agent version backs this session. */
2267
+ version_indicator: VersionIndicatorUnion;
2268
+ /** The current status of the session. */
2269
+ status: AgentSessionStatus;
2270
+ /** The Unix timestamp (in seconds) when the session was created. */
2271
+ readonly created_at: Date;
2272
+ /** The Unix timestamp (in seconds) when the session was last accessed. */
2273
+ readonly last_accessed_at: Date;
2274
+ /** The Unix timestamp (in seconds) when the session expires (rolling, 30 days from last activity). */
2275
+ readonly expires_at: Date;
2276
+ }
2277
+ export declare function agentSessionResourceDeserializer(item: any): AgentSessionResource;
2278
+ /** The status of an agent session. */
2279
+ export type AgentSessionStatus = "creating" | "active" | "idle" | "updating" | "failed" | "deleting" | "deleted" | "expired";
2280
+ /** The response data for a requested list of items. */
2281
+ export interface _AgentsPagedResultAgentSessionResource {
2282
+ /** The requested list of items. */
2283
+ data: AgentSessionResource[];
2284
+ /** The first ID represented in this list. */
2285
+ first_id?: string;
2286
+ /** The last ID represented in this list. */
2287
+ last_id?: string;
2288
+ /** A value indicating whether there are additional values available not captured in this list. */
2289
+ has_more: boolean;
2290
+ }
2291
+ export declare function _agentsPagedResultAgentSessionResourceDeserializer(item: any): _AgentsPagedResultAgentSessionResource;
2292
+ export declare function agentSessionResourceArrayDeserializer(result: Array<AgentSessionResource>): any[];
2293
+ /** Response from uploading a file to a session sandbox. */
2294
+ export interface SessionFileWriteResponse {
2295
+ /** The path where the file was written, relative to the session home directory. */
2296
+ path: string;
2297
+ /** Number of bytes written. */
2298
+ bytes_written: number;
2299
+ }
2300
+ export declare function sessionFileWriteResponseDeserializer(item: any): SessionFileWriteResponse;
2301
+ /** Response from listing a directory in a session sandbox. */
2302
+ export interface SessionDirectoryListResponse {
2303
+ /** The path that was listed, relative to the session home directory. */
2304
+ path: string;
2305
+ /** The directory entries. */
2306
+ entries: SessionDirectoryEntry[];
2307
+ }
2308
+ export declare function sessionDirectoryListResponseDeserializer(item: any): SessionDirectoryListResponse;
2309
+ export declare function sessionDirectoryEntryArrayDeserializer(result: Array<SessionDirectoryEntry>): any[];
2310
+ /** A single entry in a directory listing. */
2311
+ export interface SessionDirectoryEntry {
2312
+ /** The name of the file or directory. */
2313
+ name: string;
2314
+ /** The size in bytes (0 for directories). */
2315
+ size: number;
2316
+ /** Whether this entry is a directory. */
2317
+ is_directory: boolean;
2318
+ /** The last modification time in UTC (ISO 8601). */
2319
+ modified_time: Date;
2320
+ }
2321
+ export declare function sessionDirectoryEntryDeserializer(item: any): SessionDirectoryEntry;
1926
2322
  /** Evaluation Taxonomy Definition */
1927
2323
  export interface EvaluationTaxonomy {
1928
2324
  /** Asset ID, a unique identifier for the asset */
@@ -2154,6 +2550,8 @@ export interface EvaluatorMetric {
2154
2550
  min_value?: number;
2155
2551
  /** Maximum value for the metric. If not specified, it is assumed to be unbounded. */
2156
2552
  max_value?: number;
2553
+ /** Default pass/fail threshold for this metric. */
2554
+ threshold?: number;
2157
2555
  /** Indicates if this metric is primary when there are multiple metrics. */
2158
2556
  is_primary?: boolean;
2159
2557
  }
@@ -2165,16 +2563,22 @@ export type EvaluatorMetricType = "ordinal" | "continuous" | "boolean";
2165
2563
  export type EvaluatorMetricDirection = "increase" | "decrease" | "neutral";
2166
2564
  /** Code-based evaluator definition using python code */
2167
2565
  export interface CodeBasedEvaluatorDefinition extends EvaluatorDefinition {
2168
- /** The type discriminator, always 'code_based'. */
2566
+ /** The type discriminator, always 'code'. */
2169
2567
  type: "code";
2170
2568
  /** Inline code text for the evaluator */
2171
- code_text: string;
2569
+ code_text?: string;
2570
+ /** The entry point Python file name for the uploaded evaluator code (e.g. 'answer_length_evaluator.py') */
2571
+ entry_point?: string;
2572
+ /** The container image tag to use for evaluator code execution */
2573
+ image_tag?: string;
2574
+ /** The blob URI for the evaluator storage */
2575
+ blob_uri?: string;
2172
2576
  }
2173
2577
  export declare function codeBasedEvaluatorDefinitionSerializer(item: CodeBasedEvaluatorDefinition): any;
2174
2578
  export declare function codeBasedEvaluatorDefinitionDeserializer(item: any): CodeBasedEvaluatorDefinition;
2175
2579
  /** Prompt-based evaluator */
2176
2580
  export interface PromptBasedEvaluatorDefinition extends EvaluatorDefinition {
2177
- /** The type discriminator, always 'prompt_based'. */
2581
+ /** The type discriminator, always 'prompt'. */
2178
2582
  type: "prompt";
2179
2583
  /** The prompt text used for evaluation */
2180
2584
  prompt_text: string;
@@ -2184,7 +2588,7 @@ export declare function promptBasedEvaluatorDefinitionDeserializer(item: any): P
2184
2588
  /** The response body for cluster insights. */
2185
2589
  export interface Insight {
2186
2590
  /** The unique identifier for the insights report. */
2187
- readonly id?: string;
2591
+ readonly insight_id?: string;
2188
2592
  /** Metadata about the insights report. */
2189
2593
  readonly metadata?: InsightsMetadata;
2190
2594
  /** The current state of the insights. */
@@ -2728,7 +3132,7 @@ export declare function targetConfigUnionSerializer(item: TargetConfigUnion): an
2728
3132
  export declare function targetConfigUnionDeserializer(item: any): TargetConfigUnion;
2729
3133
  /** Azure OpenAI model configuration. The API version would be selected by the service for querying the model. */
2730
3134
  export interface AzureOpenAIModelConfiguration extends TargetConfig {
2731
- /** The type discriminator, always 'azure_openai'. */
3135
+ /** The type discriminator, always 'AzureOpenAIModel'. */
2732
3136
  type: "AzureOpenAIModel";
2733
3137
  /** Deployment name for AOAI model. Example: gpt-4o if in AIServices or connection based `connection_name/deployment_name` (e.g. `my-aoai-connection/gpt-4o`). */
2734
3138
  modelDeploymentName: string;
@@ -2748,7 +3152,7 @@ export declare function redTeamArrayDeserializer(result: Array<RedTeam>): any[];
2748
3152
  /** Schedule model. */
2749
3153
  export interface Schedule {
2750
3154
  /** Identifier of the schedule. */
2751
- readonly id?: string;
3155
+ readonly schedule_id?: string;
2752
3156
  /** Name of the schedule. */
2753
3157
  displayName?: string;
2754
3158
  /** Description of the schedule. */
@@ -2834,7 +3238,7 @@ export declare function recurrenceScheduleUnionDeserializer(item: any): Recurren
2834
3238
  export type RecurrenceType = "Hourly" | "Daily" | "Weekly" | "Monthly";
2835
3239
  /** Hourly recurrence schedule. */
2836
3240
  export interface HourlyRecurrenceSchedule extends RecurrenceSchedule {
2837
- /** The type discriminator, always 'HourlyRecurrence'. */
3241
+ /** The type discriminator, always 'Hourly'. */
2838
3242
  type: "Hourly";
2839
3243
  }
2840
3244
  export declare function hourlyRecurrenceScheduleSerializer(item: HourlyRecurrenceSchedule): any;
@@ -2910,7 +3314,7 @@ export declare function evaluationScheduleTaskDeserializer(item: any): Evaluatio
2910
3314
  export interface _EvaluationScheduleTaskEvalRun {
2911
3315
  [key: string]: unknown;
2912
3316
  }
2913
- export declare function _evaluationScheduleTaskEvalRunSerializer(item: _EvaluationScheduleTaskEvalRun): any;
3317
+ export declare function _evaluationScheduleTaskEvalRunSerializer(_item: _EvaluationScheduleTaskEvalRun): any;
2914
3318
  export declare function _evaluationScheduleTaskEvalRunDeserializer(item: any): _EvaluationScheduleTaskEvalRun;
2915
3319
  /** Insight task for the schedule. */
2916
3320
  export interface InsightScheduleTask extends ScheduleTask {
@@ -2956,26 +3360,137 @@ export interface _PagedScheduleRun {
2956
3360
  }
2957
3361
  export declare function _pagedScheduleRunDeserializer(item: any): _PagedScheduleRun;
2958
3362
  export declare function scheduleRunArrayDeserializer(result: Array<ScheduleRun>): any[];
2959
- /** Alias for _CreateAgentRequestFoundryFeatures */
2960
- export type _CreateAgentRequestFoundryFeatures = "HostedAgents=V1Preview" | "WorkflowAgents=V1Preview";
2961
- export declare function _createAgentRequestFoundryFeaturesSerializer(item: _CreateAgentRequestFoundryFeatures): any;
2962
- /** Alias for _UpdateAgentRequestFoundryFeatures */
2963
- export type _UpdateAgentRequestFoundryFeatures = "HostedAgents=V1Preview" | "WorkflowAgents=V1Preview";
2964
- export declare function _updateAgentRequestFoundryFeaturesSerializer(item: _UpdateAgentRequestFoundryFeatures): any;
2965
- /** Alias for _CreateAgentVersionRequestFoundryFeatures */
2966
- export type _CreateAgentVersionRequestFoundryFeatures = "HostedAgents=V1Preview" | "WorkflowAgents=V1Preview";
2967
- export declare function _createAgentVersionRequestFoundryFeaturesSerializer(item: _CreateAgentVersionRequestFoundryFeatures): any;
3363
+ /** Policy configuration for a toolbox, including content safety and other governance settings. */
3364
+ export interface ToolboxPolicies {
3365
+ /** Responsible AI content filtering configuration. */
3366
+ rai_config?: RaiConfig;
3367
+ }
3368
+ export declare function toolboxPoliciesSerializer(item: ToolboxPolicies): any;
3369
+ export declare function toolboxPoliciesDeserializer(item: any): ToolboxPolicies;
3370
+ /** A specific version of a toolbox. */
3371
+ export interface ToolboxVersionObject {
3372
+ /**
3373
+ * Set of 16 key-value pairs that can be attached to an object. This can be
3374
+ * useful for storing additional information about the object in a structured
3375
+ * format, and querying for objects via API or the dashboard.
3376
+ *
3377
+ * Keys are strings with a maximum length of 64 characters. Values are strings
3378
+ * with a maximum length of 512 characters.
3379
+ */
3380
+ metadata: Record<string, string>;
3381
+ /** The unique identifier of the toolbox version. */
3382
+ id: string;
3383
+ /** The name of the toolbox. */
3384
+ name: string;
3385
+ /** The version identifier of the toolbox. Toolbox versions are immutable and every update creates a new version. */
3386
+ version: string;
3387
+ /** A human-readable description of the toolbox. */
3388
+ description?: string;
3389
+ /** The Unix timestamp (seconds) when the toolbox version was created. */
3390
+ created_at: Date;
3391
+ /** The list of tools contained in this toolbox version. */
3392
+ tools: ToolUnion[];
3393
+ /** Policy configuration for the toolbox version. */
3394
+ policies?: ToolboxPolicies;
3395
+ }
3396
+ export declare function toolboxVersionObjectDeserializer(item: any): ToolboxVersionObject;
3397
+ /** A toolbox that stores reusable tool definitions for agents. */
3398
+ export interface ToolboxObject {
3399
+ /** The unique identifier of the toolbox. */
3400
+ id: string;
3401
+ /** The name of the toolbox. */
3402
+ name: string;
3403
+ /** The version identifier that the toolbox currently points to. Defaults to the latest version. Can be changed via updateToolbox. */
3404
+ default_version: string;
3405
+ }
3406
+ export declare function toolboxObjectDeserializer(item: any): ToolboxObject;
3407
+ /** The response data for a requested list of items. */
3408
+ export interface _AgentsPagedResultToolboxObject {
3409
+ /** The requested list of items. */
3410
+ data: ToolboxObject[];
3411
+ /** The first ID represented in this list. */
3412
+ first_id?: string;
3413
+ /** The last ID represented in this list. */
3414
+ last_id?: string;
3415
+ /** A value indicating whether there are additional values available not captured in this list. */
3416
+ has_more: boolean;
3417
+ }
3418
+ export declare function _agentsPagedResultToolboxObjectDeserializer(item: any): _AgentsPagedResultToolboxObject;
3419
+ export declare function toolboxObjectArrayDeserializer(result: Array<ToolboxObject>): any[];
3420
+ /** The response data for a requested list of items. */
3421
+ export interface _AgentsPagedResultToolboxVersionObject {
3422
+ /** The requested list of items. */
3423
+ data: ToolboxVersionObject[];
3424
+ /** The first ID represented in this list. */
3425
+ first_id?: string;
3426
+ /** The last ID represented in this list. */
3427
+ last_id?: string;
3428
+ /** A value indicating whether there are additional values available not captured in this list. */
3429
+ has_more: boolean;
3430
+ }
3431
+ export declare function _agentsPagedResultToolboxVersionObjectDeserializer(item: any): _AgentsPagedResultToolboxVersionObject;
3432
+ export declare function toolboxVersionObjectArrayDeserializer(result: Array<ToolboxVersionObject>): any[];
3433
+ /** A skill object. */
3434
+ export interface SkillObject {
3435
+ /** The unique identifier of the skill. */
3436
+ skill_id: string;
3437
+ /** Whether the skill was created from a zip blob package. */
3438
+ has_blob: boolean;
3439
+ /** The unique name of the skill. */
3440
+ name: string;
3441
+ /** A human-readable description of the skill. */
3442
+ description?: string;
3443
+ /**
3444
+ * Set of 16 key-value pairs that can be attached to an object. This can be
3445
+ * useful for storing additional information about the object in a structured
3446
+ * format, and querying for objects via API or the dashboard.
3447
+ *
3448
+ * Keys are strings with a maximum length of 64 characters. Values are strings
3449
+ * with a maximum length of 512 characters.
3450
+ */
3451
+ metadata?: Record<string, string>;
3452
+ }
3453
+ export declare function skillObjectDeserializer(item: any): SkillObject;
3454
+ /** The response data for a requested list of items. */
3455
+ export interface _AgentsPagedResultSkillObject {
3456
+ /** The requested list of items. */
3457
+ data: SkillObject[];
3458
+ /** The first ID represented in this list. */
3459
+ first_id?: string;
3460
+ /** The last ID represented in this list. */
3461
+ last_id?: string;
3462
+ /** A value indicating whether there are additional values available not captured in this list. */
3463
+ has_more: boolean;
3464
+ }
3465
+ export declare function _agentsPagedResultSkillObjectDeserializer(item: any): _AgentsPagedResultSkillObject;
3466
+ export declare function skillObjectArrayDeserializer(result: Array<SkillObject>): any[];
3467
+ /** A deleted skill Object */
3468
+ export interface DeleteSkillResponse {
3469
+ /** The unique name of the skill. */
3470
+ name: string;
3471
+ /** Whether the skill was successfully deleted. */
3472
+ deleted: boolean;
3473
+ }
3474
+ export declare function deleteSkillResponseDeserializer(item: any): DeleteSkillResponse;
3475
+ /** model interface UpdateToolboxRequest */
3476
+ export interface UpdateToolboxRequest {
3477
+ /** The name of the toolbox to update. */
3478
+ toolbox_name: string;
3479
+ /** The version identifier that the toolbox should point to. When set, the toolbox's default version will resolve to this version instead of the latest. */
3480
+ default_version: string;
3481
+ }
3482
+ export declare function updateToolboxRequestSerializer(item: UpdateToolboxRequest): any;
2968
3483
  /** Alias for _ListVersionsRequestType */
2969
3484
  export type _ListVersionsRequestType = EvaluatorType | "all";
2970
3485
  export declare function _listVersionsRequestTypeSerializer(item: _ListVersionsRequestType): any;
2971
3486
  /** Type of AgentType */
2972
3487
  export type AgentType = "agent" | "agent.version" | "agent.deleted" | "agent.version.deleted" | "agent.container";
2973
3488
  /** Feature opt-in keys for agent definition operations supporting hosted or workflow agents. */
2974
- export type AgentDefinitionOptInKeys = "HostedAgents=V1Preview" | "WorkflowAgents=V1Preview";
2975
- /** Type of FoundryFeaturesOptInKeys */
2976
- export type FoundryFeaturesOptInKeys = "Evaluations=V1Preview" | "Schedules=V1Preview" | "RedTeams=V1Preview" | "Insights=V1Preview" | "MemoryStores=V1Preview";
3489
+ export type AgentDefinitionOptInKeys = "HostedAgents=V1Preview" | "WorkflowAgents=V1Preview" | "ContainerAgents=V1Preview" | "AgentEndpoints=V1Preview";
2977
3490
  /** Type of PageOrder */
2978
3491
  export type PageOrder = "asc" | "desc";
3492
+ /** Type of FoundryFeaturesOptInKeys */
3493
+ export type FoundryFeaturesOptInKeys = "Skills=V1Preview" | "Evaluations=V1Preview" | "Schedules=V1Preview" | "RedTeams=V1Preview" | "Insights=V1Preview" | "MemoryStores=V1Preview" | "Toolboxes=V1Preview";
2979
3494
  /** The type of pending upload. */
2980
3495
  export type PendingUploadType = "None" | "BlobReference";
2981
3496
  /** Type of MemoryStoreType */
@@ -2985,4 +3500,36 @@ export declare enum KnownApiVersions {
2985
3500
  /** Microsoft Foundry API version v1. */
2986
3501
  v1 = "v1"
2987
3502
  }
3503
+ export type BetaSkillsDownloadResponse = {
3504
+ /**
3505
+ * BROWSER ONLY
3506
+ *
3507
+ * The response body as a browser Blob.
3508
+ * Always `undefined` in node.js.
3509
+ */
3510
+ blobBody?: Promise<Blob>;
3511
+ /**
3512
+ * NODEJS ONLY
3513
+ *
3514
+ * The response body as a node.js Readable stream.
3515
+ * Always `undefined` in the browser.
3516
+ */
3517
+ readableStreamBody?: NodeJS.ReadableStream;
3518
+ };
3519
+ export type BetaAgentsDownloadSessionFileResponse = {
3520
+ /**
3521
+ * BROWSER ONLY
3522
+ *
3523
+ * The response body as a browser Blob.
3524
+ * Always `undefined` in node.js.
3525
+ */
3526
+ blobBody?: Promise<Blob>;
3527
+ /**
3528
+ * NODEJS ONLY
3529
+ *
3530
+ * The response body as a node.js Readable stream.
3531
+ * Always `undefined` in the browser.
3532
+ */
3533
+ readableStreamBody?: NodeJS.ReadableStream;
3534
+ };
2988
3535
  //# sourceMappingURL=models.d.ts.map