@azure/ai-projects 1.0.1 → 2.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (939) hide show
  1. package/README.md +115 -39
  2. package/dist/browser/aiProjectClient.d.ts +39 -36
  3. package/dist/browser/aiProjectClient.d.ts.map +1 -1
  4. package/dist/browser/aiProjectClient.js +66 -57
  5. package/dist/browser/aiProjectClient.js.map +1 -1
  6. package/dist/browser/api/agents/index.d.ts +3 -0
  7. package/dist/browser/api/agents/index.d.ts.map +1 -0
  8. package/dist/browser/api/agents/index.js +4 -0
  9. package/dist/browser/api/agents/index.js.map +1 -0
  10. package/dist/browser/api/agents/operations.d.ts +60 -0
  11. package/dist/browser/api/agents/operations.d.ts.map +1 -0
  12. package/dist/browser/api/agents/operations.js +412 -0
  13. package/dist/browser/api/agents/operations.js.map +1 -0
  14. package/dist/browser/api/agents/options.d.ts +151 -0
  15. package/dist/browser/api/agents/options.d.ts.map +1 -0
  16. package/dist/browser/api/agents/options.js.map +1 -0
  17. package/dist/browser/api/aiProjectContext.d.ts +6 -13
  18. package/dist/browser/api/aiProjectContext.d.ts.map +1 -1
  19. package/dist/browser/api/aiProjectContext.js +10 -17
  20. package/dist/browser/api/aiProjectContext.js.map +1 -1
  21. package/dist/browser/api/connections/index.d.ts +1 -1
  22. package/dist/browser/api/connections/index.d.ts.map +1 -1
  23. package/dist/browser/api/connections/index.js +1 -1
  24. package/dist/browser/api/connections/index.js.map +1 -1
  25. package/dist/browser/api/connections/operations.d.ts +1 -1
  26. package/dist/browser/api/connections/operations.d.ts.map +1 -1
  27. package/dist/browser/api/connections/operations.js +1 -1
  28. package/dist/browser/api/connections/operations.js.map +1 -1
  29. package/dist/browser/api/datasets/operations.d.ts +8 -13
  30. package/dist/browser/api/datasets/operations.d.ts.map +1 -1
  31. package/dist/browser/api/datasets/operations.js +129 -141
  32. package/dist/browser/api/datasets/operations.js.map +1 -1
  33. package/dist/browser/api/deployments/operations.d.ts +1 -1
  34. package/dist/browser/api/deployments/operations.d.ts.map +1 -1
  35. package/dist/browser/api/deployments/operations.js +1 -1
  36. package/dist/browser/api/deployments/operations.js.map +1 -1
  37. package/dist/browser/api/evaluationRules/index.d.ts +3 -0
  38. package/dist/browser/api/evaluationRules/index.d.ts.map +1 -0
  39. package/dist/browser/api/evaluationRules/index.js +4 -0
  40. package/dist/browser/api/evaluationRules/index.js.map +1 -0
  41. package/dist/browser/api/evaluationRules/operations.d.ts +22 -0
  42. package/dist/browser/api/evaluationRules/operations.d.ts.map +1 -0
  43. package/dist/browser/api/evaluationRules/operations.js +126 -0
  44. package/dist/browser/api/evaluationRules/operations.js.map +1 -0
  45. package/dist/browser/api/evaluationRules/options.d.ts +27 -0
  46. package/dist/browser/api/evaluationRules/options.d.ts.map +1 -0
  47. package/dist/browser/api/evaluationRules/options.js.map +1 -0
  48. package/dist/browser/api/evaluationTaxonomies/index.d.ts +3 -0
  49. package/dist/browser/api/evaluationTaxonomies/index.d.ts.map +1 -0
  50. package/dist/browser/api/evaluationTaxonomies/index.js +4 -0
  51. package/dist/browser/api/evaluationTaxonomies/index.js.map +1 -0
  52. package/dist/browser/api/evaluationTaxonomies/operations.d.ts +26 -0
  53. package/dist/browser/api/evaluationTaxonomies/operations.d.ts.map +1 -0
  54. package/dist/browser/api/evaluationTaxonomies/operations.js +154 -0
  55. package/dist/browser/api/evaluationTaxonomies/operations.js.map +1 -0
  56. package/dist/browser/api/evaluationTaxonomies/options.d.ts +27 -0
  57. package/dist/browser/api/evaluationTaxonomies/options.d.ts.map +1 -0
  58. package/dist/browser/api/evaluationTaxonomies/options.js.map +1 -0
  59. package/dist/browser/api/evaluators/index.d.ts +3 -0
  60. package/dist/browser/api/evaluators/index.d.ts.map +1 -0
  61. package/dist/browser/api/evaluators/index.js +4 -0
  62. package/dist/browser/api/evaluators/index.js.map +1 -0
  63. package/dist/browser/api/evaluators/operations.d.ts +30 -0
  64. package/dist/browser/api/evaluators/operations.d.ts.map +1 -0
  65. package/dist/browser/api/evaluators/operations.js +171 -0
  66. package/dist/browser/api/evaluators/operations.js.map +1 -0
  67. package/dist/browser/api/evaluators/options.d.ts +29 -0
  68. package/dist/browser/api/evaluators/options.d.ts.map +1 -0
  69. package/dist/browser/api/evaluators/options.js +4 -0
  70. package/dist/browser/api/evaluators/options.js.map +1 -0
  71. package/dist/browser/api/index.d.ts.map +1 -1
  72. package/dist/browser/api/index.js +2 -0
  73. package/dist/browser/api/index.js.map +1 -1
  74. package/dist/browser/api/indexes/operations.d.ts +3 -8
  75. package/dist/browser/api/indexes/operations.d.ts.map +1 -1
  76. package/dist/browser/api/indexes/operations.js +4 -16
  77. package/dist/browser/api/indexes/operations.js.map +1 -1
  78. package/dist/browser/api/insights/index.d.ts +3 -0
  79. package/dist/browser/api/insights/index.d.ts.map +1 -0
  80. package/dist/browser/api/insights/index.js +4 -0
  81. package/dist/browser/api/insights/index.js.map +1 -0
  82. package/dist/browser/api/insights/operations.d.ts +18 -0
  83. package/dist/browser/api/insights/operations.d.ts.map +1 -0
  84. package/dist/browser/api/insights/operations.js +109 -0
  85. package/dist/browser/api/insights/operations.js.map +1 -0
  86. package/dist/browser/api/insights/options.d.ts +32 -0
  87. package/dist/browser/api/insights/options.d.ts.map +1 -0
  88. package/dist/browser/api/insights/options.js +4 -0
  89. package/dist/browser/api/insights/options.js.map +1 -0
  90. package/dist/browser/api/memoryStores/index.d.ts +3 -0
  91. package/dist/browser/api/memoryStores/index.d.ts.map +1 -0
  92. package/dist/browser/api/memoryStores/index.js +4 -0
  93. package/dist/browser/api/memoryStores/index.js.map +1 -0
  94. package/dist/browser/api/memoryStores/operations.d.ts +43 -0
  95. package/dist/browser/api/memoryStores/operations.d.ts.map +1 -0
  96. package/dist/browser/api/memoryStores/operations.js +306 -0
  97. package/dist/browser/api/memoryStores/operations.js.map +1 -0
  98. package/dist/browser/api/memoryStores/options.d.ts +83 -0
  99. package/dist/browser/api/memoryStores/options.d.ts.map +1 -0
  100. package/dist/browser/api/memoryStores/options.js +4 -0
  101. package/dist/browser/api/memoryStores/options.js.map +1 -0
  102. package/dist/browser/api/redTeams/index.d.ts +3 -0
  103. package/dist/browser/api/redTeams/index.d.ts.map +1 -0
  104. package/dist/browser/api/redTeams/index.js +4 -0
  105. package/dist/browser/api/redTeams/index.js.map +1 -0
  106. package/dist/browser/api/redTeams/operations.d.ts +18 -0
  107. package/dist/browser/api/redTeams/operations.d.ts.map +1 -0
  108. package/dist/browser/api/redTeams/operations.js +93 -0
  109. package/dist/browser/api/redTeams/operations.js.map +1 -0
  110. package/dist/browser/api/redTeams/options.d.ts +15 -0
  111. package/dist/browser/api/redTeams/options.d.ts.map +1 -0
  112. package/dist/browser/api/redTeams/options.js +4 -0
  113. package/dist/browser/api/redTeams/options.js.map +1 -0
  114. package/dist/browser/api/schedules/index.d.ts +3 -0
  115. package/dist/browser/api/schedules/index.d.ts.map +1 -0
  116. package/dist/browser/api/schedules/index.js +4 -0
  117. package/dist/browser/api/schedules/index.js.map +1 -0
  118. package/dist/browser/api/schedules/operations.d.ts +30 -0
  119. package/dist/browser/api/schedules/operations.d.ts.map +1 -0
  120. package/dist/browser/api/schedules/operations.js +178 -0
  121. package/dist/browser/api/schedules/operations.js.map +1 -0
  122. package/dist/browser/api/schedules/options.d.ts +26 -0
  123. package/dist/browser/api/schedules/options.d.ts.map +1 -0
  124. package/dist/browser/api/schedules/options.js +4 -0
  125. package/dist/browser/api/schedules/options.js.map +1 -0
  126. package/dist/browser/classic/agents/index.d.ts +39 -0
  127. package/dist/browser/classic/agents/index.d.ts.map +1 -0
  128. package/dist/browser/classic/agents/index.js +43 -0
  129. package/dist/browser/classic/agents/index.js.map +1 -0
  130. package/dist/browser/classic/connections/index.d.ts +1 -1
  131. package/dist/browser/classic/connections/index.d.ts.map +1 -1
  132. package/dist/browser/classic/connections/index.js.map +1 -1
  133. package/dist/browser/classic/datasets/index.d.ts +4 -9
  134. package/dist/browser/classic/datasets/index.d.ts.map +1 -1
  135. package/dist/browser/classic/datasets/index.js +0 -1
  136. package/dist/browser/classic/datasets/index.js.map +1 -1
  137. package/dist/browser/classic/deployments/index.d.ts +1 -1
  138. package/dist/browser/classic/deployments/index.d.ts.map +1 -1
  139. package/dist/browser/classic/deployments/index.js.map +1 -1
  140. package/dist/browser/classic/evaluationRules/index.d.ts +17 -0
  141. package/dist/browser/classic/evaluationRules/index.d.ts.map +1 -0
  142. package/dist/browser/classic/evaluationRules/index.js +17 -0
  143. package/dist/browser/classic/evaluationRules/index.js.map +1 -0
  144. package/dist/browser/classic/evaluationTaxonomies/index.d.ts +19 -0
  145. package/dist/browser/classic/evaluationTaxonomies/index.d.ts.map +1 -0
  146. package/dist/browser/classic/evaluationTaxonomies/index.js +18 -0
  147. package/dist/browser/classic/evaluationTaxonomies/index.js.map +1 -0
  148. package/dist/browser/classic/evaluators/index.d.ts +21 -0
  149. package/dist/browser/classic/evaluators/index.d.ts.map +1 -0
  150. package/dist/browser/classic/evaluators/index.js +25 -0
  151. package/dist/browser/classic/evaluators/index.js.map +1 -0
  152. package/dist/browser/classic/index.d.ts +8 -1
  153. package/dist/browser/classic/index.d.ts.map +1 -1
  154. package/dist/browser/classic/index.js.map +1 -1
  155. package/dist/browser/classic/indexes/index.d.ts +3 -8
  156. package/dist/browser/classic/indexes/index.d.ts.map +1 -1
  157. package/dist/browser/classic/indexes/index.js +0 -1
  158. package/dist/browser/classic/indexes/index.js.map +1 -1
  159. package/dist/browser/classic/insights/index.d.ts +15 -0
  160. package/dist/browser/classic/insights/index.d.ts.map +1 -0
  161. package/dist/browser/classic/insights/index.js +16 -0
  162. package/dist/browser/classic/insights/index.js.map +1 -0
  163. package/dist/browser/classic/memoryStores/index.d.ts +28 -0
  164. package/dist/browser/classic/memoryStores/index.d.ts.map +1 -0
  165. package/dist/browser/classic/memoryStores/index.js +22 -0
  166. package/dist/browser/classic/memoryStores/index.js.map +1 -0
  167. package/dist/browser/classic/redTeams/index.d.ts +15 -0
  168. package/dist/browser/classic/redTeams/index.d.ts.map +1 -0
  169. package/dist/browser/classic/redTeams/index.js +16 -0
  170. package/dist/browser/classic/redTeams/index.js.map +1 -0
  171. package/dist/browser/classic/schedules/index.d.ts +21 -0
  172. package/dist/browser/classic/schedules/index.d.ts.map +1 -0
  173. package/dist/browser/classic/schedules/index.js +19 -0
  174. package/dist/browser/classic/schedules/index.js.map +1 -0
  175. package/dist/browser/constants.d.ts +1 -1
  176. package/dist/browser/constants.d.ts.map +1 -1
  177. package/dist/browser/constants.js +1 -1
  178. package/dist/browser/constants.js.map +1 -1
  179. package/dist/browser/index.d.ts +11 -5
  180. package/dist/browser/index.d.ts.map +1 -1
  181. package/dist/browser/index.js +2 -1
  182. package/dist/browser/index.js.map +1 -1
  183. package/dist/browser/models/index.d.ts +1 -1
  184. package/dist/browser/models/index.d.ts.map +1 -1
  185. package/dist/browser/models/index.js +1 -1
  186. package/dist/browser/models/index.js.map +1 -1
  187. package/dist/browser/models/models.d.ts +3081 -24
  188. package/dist/browser/models/models.d.ts.map +1 -1
  189. package/dist/browser/models/models.js +3778 -266
  190. package/dist/browser/models/models.js.map +1 -1
  191. package/dist/browser/overwriteOpenAIClient.d.ts +3 -0
  192. package/dist/browser/overwriteOpenAIClient.d.ts.map +1 -0
  193. package/dist/browser/overwriteOpenAIClient.js +14 -0
  194. package/dist/browser/overwriteOpenAIClient.js.map +1 -0
  195. package/dist/browser/restorePollerHelpers.d.ts +24 -0
  196. package/dist/browser/restorePollerHelpers.d.ts.map +1 -0
  197. package/dist/browser/restorePollerHelpers.js +91 -0
  198. package/dist/browser/restorePollerHelpers.js.map +1 -0
  199. package/dist/browser/static-helpers/pollingHelpers.d.ts +30 -0
  200. package/dist/browser/static-helpers/pollingHelpers.d.ts.map +1 -0
  201. package/dist/browser/static-helpers/pollingHelpers.js +79 -0
  202. package/dist/browser/static-helpers/pollingHelpers.js.map +1 -0
  203. package/dist/browser/static-helpers/serialization/serialize-record.d.ts +2 -0
  204. package/dist/browser/static-helpers/serialization/serialize-record.d.ts.map +1 -0
  205. package/dist/browser/static-helpers/serialization/serialize-record.js +20 -0
  206. package/dist/browser/static-helpers/serialization/serialize-record.js.map +1 -0
  207. package/dist/browser/static-helpers/urlTemplate.d.ts.map +1 -1
  208. package/dist/browser/static-helpers/urlTemplate.js +22 -12
  209. package/dist/browser/static-helpers/urlTemplate.js.map +1 -1
  210. package/dist/commonjs/aiProjectClient.d.ts +39 -36
  211. package/dist/commonjs/aiProjectClient.d.ts.map +1 -1
  212. package/dist/commonjs/aiProjectClient.js +71 -61
  213. package/dist/commonjs/aiProjectClient.js.map +1 -1
  214. package/dist/commonjs/api/agents/index.d.ts +3 -0
  215. package/dist/commonjs/api/agents/index.d.ts.map +1 -0
  216. package/dist/commonjs/api/agents/index.js +19 -0
  217. package/dist/commonjs/api/agents/index.js.map +1 -0
  218. package/dist/commonjs/api/agents/operations.d.ts +60 -0
  219. package/dist/commonjs/api/agents/operations.d.ts.map +1 -0
  220. package/dist/commonjs/api/agents/operations.js +450 -0
  221. package/dist/commonjs/api/agents/operations.js.map +1 -0
  222. package/dist/commonjs/api/agents/options.d.ts +151 -0
  223. package/dist/commonjs/api/agents/options.d.ts.map +1 -0
  224. package/dist/commonjs/api/agents/options.js.map +1 -0
  225. package/dist/commonjs/api/aiProjectContext.d.ts +6 -13
  226. package/dist/commonjs/api/aiProjectContext.d.ts.map +1 -1
  227. package/dist/commonjs/api/aiProjectContext.js +10 -17
  228. package/dist/commonjs/api/aiProjectContext.js.map +1 -1
  229. package/dist/commonjs/api/connections/index.d.ts +1 -1
  230. package/dist/commonjs/api/connections/index.d.ts.map +1 -1
  231. package/dist/commonjs/api/connections/index.js +1 -2
  232. package/dist/commonjs/api/connections/index.js.map +1 -1
  233. package/dist/commonjs/api/connections/operations.d.ts +1 -1
  234. package/dist/commonjs/api/connections/operations.d.ts.map +1 -1
  235. package/dist/commonjs/api/connections/operations.js +1 -1
  236. package/dist/commonjs/api/connections/operations.js.map +1 -1
  237. package/dist/commonjs/api/datasets/operations.d.ts +8 -13
  238. package/dist/commonjs/api/datasets/operations.d.ts.map +1 -1
  239. package/dist/commonjs/api/datasets/operations.js +130 -142
  240. package/dist/commonjs/api/datasets/operations.js.map +1 -1
  241. package/dist/commonjs/api/deployments/operations.d.ts +1 -1
  242. package/dist/commonjs/api/deployments/operations.d.ts.map +1 -1
  243. package/dist/commonjs/api/deployments/operations.js +1 -1
  244. package/dist/commonjs/api/deployments/operations.js.map +1 -1
  245. package/dist/commonjs/api/evaluationRules/index.d.ts +3 -0
  246. package/dist/commonjs/api/evaluationRules/index.d.ts.map +1 -0
  247. package/dist/commonjs/api/evaluationRules/index.js +11 -0
  248. package/dist/commonjs/api/evaluationRules/index.js.map +1 -0
  249. package/dist/commonjs/api/evaluationRules/operations.d.ts +22 -0
  250. package/dist/commonjs/api/evaluationRules/operations.d.ts.map +1 -0
  251. package/dist/commonjs/api/evaluationRules/operations.js +140 -0
  252. package/dist/commonjs/api/evaluationRules/operations.js.map +1 -0
  253. package/dist/commonjs/api/evaluationRules/options.d.ts +27 -0
  254. package/dist/commonjs/api/evaluationRules/options.d.ts.map +1 -0
  255. package/dist/commonjs/api/evaluationRules/options.js +5 -0
  256. package/dist/commonjs/api/evaluationRules/options.js.map +1 -0
  257. package/dist/commonjs/api/evaluationTaxonomies/index.d.ts +3 -0
  258. package/dist/commonjs/api/evaluationTaxonomies/index.d.ts.map +1 -0
  259. package/dist/commonjs/api/evaluationTaxonomies/index.js +12 -0
  260. package/dist/commonjs/api/evaluationTaxonomies/index.js.map +1 -0
  261. package/dist/commonjs/api/evaluationTaxonomies/operations.d.ts +26 -0
  262. package/dist/commonjs/api/evaluationTaxonomies/operations.d.ts.map +1 -0
  263. package/dist/commonjs/api/evaluationTaxonomies/operations.js +171 -0
  264. package/dist/commonjs/api/evaluationTaxonomies/operations.js.map +1 -0
  265. package/dist/commonjs/api/evaluationTaxonomies/options.d.ts +27 -0
  266. package/dist/commonjs/api/evaluationTaxonomies/options.d.ts.map +1 -0
  267. package/dist/commonjs/api/evaluationTaxonomies/options.js +5 -0
  268. package/dist/commonjs/api/evaluationTaxonomies/options.js.map +1 -0
  269. package/dist/commonjs/api/evaluators/index.d.ts +3 -0
  270. package/dist/commonjs/api/evaluators/index.d.ts.map +1 -0
  271. package/dist/commonjs/api/evaluators/index.js +13 -0
  272. package/dist/commonjs/api/evaluators/index.js.map +1 -0
  273. package/dist/commonjs/api/evaluators/operations.d.ts +30 -0
  274. package/dist/commonjs/api/evaluators/operations.d.ts.map +1 -0
  275. package/dist/commonjs/api/evaluators/operations.js +191 -0
  276. package/dist/commonjs/api/evaluators/operations.js.map +1 -0
  277. package/dist/commonjs/api/evaluators/options.d.ts +29 -0
  278. package/dist/commonjs/api/evaluators/options.d.ts.map +1 -0
  279. package/dist/commonjs/api/evaluators/options.js +5 -0
  280. package/dist/commonjs/api/evaluators/options.js.map +1 -0
  281. package/dist/commonjs/api/index.d.ts.map +1 -1
  282. package/dist/commonjs/api/index.js +2 -0
  283. package/dist/commonjs/api/index.js.map +1 -1
  284. package/dist/commonjs/api/indexes/operations.d.ts +3 -8
  285. package/dist/commonjs/api/indexes/operations.d.ts.map +1 -1
  286. package/dist/commonjs/api/indexes/operations.js +4 -16
  287. package/dist/commonjs/api/indexes/operations.js.map +1 -1
  288. package/dist/commonjs/api/insights/index.d.ts +3 -0
  289. package/dist/commonjs/api/insights/index.d.ts.map +1 -0
  290. package/dist/commonjs/api/insights/index.js +10 -0
  291. package/dist/commonjs/api/insights/index.js.map +1 -0
  292. package/dist/commonjs/api/insights/operations.d.ts +18 -0
  293. package/dist/commonjs/api/insights/operations.d.ts.map +1 -0
  294. package/dist/commonjs/api/insights/operations.js +120 -0
  295. package/dist/commonjs/api/insights/operations.js.map +1 -0
  296. package/dist/commonjs/api/insights/options.d.ts +32 -0
  297. package/dist/commonjs/api/insights/options.d.ts.map +1 -0
  298. package/dist/commonjs/api/insights/options.js +5 -0
  299. package/dist/commonjs/api/insights/options.js.map +1 -0
  300. package/dist/commonjs/api/memoryStores/index.d.ts +3 -0
  301. package/dist/commonjs/api/memoryStores/index.d.ts.map +1 -0
  302. package/dist/commonjs/api/memoryStores/index.js +16 -0
  303. package/dist/commonjs/api/memoryStores/index.js.map +1 -0
  304. package/dist/commonjs/api/memoryStores/operations.d.ts +43 -0
  305. package/dist/commonjs/api/memoryStores/operations.d.ts.map +1 -0
  306. package/dist/commonjs/api/memoryStores/operations.js +335 -0
  307. package/dist/commonjs/api/memoryStores/operations.js.map +1 -0
  308. package/dist/commonjs/api/memoryStores/options.d.ts +83 -0
  309. package/dist/commonjs/api/memoryStores/options.d.ts.map +1 -0
  310. package/dist/commonjs/api/memoryStores/options.js +5 -0
  311. package/dist/commonjs/api/memoryStores/options.js.map +1 -0
  312. package/dist/commonjs/api/redTeams/index.d.ts +3 -0
  313. package/dist/commonjs/api/redTeams/index.d.ts.map +1 -0
  314. package/dist/commonjs/api/redTeams/index.js +10 -0
  315. package/dist/commonjs/api/redTeams/index.js.map +1 -0
  316. package/dist/commonjs/api/redTeams/operations.d.ts +18 -0
  317. package/dist/commonjs/api/redTeams/operations.d.ts.map +1 -0
  318. package/dist/commonjs/api/redTeams/operations.js +104 -0
  319. package/dist/commonjs/api/redTeams/operations.js.map +1 -0
  320. package/dist/commonjs/api/redTeams/options.d.ts +15 -0
  321. package/dist/commonjs/api/redTeams/options.d.ts.map +1 -0
  322. package/dist/commonjs/api/redTeams/options.js +5 -0
  323. package/dist/commonjs/api/redTeams/options.js.map +1 -0
  324. package/dist/commonjs/api/schedules/index.d.ts +3 -0
  325. package/dist/commonjs/api/schedules/index.d.ts.map +1 -0
  326. package/dist/commonjs/api/schedules/index.js +13 -0
  327. package/dist/commonjs/api/schedules/index.js.map +1 -0
  328. package/dist/commonjs/api/schedules/operations.d.ts +30 -0
  329. package/dist/commonjs/api/schedules/operations.d.ts.map +1 -0
  330. package/dist/commonjs/api/schedules/operations.js +198 -0
  331. package/dist/commonjs/api/schedules/operations.js.map +1 -0
  332. package/dist/commonjs/api/schedules/options.d.ts +26 -0
  333. package/dist/commonjs/api/schedules/options.d.ts.map +1 -0
  334. package/dist/commonjs/api/schedules/options.js +5 -0
  335. package/dist/commonjs/api/schedules/options.js.map +1 -0
  336. package/dist/commonjs/classic/agents/index.d.ts +39 -0
  337. package/dist/commonjs/classic/agents/index.d.ts.map +1 -0
  338. package/dist/commonjs/classic/agents/index.js +46 -0
  339. package/dist/commonjs/classic/agents/index.js.map +1 -0
  340. package/dist/commonjs/classic/connections/index.d.ts +1 -1
  341. package/dist/commonjs/classic/connections/index.d.ts.map +1 -1
  342. package/dist/commonjs/classic/connections/index.js.map +1 -1
  343. package/dist/commonjs/classic/datasets/index.d.ts +4 -9
  344. package/dist/commonjs/classic/datasets/index.d.ts.map +1 -1
  345. package/dist/commonjs/classic/datasets/index.js +0 -1
  346. package/dist/commonjs/classic/datasets/index.js.map +1 -1
  347. package/dist/commonjs/classic/deployments/index.d.ts +1 -1
  348. package/dist/commonjs/classic/deployments/index.d.ts.map +1 -1
  349. package/dist/commonjs/classic/deployments/index.js.map +1 -1
  350. package/dist/commonjs/classic/evaluationRules/index.d.ts +17 -0
  351. package/dist/commonjs/classic/evaluationRules/index.d.ts.map +1 -0
  352. package/dist/commonjs/classic/evaluationRules/index.js +20 -0
  353. package/dist/commonjs/classic/evaluationRules/index.js.map +1 -0
  354. package/dist/commonjs/classic/evaluationTaxonomies/index.d.ts +19 -0
  355. package/dist/commonjs/classic/evaluationTaxonomies/index.d.ts.map +1 -0
  356. package/dist/commonjs/classic/evaluationTaxonomies/index.js +21 -0
  357. package/dist/commonjs/classic/evaluationTaxonomies/index.js.map +1 -0
  358. package/dist/commonjs/classic/evaluators/index.d.ts +21 -0
  359. package/dist/commonjs/classic/evaluators/index.d.ts.map +1 -0
  360. package/dist/commonjs/classic/evaluators/index.js +28 -0
  361. package/dist/commonjs/classic/evaluators/index.js.map +1 -0
  362. package/dist/commonjs/classic/index.d.ts +8 -1
  363. package/dist/commonjs/classic/index.d.ts.map +1 -1
  364. package/dist/commonjs/classic/index.js.map +1 -1
  365. package/dist/commonjs/classic/indexes/index.d.ts +3 -8
  366. package/dist/commonjs/classic/indexes/index.d.ts.map +1 -1
  367. package/dist/commonjs/classic/indexes/index.js +0 -1
  368. package/dist/commonjs/classic/indexes/index.js.map +1 -1
  369. package/dist/commonjs/classic/insights/index.d.ts +15 -0
  370. package/dist/commonjs/classic/insights/index.d.ts.map +1 -0
  371. package/dist/commonjs/classic/insights/index.js +19 -0
  372. package/dist/commonjs/classic/insights/index.js.map +1 -0
  373. package/dist/commonjs/classic/memoryStores/index.d.ts +28 -0
  374. package/dist/commonjs/classic/memoryStores/index.d.ts.map +1 -0
  375. package/dist/commonjs/classic/memoryStores/index.js +25 -0
  376. package/dist/commonjs/classic/memoryStores/index.js.map +1 -0
  377. package/dist/commonjs/classic/redTeams/index.d.ts +15 -0
  378. package/dist/commonjs/classic/redTeams/index.d.ts.map +1 -0
  379. package/dist/commonjs/classic/redTeams/index.js +19 -0
  380. package/dist/commonjs/classic/redTeams/index.js.map +1 -0
  381. package/dist/commonjs/classic/schedules/index.d.ts +21 -0
  382. package/dist/commonjs/classic/schedules/index.d.ts.map +1 -0
  383. package/dist/commonjs/classic/schedules/index.js +22 -0
  384. package/dist/commonjs/classic/schedules/index.js.map +1 -0
  385. package/dist/commonjs/constants.d.ts +1 -1
  386. package/dist/commonjs/constants.d.ts.map +1 -1
  387. package/dist/commonjs/constants.js +1 -1
  388. package/dist/commonjs/constants.js.map +1 -1
  389. package/dist/commonjs/index.d.ts +11 -5
  390. package/dist/commonjs/index.d.ts.map +1 -1
  391. package/dist/commonjs/index.js +4 -2
  392. package/dist/commonjs/index.js.map +1 -1
  393. package/dist/commonjs/models/index.d.ts +1 -1
  394. package/dist/commonjs/models/index.d.ts.map +1 -1
  395. package/dist/commonjs/models/index.js +2 -2
  396. package/dist/commonjs/models/index.js.map +1 -1
  397. package/dist/commonjs/models/models.d.ts +3081 -24
  398. package/dist/commonjs/models/models.d.ts.map +1 -1
  399. package/dist/commonjs/models/models.js +4263 -270
  400. package/dist/commonjs/models/models.js.map +1 -1
  401. package/dist/commonjs/overwriteOpenAIClient.d.ts +3 -0
  402. package/dist/commonjs/overwriteOpenAIClient.d.ts.map +1 -0
  403. package/dist/commonjs/overwriteOpenAIClient.js +17 -0
  404. package/dist/commonjs/overwriteOpenAIClient.js.map +1 -0
  405. package/dist/commonjs/restorePollerHelpers.d.ts +24 -0
  406. package/dist/commonjs/restorePollerHelpers.d.ts.map +1 -0
  407. package/dist/commonjs/restorePollerHelpers.js +94 -0
  408. package/dist/commonjs/restorePollerHelpers.js.map +1 -0
  409. package/dist/commonjs/static-helpers/pollingHelpers.d.ts +30 -0
  410. package/dist/commonjs/static-helpers/pollingHelpers.d.ts.map +1 -0
  411. package/dist/commonjs/static-helpers/pollingHelpers.js +82 -0
  412. package/dist/commonjs/static-helpers/pollingHelpers.js.map +1 -0
  413. package/dist/commonjs/static-helpers/serialization/serialize-record.d.ts +2 -0
  414. package/dist/commonjs/static-helpers/serialization/serialize-record.d.ts.map +1 -0
  415. package/dist/commonjs/static-helpers/serialization/serialize-record.js +23 -0
  416. package/dist/commonjs/static-helpers/serialization/serialize-record.js.map +1 -0
  417. package/dist/commonjs/static-helpers/urlTemplate.d.ts.map +1 -1
  418. package/dist/commonjs/static-helpers/urlTemplate.js +22 -12
  419. package/dist/commonjs/static-helpers/urlTemplate.js.map +1 -1
  420. package/dist/commonjs/tsdoc-metadata.json +1 -1
  421. package/dist/esm/aiProjectClient.d.ts +39 -36
  422. package/dist/esm/aiProjectClient.d.ts.map +1 -1
  423. package/dist/esm/aiProjectClient.js +66 -57
  424. package/dist/esm/aiProjectClient.js.map +1 -1
  425. package/dist/esm/api/agents/index.d.ts +3 -0
  426. package/dist/esm/api/agents/index.d.ts.map +1 -0
  427. package/dist/esm/api/agents/index.js +4 -0
  428. package/dist/esm/api/agents/index.js.map +1 -0
  429. package/dist/esm/api/agents/operations.d.ts +60 -0
  430. package/dist/esm/api/agents/operations.d.ts.map +1 -0
  431. package/dist/esm/api/agents/operations.js +412 -0
  432. package/dist/esm/api/agents/operations.js.map +1 -0
  433. package/dist/esm/api/agents/options.d.ts +151 -0
  434. package/dist/esm/api/agents/options.d.ts.map +1 -0
  435. package/dist/esm/api/agents/options.js +4 -0
  436. package/dist/esm/api/agents/options.js.map +1 -0
  437. package/dist/esm/api/aiProjectContext.d.ts +6 -13
  438. package/dist/esm/api/aiProjectContext.d.ts.map +1 -1
  439. package/dist/esm/api/aiProjectContext.js +10 -17
  440. package/dist/esm/api/aiProjectContext.js.map +1 -1
  441. package/dist/esm/api/connections/index.d.ts +1 -1
  442. package/dist/esm/api/connections/index.d.ts.map +1 -1
  443. package/dist/esm/api/connections/index.js +1 -1
  444. package/dist/esm/api/connections/index.js.map +1 -1
  445. package/dist/esm/api/connections/operations.d.ts +1 -1
  446. package/dist/esm/api/connections/operations.d.ts.map +1 -1
  447. package/dist/esm/api/connections/operations.js +1 -1
  448. package/dist/esm/api/connections/operations.js.map +1 -1
  449. package/dist/esm/api/datasets/operations.d.ts +8 -13
  450. package/dist/esm/api/datasets/operations.d.ts.map +1 -1
  451. package/dist/esm/api/datasets/operations.js +129 -141
  452. package/dist/esm/api/datasets/operations.js.map +1 -1
  453. package/dist/esm/api/deployments/operations.d.ts +1 -1
  454. package/dist/esm/api/deployments/operations.d.ts.map +1 -1
  455. package/dist/esm/api/deployments/operations.js +1 -1
  456. package/dist/esm/api/deployments/operations.js.map +1 -1
  457. package/dist/esm/api/evaluationRules/index.d.ts +3 -0
  458. package/dist/esm/api/evaluationRules/index.d.ts.map +1 -0
  459. package/dist/esm/api/evaluationRules/index.js +4 -0
  460. package/dist/esm/api/evaluationRules/index.js.map +1 -0
  461. package/dist/esm/api/evaluationRules/operations.d.ts +22 -0
  462. package/dist/esm/api/evaluationRules/operations.d.ts.map +1 -0
  463. package/dist/esm/api/evaluationRules/operations.js +126 -0
  464. package/dist/esm/api/evaluationRules/operations.js.map +1 -0
  465. package/dist/esm/api/evaluationRules/options.d.ts +27 -0
  466. package/dist/esm/api/evaluationRules/options.d.ts.map +1 -0
  467. package/dist/esm/api/evaluationRules/options.js +4 -0
  468. package/dist/esm/api/evaluationRules/options.js.map +1 -0
  469. package/dist/esm/api/evaluationTaxonomies/index.d.ts +3 -0
  470. package/dist/esm/api/evaluationTaxonomies/index.d.ts.map +1 -0
  471. package/dist/esm/api/evaluationTaxonomies/index.js +4 -0
  472. package/dist/esm/api/evaluationTaxonomies/index.js.map +1 -0
  473. package/dist/esm/api/evaluationTaxonomies/operations.d.ts +26 -0
  474. package/dist/esm/api/evaluationTaxonomies/operations.d.ts.map +1 -0
  475. package/dist/esm/api/evaluationTaxonomies/operations.js +154 -0
  476. package/dist/esm/api/evaluationTaxonomies/operations.js.map +1 -0
  477. package/dist/esm/api/evaluationTaxonomies/options.d.ts +27 -0
  478. package/dist/esm/api/evaluationTaxonomies/options.d.ts.map +1 -0
  479. package/dist/esm/api/evaluationTaxonomies/options.js +4 -0
  480. package/dist/esm/api/evaluationTaxonomies/options.js.map +1 -0
  481. package/dist/esm/api/evaluators/index.d.ts +3 -0
  482. package/dist/esm/api/evaluators/index.d.ts.map +1 -0
  483. package/dist/esm/api/evaluators/index.js +4 -0
  484. package/dist/esm/api/evaluators/index.js.map +1 -0
  485. package/dist/esm/api/evaluators/operations.d.ts +30 -0
  486. package/dist/esm/api/evaluators/operations.d.ts.map +1 -0
  487. package/dist/esm/api/evaluators/operations.js +171 -0
  488. package/dist/esm/api/evaluators/operations.js.map +1 -0
  489. package/dist/esm/api/evaluators/options.d.ts +29 -0
  490. package/dist/esm/api/evaluators/options.d.ts.map +1 -0
  491. package/dist/esm/api/evaluators/options.js +4 -0
  492. package/dist/esm/api/evaluators/options.js.map +1 -0
  493. package/dist/esm/api/index.d.ts.map +1 -1
  494. package/dist/esm/api/index.js +2 -0
  495. package/dist/esm/api/index.js.map +1 -1
  496. package/dist/esm/api/indexes/operations.d.ts +3 -8
  497. package/dist/esm/api/indexes/operations.d.ts.map +1 -1
  498. package/dist/esm/api/indexes/operations.js +4 -16
  499. package/dist/esm/api/indexes/operations.js.map +1 -1
  500. package/dist/esm/api/insights/index.d.ts +3 -0
  501. package/dist/esm/api/insights/index.d.ts.map +1 -0
  502. package/dist/esm/api/insights/index.js +4 -0
  503. package/dist/esm/api/insights/index.js.map +1 -0
  504. package/dist/esm/api/insights/operations.d.ts +18 -0
  505. package/dist/esm/api/insights/operations.d.ts.map +1 -0
  506. package/dist/esm/api/insights/operations.js +109 -0
  507. package/dist/esm/api/insights/operations.js.map +1 -0
  508. package/dist/esm/api/insights/options.d.ts +32 -0
  509. package/dist/esm/api/insights/options.d.ts.map +1 -0
  510. package/dist/esm/api/insights/options.js +4 -0
  511. package/dist/esm/api/insights/options.js.map +1 -0
  512. package/dist/esm/api/memoryStores/index.d.ts +3 -0
  513. package/dist/esm/api/memoryStores/index.d.ts.map +1 -0
  514. package/dist/esm/api/memoryStores/index.js +4 -0
  515. package/dist/esm/api/memoryStores/index.js.map +1 -0
  516. package/dist/esm/api/memoryStores/operations.d.ts +43 -0
  517. package/dist/esm/api/memoryStores/operations.d.ts.map +1 -0
  518. package/dist/esm/api/memoryStores/operations.js +306 -0
  519. package/dist/esm/api/memoryStores/operations.js.map +1 -0
  520. package/dist/esm/api/memoryStores/options.d.ts +83 -0
  521. package/dist/esm/api/memoryStores/options.d.ts.map +1 -0
  522. package/dist/esm/api/memoryStores/options.js +4 -0
  523. package/dist/esm/api/memoryStores/options.js.map +1 -0
  524. package/dist/esm/api/redTeams/index.d.ts +3 -0
  525. package/dist/esm/api/redTeams/index.d.ts.map +1 -0
  526. package/dist/esm/api/redTeams/index.js +4 -0
  527. package/dist/esm/api/redTeams/index.js.map +1 -0
  528. package/dist/esm/api/redTeams/operations.d.ts +18 -0
  529. package/dist/esm/api/redTeams/operations.d.ts.map +1 -0
  530. package/dist/esm/api/redTeams/operations.js +93 -0
  531. package/dist/esm/api/redTeams/operations.js.map +1 -0
  532. package/dist/esm/api/redTeams/options.d.ts +15 -0
  533. package/dist/esm/api/redTeams/options.d.ts.map +1 -0
  534. package/dist/esm/api/redTeams/options.js +4 -0
  535. package/dist/esm/api/redTeams/options.js.map +1 -0
  536. package/dist/esm/api/schedules/index.d.ts +3 -0
  537. package/dist/esm/api/schedules/index.d.ts.map +1 -0
  538. package/dist/esm/api/schedules/index.js +4 -0
  539. package/dist/esm/api/schedules/index.js.map +1 -0
  540. package/dist/esm/api/schedules/operations.d.ts +30 -0
  541. package/dist/esm/api/schedules/operations.d.ts.map +1 -0
  542. package/dist/esm/api/schedules/operations.js +178 -0
  543. package/dist/esm/api/schedules/operations.js.map +1 -0
  544. package/dist/esm/api/schedules/options.d.ts +26 -0
  545. package/dist/esm/api/schedules/options.d.ts.map +1 -0
  546. package/dist/esm/api/schedules/options.js +4 -0
  547. package/dist/esm/api/schedules/options.js.map +1 -0
  548. package/dist/esm/classic/agents/index.d.ts +39 -0
  549. package/dist/esm/classic/agents/index.d.ts.map +1 -0
  550. package/dist/esm/classic/agents/index.js +43 -0
  551. package/dist/esm/classic/agents/index.js.map +1 -0
  552. package/dist/esm/classic/connections/index.d.ts +1 -1
  553. package/dist/esm/classic/connections/index.d.ts.map +1 -1
  554. package/dist/esm/classic/connections/index.js.map +1 -1
  555. package/dist/esm/classic/datasets/index.d.ts +4 -9
  556. package/dist/esm/classic/datasets/index.d.ts.map +1 -1
  557. package/dist/esm/classic/datasets/index.js +0 -1
  558. package/dist/esm/classic/datasets/index.js.map +1 -1
  559. package/dist/esm/classic/deployments/index.d.ts +1 -1
  560. package/dist/esm/classic/deployments/index.d.ts.map +1 -1
  561. package/dist/esm/classic/deployments/index.js.map +1 -1
  562. package/dist/esm/classic/evaluationRules/index.d.ts +17 -0
  563. package/dist/esm/classic/evaluationRules/index.d.ts.map +1 -0
  564. package/dist/esm/classic/evaluationRules/index.js +17 -0
  565. package/dist/esm/classic/evaluationRules/index.js.map +1 -0
  566. package/dist/esm/classic/evaluationTaxonomies/index.d.ts +19 -0
  567. package/dist/esm/classic/evaluationTaxonomies/index.d.ts.map +1 -0
  568. package/dist/esm/classic/evaluationTaxonomies/index.js +18 -0
  569. package/dist/esm/classic/evaluationTaxonomies/index.js.map +1 -0
  570. package/dist/esm/classic/evaluators/index.d.ts +21 -0
  571. package/dist/esm/classic/evaluators/index.d.ts.map +1 -0
  572. package/dist/esm/classic/evaluators/index.js +25 -0
  573. package/dist/esm/classic/evaluators/index.js.map +1 -0
  574. package/dist/esm/classic/index.d.ts +8 -1
  575. package/dist/esm/classic/index.d.ts.map +1 -1
  576. package/dist/esm/classic/index.js.map +1 -1
  577. package/dist/esm/classic/indexes/index.d.ts +3 -8
  578. package/dist/esm/classic/indexes/index.d.ts.map +1 -1
  579. package/dist/esm/classic/indexes/index.js +0 -1
  580. package/dist/esm/classic/indexes/index.js.map +1 -1
  581. package/dist/esm/classic/insights/index.d.ts +15 -0
  582. package/dist/esm/classic/insights/index.d.ts.map +1 -0
  583. package/dist/esm/classic/insights/index.js +16 -0
  584. package/dist/esm/classic/insights/index.js.map +1 -0
  585. package/dist/esm/classic/memoryStores/index.d.ts +28 -0
  586. package/dist/esm/classic/memoryStores/index.d.ts.map +1 -0
  587. package/dist/esm/classic/memoryStores/index.js +22 -0
  588. package/dist/esm/classic/memoryStores/index.js.map +1 -0
  589. package/dist/esm/classic/redTeams/index.d.ts +15 -0
  590. package/dist/esm/classic/redTeams/index.d.ts.map +1 -0
  591. package/dist/esm/classic/redTeams/index.js +16 -0
  592. package/dist/esm/classic/redTeams/index.js.map +1 -0
  593. package/dist/esm/classic/schedules/index.d.ts +21 -0
  594. package/dist/esm/classic/schedules/index.d.ts.map +1 -0
  595. package/dist/esm/classic/schedules/index.js +19 -0
  596. package/dist/esm/classic/schedules/index.js.map +1 -0
  597. package/dist/esm/constants.d.ts +1 -1
  598. package/dist/esm/constants.d.ts.map +1 -1
  599. package/dist/esm/constants.js +1 -1
  600. package/dist/esm/constants.js.map +1 -1
  601. package/dist/esm/index.d.ts +11 -5
  602. package/dist/esm/index.d.ts.map +1 -1
  603. package/dist/esm/index.js +2 -1
  604. package/dist/esm/index.js.map +1 -1
  605. package/dist/esm/models/index.d.ts +1 -1
  606. package/dist/esm/models/index.d.ts.map +1 -1
  607. package/dist/esm/models/index.js +1 -1
  608. package/dist/esm/models/index.js.map +1 -1
  609. package/dist/esm/models/models.d.ts +3081 -24
  610. package/dist/esm/models/models.d.ts.map +1 -1
  611. package/dist/esm/models/models.js +3778 -266
  612. package/dist/esm/models/models.js.map +1 -1
  613. package/dist/esm/overwriteOpenAIClient.d.ts +3 -0
  614. package/dist/esm/overwriteOpenAIClient.d.ts.map +1 -0
  615. package/dist/esm/overwriteOpenAIClient.js +14 -0
  616. package/dist/esm/overwriteOpenAIClient.js.map +1 -0
  617. package/dist/esm/restorePollerHelpers.d.ts +24 -0
  618. package/dist/esm/restorePollerHelpers.d.ts.map +1 -0
  619. package/dist/esm/restorePollerHelpers.js +91 -0
  620. package/dist/esm/restorePollerHelpers.js.map +1 -0
  621. package/dist/esm/static-helpers/pollingHelpers.d.ts +30 -0
  622. package/dist/esm/static-helpers/pollingHelpers.d.ts.map +1 -0
  623. package/dist/esm/static-helpers/pollingHelpers.js +79 -0
  624. package/dist/esm/static-helpers/pollingHelpers.js.map +1 -0
  625. package/dist/esm/static-helpers/serialization/serialize-record.d.ts +2 -0
  626. package/dist/esm/static-helpers/serialization/serialize-record.d.ts.map +1 -0
  627. package/dist/esm/static-helpers/serialization/serialize-record.js +20 -0
  628. package/dist/esm/static-helpers/serialization/serialize-record.js.map +1 -0
  629. package/dist/esm/static-helpers/urlTemplate.d.ts.map +1 -1
  630. package/dist/esm/static-helpers/urlTemplate.js +22 -12
  631. package/dist/esm/static-helpers/urlTemplate.js.map +1 -1
  632. package/dist/react-native/aiProjectClient.d.ts +39 -36
  633. package/dist/react-native/aiProjectClient.d.ts.map +1 -1
  634. package/dist/react-native/aiProjectClient.js +66 -57
  635. package/dist/react-native/aiProjectClient.js.map +1 -1
  636. package/dist/react-native/api/agents/index.d.ts +3 -0
  637. package/dist/react-native/api/agents/index.d.ts.map +1 -0
  638. package/dist/react-native/api/agents/index.js +4 -0
  639. package/dist/react-native/api/agents/index.js.map +1 -0
  640. package/dist/react-native/api/agents/operations.d.ts +60 -0
  641. package/dist/react-native/api/agents/operations.d.ts.map +1 -0
  642. package/dist/react-native/api/agents/operations.js +412 -0
  643. package/dist/react-native/api/agents/operations.js.map +1 -0
  644. package/dist/react-native/api/agents/options.d.ts +151 -0
  645. package/dist/react-native/api/agents/options.d.ts.map +1 -0
  646. package/dist/react-native/api/agents/options.js +4 -0
  647. package/dist/react-native/api/agents/options.js.map +1 -0
  648. package/dist/react-native/api/aiProjectContext.d.ts +6 -13
  649. package/dist/react-native/api/aiProjectContext.d.ts.map +1 -1
  650. package/dist/react-native/api/aiProjectContext.js +10 -17
  651. package/dist/react-native/api/aiProjectContext.js.map +1 -1
  652. package/dist/react-native/api/connections/index.d.ts +1 -1
  653. package/dist/react-native/api/connections/index.d.ts.map +1 -1
  654. package/dist/react-native/api/connections/index.js +1 -1
  655. package/dist/react-native/api/connections/index.js.map +1 -1
  656. package/dist/react-native/api/connections/operations.d.ts +1 -1
  657. package/dist/react-native/api/connections/operations.d.ts.map +1 -1
  658. package/dist/react-native/api/connections/operations.js +1 -1
  659. package/dist/react-native/api/connections/operations.js.map +1 -1
  660. package/dist/react-native/api/datasets/operations.d.ts +8 -13
  661. package/dist/react-native/api/datasets/operations.d.ts.map +1 -1
  662. package/dist/react-native/api/datasets/operations.js +129 -141
  663. package/dist/react-native/api/datasets/operations.js.map +1 -1
  664. package/dist/react-native/api/deployments/operations.d.ts +1 -1
  665. package/dist/react-native/api/deployments/operations.d.ts.map +1 -1
  666. package/dist/react-native/api/deployments/operations.js +1 -1
  667. package/dist/react-native/api/deployments/operations.js.map +1 -1
  668. package/dist/react-native/api/evaluationRules/index.d.ts +3 -0
  669. package/dist/react-native/api/evaluationRules/index.d.ts.map +1 -0
  670. package/dist/react-native/api/evaluationRules/index.js +4 -0
  671. package/dist/react-native/api/evaluationRules/index.js.map +1 -0
  672. package/dist/react-native/api/evaluationRules/operations.d.ts +22 -0
  673. package/dist/react-native/api/evaluationRules/operations.d.ts.map +1 -0
  674. package/dist/react-native/api/evaluationRules/operations.js +126 -0
  675. package/dist/react-native/api/evaluationRules/operations.js.map +1 -0
  676. package/dist/react-native/api/evaluationRules/options.d.ts +27 -0
  677. package/dist/react-native/api/evaluationRules/options.d.ts.map +1 -0
  678. package/dist/react-native/api/evaluationRules/options.js +4 -0
  679. package/dist/react-native/api/evaluationRules/options.js.map +1 -0
  680. package/dist/react-native/api/evaluationTaxonomies/index.d.ts +3 -0
  681. package/dist/react-native/api/evaluationTaxonomies/index.d.ts.map +1 -0
  682. package/dist/react-native/api/evaluationTaxonomies/index.js +4 -0
  683. package/dist/react-native/api/evaluationTaxonomies/index.js.map +1 -0
  684. package/dist/react-native/api/evaluationTaxonomies/operations.d.ts +26 -0
  685. package/dist/react-native/api/evaluationTaxonomies/operations.d.ts.map +1 -0
  686. package/dist/react-native/api/evaluationTaxonomies/operations.js +154 -0
  687. package/dist/react-native/api/evaluationTaxonomies/operations.js.map +1 -0
  688. package/dist/react-native/api/evaluationTaxonomies/options.d.ts +27 -0
  689. package/dist/react-native/api/evaluationTaxonomies/options.d.ts.map +1 -0
  690. package/dist/react-native/api/evaluationTaxonomies/options.js +4 -0
  691. package/dist/react-native/api/evaluationTaxonomies/options.js.map +1 -0
  692. package/dist/react-native/api/evaluators/index.d.ts +3 -0
  693. package/dist/react-native/api/evaluators/index.d.ts.map +1 -0
  694. package/dist/react-native/api/evaluators/index.js +4 -0
  695. package/dist/react-native/api/evaluators/index.js.map +1 -0
  696. package/dist/react-native/api/evaluators/operations.d.ts +30 -0
  697. package/dist/react-native/api/evaluators/operations.d.ts.map +1 -0
  698. package/dist/react-native/api/evaluators/operations.js +171 -0
  699. package/dist/react-native/api/evaluators/operations.js.map +1 -0
  700. package/dist/react-native/api/evaluators/options.d.ts +29 -0
  701. package/dist/react-native/api/evaluators/options.d.ts.map +1 -0
  702. package/dist/react-native/api/evaluators/options.js +4 -0
  703. package/dist/react-native/api/evaluators/options.js.map +1 -0
  704. package/dist/react-native/api/index.d.ts.map +1 -1
  705. package/dist/react-native/api/index.js +2 -0
  706. package/dist/react-native/api/index.js.map +1 -1
  707. package/dist/react-native/api/indexes/operations.d.ts +3 -8
  708. package/dist/react-native/api/indexes/operations.d.ts.map +1 -1
  709. package/dist/react-native/api/indexes/operations.js +4 -16
  710. package/dist/react-native/api/indexes/operations.js.map +1 -1
  711. package/dist/react-native/api/insights/index.d.ts +3 -0
  712. package/dist/react-native/api/insights/index.d.ts.map +1 -0
  713. package/dist/react-native/api/insights/index.js +4 -0
  714. package/dist/react-native/api/insights/index.js.map +1 -0
  715. package/dist/react-native/api/insights/operations.d.ts +18 -0
  716. package/dist/react-native/api/insights/operations.d.ts.map +1 -0
  717. package/dist/react-native/api/insights/operations.js +109 -0
  718. package/dist/react-native/api/insights/operations.js.map +1 -0
  719. package/dist/react-native/api/insights/options.d.ts +32 -0
  720. package/dist/react-native/api/insights/options.d.ts.map +1 -0
  721. package/dist/react-native/api/insights/options.js +4 -0
  722. package/dist/react-native/api/insights/options.js.map +1 -0
  723. package/dist/react-native/api/memoryStores/index.d.ts +3 -0
  724. package/dist/react-native/api/memoryStores/index.d.ts.map +1 -0
  725. package/dist/react-native/api/memoryStores/index.js +4 -0
  726. package/dist/react-native/api/memoryStores/index.js.map +1 -0
  727. package/dist/react-native/api/memoryStores/operations.d.ts +43 -0
  728. package/dist/react-native/api/memoryStores/operations.d.ts.map +1 -0
  729. package/dist/react-native/api/memoryStores/operations.js +306 -0
  730. package/dist/react-native/api/memoryStores/operations.js.map +1 -0
  731. package/dist/react-native/api/memoryStores/options.d.ts +83 -0
  732. package/dist/react-native/api/memoryStores/options.d.ts.map +1 -0
  733. package/dist/react-native/api/memoryStores/options.js +4 -0
  734. package/dist/react-native/api/memoryStores/options.js.map +1 -0
  735. package/dist/react-native/api/redTeams/index.d.ts +3 -0
  736. package/dist/react-native/api/redTeams/index.d.ts.map +1 -0
  737. package/dist/react-native/api/redTeams/index.js +4 -0
  738. package/dist/react-native/api/redTeams/index.js.map +1 -0
  739. package/dist/react-native/api/redTeams/operations.d.ts +18 -0
  740. package/dist/react-native/api/redTeams/operations.d.ts.map +1 -0
  741. package/dist/react-native/api/redTeams/operations.js +93 -0
  742. package/dist/react-native/api/redTeams/operations.js.map +1 -0
  743. package/dist/react-native/api/redTeams/options.d.ts +15 -0
  744. package/dist/react-native/api/redTeams/options.d.ts.map +1 -0
  745. package/dist/react-native/api/redTeams/options.js +4 -0
  746. package/dist/react-native/api/redTeams/options.js.map +1 -0
  747. package/dist/react-native/api/schedules/index.d.ts +3 -0
  748. package/dist/react-native/api/schedules/index.d.ts.map +1 -0
  749. package/dist/react-native/api/schedules/index.js +4 -0
  750. package/dist/react-native/api/schedules/index.js.map +1 -0
  751. package/dist/react-native/api/schedules/operations.d.ts +30 -0
  752. package/dist/react-native/api/schedules/operations.d.ts.map +1 -0
  753. package/dist/react-native/api/schedules/operations.js +178 -0
  754. package/dist/react-native/api/schedules/operations.js.map +1 -0
  755. package/dist/react-native/api/schedules/options.d.ts +26 -0
  756. package/dist/react-native/api/schedules/options.d.ts.map +1 -0
  757. package/dist/react-native/api/schedules/options.js +4 -0
  758. package/dist/react-native/api/schedules/options.js.map +1 -0
  759. package/dist/react-native/classic/agents/index.d.ts +39 -0
  760. package/dist/react-native/classic/agents/index.d.ts.map +1 -0
  761. package/dist/react-native/classic/agents/index.js +43 -0
  762. package/dist/react-native/classic/agents/index.js.map +1 -0
  763. package/dist/react-native/classic/connections/index.d.ts +1 -1
  764. package/dist/react-native/classic/connections/index.d.ts.map +1 -1
  765. package/dist/react-native/classic/connections/index.js.map +1 -1
  766. package/dist/react-native/classic/datasets/index.d.ts +4 -9
  767. package/dist/react-native/classic/datasets/index.d.ts.map +1 -1
  768. package/dist/react-native/classic/datasets/index.js +0 -1
  769. package/dist/react-native/classic/datasets/index.js.map +1 -1
  770. package/dist/react-native/classic/deployments/index.d.ts +1 -1
  771. package/dist/react-native/classic/deployments/index.d.ts.map +1 -1
  772. package/dist/react-native/classic/deployments/index.js.map +1 -1
  773. package/dist/react-native/classic/evaluationRules/index.d.ts +17 -0
  774. package/dist/react-native/classic/evaluationRules/index.d.ts.map +1 -0
  775. package/dist/react-native/classic/evaluationRules/index.js +17 -0
  776. package/dist/react-native/classic/evaluationRules/index.js.map +1 -0
  777. package/dist/react-native/classic/evaluationTaxonomies/index.d.ts +19 -0
  778. package/dist/react-native/classic/evaluationTaxonomies/index.d.ts.map +1 -0
  779. package/dist/react-native/classic/evaluationTaxonomies/index.js +18 -0
  780. package/dist/react-native/classic/evaluationTaxonomies/index.js.map +1 -0
  781. package/dist/react-native/classic/evaluators/index.d.ts +21 -0
  782. package/dist/react-native/classic/evaluators/index.d.ts.map +1 -0
  783. package/dist/react-native/classic/evaluators/index.js +25 -0
  784. package/dist/react-native/classic/evaluators/index.js.map +1 -0
  785. package/dist/react-native/classic/index.d.ts +8 -1
  786. package/dist/react-native/classic/index.d.ts.map +1 -1
  787. package/dist/react-native/classic/index.js.map +1 -1
  788. package/dist/react-native/classic/indexes/index.d.ts +3 -8
  789. package/dist/react-native/classic/indexes/index.d.ts.map +1 -1
  790. package/dist/react-native/classic/indexes/index.js +0 -1
  791. package/dist/react-native/classic/indexes/index.js.map +1 -1
  792. package/dist/react-native/classic/insights/index.d.ts +15 -0
  793. package/dist/react-native/classic/insights/index.d.ts.map +1 -0
  794. package/dist/react-native/classic/insights/index.js +16 -0
  795. package/dist/react-native/classic/insights/index.js.map +1 -0
  796. package/dist/react-native/classic/memoryStores/index.d.ts +28 -0
  797. package/dist/react-native/classic/memoryStores/index.d.ts.map +1 -0
  798. package/dist/react-native/classic/memoryStores/index.js +22 -0
  799. package/dist/react-native/classic/memoryStores/index.js.map +1 -0
  800. package/dist/react-native/classic/redTeams/index.d.ts +15 -0
  801. package/dist/react-native/classic/redTeams/index.d.ts.map +1 -0
  802. package/dist/react-native/classic/redTeams/index.js +16 -0
  803. package/dist/react-native/classic/redTeams/index.js.map +1 -0
  804. package/dist/react-native/classic/schedules/index.d.ts +21 -0
  805. package/dist/react-native/classic/schedules/index.d.ts.map +1 -0
  806. package/dist/react-native/classic/schedules/index.js +19 -0
  807. package/dist/react-native/classic/schedules/index.js.map +1 -0
  808. package/dist/react-native/constants.d.ts +1 -1
  809. package/dist/react-native/constants.d.ts.map +1 -1
  810. package/dist/react-native/constants.js +1 -1
  811. package/dist/react-native/constants.js.map +1 -1
  812. package/dist/react-native/index.d.ts +11 -5
  813. package/dist/react-native/index.d.ts.map +1 -1
  814. package/dist/react-native/index.js +2 -1
  815. package/dist/react-native/index.js.map +1 -1
  816. package/dist/react-native/models/index.d.ts +1 -1
  817. package/dist/react-native/models/index.d.ts.map +1 -1
  818. package/dist/react-native/models/index.js +1 -1
  819. package/dist/react-native/models/index.js.map +1 -1
  820. package/dist/react-native/models/models.d.ts +3081 -24
  821. package/dist/react-native/models/models.d.ts.map +1 -1
  822. package/dist/react-native/models/models.js +3778 -266
  823. package/dist/react-native/models/models.js.map +1 -1
  824. package/dist/react-native/overwriteOpenAIClient.d.ts +3 -0
  825. package/dist/react-native/overwriteOpenAIClient.d.ts.map +1 -0
  826. package/dist/react-native/overwriteOpenAIClient.js +14 -0
  827. package/dist/react-native/overwriteOpenAIClient.js.map +1 -0
  828. package/dist/react-native/restorePollerHelpers.d.ts +24 -0
  829. package/dist/react-native/restorePollerHelpers.d.ts.map +1 -0
  830. package/dist/react-native/restorePollerHelpers.js +91 -0
  831. package/dist/react-native/restorePollerHelpers.js.map +1 -0
  832. package/dist/react-native/static-helpers/pollingHelpers.d.ts +30 -0
  833. package/dist/react-native/static-helpers/pollingHelpers.d.ts.map +1 -0
  834. package/dist/react-native/static-helpers/pollingHelpers.js +79 -0
  835. package/dist/react-native/static-helpers/pollingHelpers.js.map +1 -0
  836. package/dist/react-native/static-helpers/serialization/serialize-record.d.ts +2 -0
  837. package/dist/react-native/static-helpers/serialization/serialize-record.d.ts.map +1 -0
  838. package/dist/react-native/static-helpers/serialization/serialize-record.js +20 -0
  839. package/dist/react-native/static-helpers/serialization/serialize-record.js.map +1 -0
  840. package/dist/react-native/static-helpers/urlTemplate.d.ts.map +1 -1
  841. package/dist/react-native/static-helpers/urlTemplate.js +22 -12
  842. package/dist/react-native/static-helpers/urlTemplate.js.map +1 -1
  843. package/package.json +11 -11
  844. package/dist/browser/api/inference/operations.d.ts +0 -19
  845. package/dist/browser/api/inference/operations.d.ts.map +0 -1
  846. package/dist/browser/api/inference/operations.js +0 -96
  847. package/dist/browser/api/inference/operations.js.map +0 -1
  848. package/dist/browser/api/inference/options.d.ts +0 -21
  849. package/dist/browser/api/inference/options.d.ts.map +0 -1
  850. package/dist/browser/api/inference/options.js.map +0 -1
  851. package/dist/browser/api/telemetry/index.d.ts +0 -2
  852. package/dist/browser/api/telemetry/index.d.ts.map +0 -1
  853. package/dist/browser/api/telemetry/index.js +0 -4
  854. package/dist/browser/api/telemetry/index.js.map +0 -1
  855. package/dist/browser/api/telemetry/operations.d.ts +0 -22
  856. package/dist/browser/api/telemetry/operations.d.ts.map +0 -1
  857. package/dist/browser/api/telemetry/operations.js +0 -55
  858. package/dist/browser/api/telemetry/operations.js.map +0 -1
  859. package/dist/browser/classic/inference/index.d.ts +0 -11
  860. package/dist/browser/classic/inference/index.d.ts.map +0 -1
  861. package/dist/browser/classic/inference/index.js +0 -14
  862. package/dist/browser/classic/inference/index.js.map +0 -1
  863. package/dist/browser/classic/telemetry/index.d.ts +0 -8
  864. package/dist/browser/classic/telemetry/index.d.ts.map +0 -1
  865. package/dist/browser/classic/telemetry/index.js +0 -13
  866. package/dist/browser/classic/telemetry/index.js.map +0 -1
  867. package/dist/commonjs/api/inference/operations.d.ts +0 -19
  868. package/dist/commonjs/api/inference/operations.d.ts.map +0 -1
  869. package/dist/commonjs/api/inference/operations.js +0 -99
  870. package/dist/commonjs/api/inference/operations.js.map +0 -1
  871. package/dist/commonjs/api/inference/options.d.ts +0 -21
  872. package/dist/commonjs/api/inference/options.d.ts.map +0 -1
  873. package/dist/commonjs/api/inference/options.js.map +0 -1
  874. package/dist/commonjs/api/telemetry/index.d.ts +0 -2
  875. package/dist/commonjs/api/telemetry/index.d.ts.map +0 -1
  876. package/dist/commonjs/api/telemetry/index.js +0 -8
  877. package/dist/commonjs/api/telemetry/index.js.map +0 -1
  878. package/dist/commonjs/api/telemetry/operations.d.ts +0 -22
  879. package/dist/commonjs/api/telemetry/operations.d.ts.map +0 -1
  880. package/dist/commonjs/api/telemetry/operations.js +0 -58
  881. package/dist/commonjs/api/telemetry/operations.js.map +0 -1
  882. package/dist/commonjs/classic/inference/index.d.ts +0 -11
  883. package/dist/commonjs/classic/inference/index.d.ts.map +0 -1
  884. package/dist/commonjs/classic/inference/index.js +0 -17
  885. package/dist/commonjs/classic/inference/index.js.map +0 -1
  886. package/dist/commonjs/classic/telemetry/index.d.ts +0 -8
  887. package/dist/commonjs/classic/telemetry/index.d.ts.map +0 -1
  888. package/dist/commonjs/classic/telemetry/index.js +0 -16
  889. package/dist/commonjs/classic/telemetry/index.js.map +0 -1
  890. package/dist/esm/api/inference/operations.d.ts +0 -19
  891. package/dist/esm/api/inference/operations.d.ts.map +0 -1
  892. package/dist/esm/api/inference/operations.js +0 -96
  893. package/dist/esm/api/inference/operations.js.map +0 -1
  894. package/dist/esm/api/inference/options.d.ts +0 -21
  895. package/dist/esm/api/inference/options.d.ts.map +0 -1
  896. package/dist/esm/api/inference/options.js.map +0 -1
  897. package/dist/esm/api/telemetry/index.d.ts +0 -2
  898. package/dist/esm/api/telemetry/index.d.ts.map +0 -1
  899. package/dist/esm/api/telemetry/index.js +0 -4
  900. package/dist/esm/api/telemetry/index.js.map +0 -1
  901. package/dist/esm/api/telemetry/operations.d.ts +0 -22
  902. package/dist/esm/api/telemetry/operations.d.ts.map +0 -1
  903. package/dist/esm/api/telemetry/operations.js +0 -55
  904. package/dist/esm/api/telemetry/operations.js.map +0 -1
  905. package/dist/esm/classic/inference/index.d.ts +0 -11
  906. package/dist/esm/classic/inference/index.d.ts.map +0 -1
  907. package/dist/esm/classic/inference/index.js +0 -14
  908. package/dist/esm/classic/inference/index.js.map +0 -1
  909. package/dist/esm/classic/telemetry/index.d.ts +0 -8
  910. package/dist/esm/classic/telemetry/index.d.ts.map +0 -1
  911. package/dist/esm/classic/telemetry/index.js +0 -13
  912. package/dist/esm/classic/telemetry/index.js.map +0 -1
  913. package/dist/react-native/api/inference/operations.d.ts +0 -19
  914. package/dist/react-native/api/inference/operations.d.ts.map +0 -1
  915. package/dist/react-native/api/inference/operations.js +0 -96
  916. package/dist/react-native/api/inference/operations.js.map +0 -1
  917. package/dist/react-native/api/inference/options.d.ts +0 -21
  918. package/dist/react-native/api/inference/options.d.ts.map +0 -1
  919. package/dist/react-native/api/inference/options.js.map +0 -1
  920. package/dist/react-native/api/telemetry/index.d.ts +0 -2
  921. package/dist/react-native/api/telemetry/index.d.ts.map +0 -1
  922. package/dist/react-native/api/telemetry/index.js +0 -4
  923. package/dist/react-native/api/telemetry/index.js.map +0 -1
  924. package/dist/react-native/api/telemetry/operations.d.ts +0 -22
  925. package/dist/react-native/api/telemetry/operations.d.ts.map +0 -1
  926. package/dist/react-native/api/telemetry/operations.js +0 -55
  927. package/dist/react-native/api/telemetry/operations.js.map +0 -1
  928. package/dist/react-native/classic/inference/index.d.ts +0 -11
  929. package/dist/react-native/classic/inference/index.d.ts.map +0 -1
  930. package/dist/react-native/classic/inference/index.js +0 -14
  931. package/dist/react-native/classic/inference/index.js.map +0 -1
  932. package/dist/react-native/classic/telemetry/index.d.ts +0 -8
  933. package/dist/react-native/classic/telemetry/index.d.ts.map +0 -1
  934. package/dist/react-native/classic/telemetry/index.js +0 -13
  935. package/dist/react-native/classic/telemetry/index.js.map +0 -1
  936. /package/dist/browser/api/{inference → agents}/options.js +0 -0
  937. /package/dist/{esm/api/inference → browser/api/evaluationRules}/options.js +0 -0
  938. /package/dist/{react-native/api/inference → browser/api/evaluationTaxonomies}/options.js +0 -0
  939. /package/dist/commonjs/api/{inference → agents}/options.js +0 -0
@@ -1,3 +1,2168 @@
1
+ /**
2
+ * Represents an agent object.
3
+ * Contains the agent's unique identifier, name, and version information.
4
+ */
5
+ export interface Agent {
6
+ /** The object type, which is always 'agent'. */
7
+ object: "agent";
8
+ /** The unique identifier of the agent. */
9
+ id: string;
10
+ /** The name of the agent. */
11
+ name: string;
12
+ /** The latest version of the agent. */
13
+ versions: {
14
+ latest: AgentVersion;
15
+ };
16
+ }
17
+ export declare function agentObjectDeserializer(item: any): Agent;
18
+ /**
19
+ * Helper interface for agent version references.
20
+ */
21
+ export interface _AgentVersions {
22
+ latest: AgentVersion;
23
+ }
24
+ export declare function _agentObjectVersionsDeserializer(item: any): _AgentVersions;
25
+ /**
26
+ * Represents a specific version of an agent.
27
+ * Includes metadata, versioning, creation time, and agent definition.
28
+ */
29
+ export interface AgentVersion {
30
+ /**
31
+ * Set of 16 key-value pairs that can be attached to an object. This can be
32
+ * useful for storing additional information about the object in a structured
33
+ * format, and querying for objects via API or the dashboard.
34
+ *
35
+ * Keys are strings with a maximum length of 64 characters. Values are strings
36
+ * with a maximum length of 512 characters.
37
+ */
38
+ metadata: Record<string, string>;
39
+ /** The object type, which is always 'agent.version'. */
40
+ object: "agent.version";
41
+ /** The unique identifier of the agent version. */
42
+ id: string;
43
+ /** The name of the agent. Name can be used to retrieve/update/delete the agent. */
44
+ name: string;
45
+ /** The version identifier of the agent. Agents are immutable and every update creates a new version while keeping the name same. */
46
+ version: string;
47
+ /** A human-readable description of the agent. */
48
+ description?: string;
49
+ /** The Unix timestamp (seconds) when the agent was created. */
50
+ created_at: Date;
51
+ /** The definition of the agent. */
52
+ definition: AgentDefinitionUnion;
53
+ }
54
+ export declare function agentVersionObjectDeserializer(item: any): AgentVersion;
55
+ /**
56
+ * Base definition interface for agents.
57
+ * Contains the agent kind and optional RAI configuration.
58
+ */
59
+ export interface AgentDefinition {
60
+ kind: AgentKind;
61
+ /** Configuration for Responsible AI (RAI) content filtering and safety features. */
62
+ rai_config?: RaiConfig;
63
+ }
64
+ export declare function agentDefinitionSerializer(item: AgentDefinition): any;
65
+ export declare function agentDefinitionDeserializer(item: any): AgentDefinition;
66
+ /**
67
+ * Union type for all agent definition types.
68
+ * Supports workflow, hosted, container app, and prompt agents.
69
+ */
70
+ export type AgentDefinitionUnion = WorkflowAgentDefinition | HostedAgentDefinitionUnion | ContainerAppAgentDefinition | PromptAgentDefinition | AgentDefinition;
71
+ export declare function agentDefinitionUnionSerializer(item: AgentDefinitionUnion): any;
72
+ export declare function agentDefinitionUnionDeserializer(item: any): AgentDefinitionUnion;
73
+ /**
74
+ * Defines the type/kind of agent.
75
+ * Determines which agent definition structure is used.
76
+ */
77
+ export type AgentKind = "prompt" | "hosted" | "container_app" | "workflow";
78
+ /** Configuration for Responsible AI (RAI) content filtering and safety features. */
79
+ export interface RaiConfig {
80
+ /** The name of the RAI policy to apply. */
81
+ rai_policy_name: string;
82
+ }
83
+ export declare function raiConfigSerializer(item: RaiConfig): any;
84
+ export declare function raiConfigDeserializer(item: any): RaiConfig;
85
+ /** The workflow agent definition. */
86
+ export interface WorkflowAgentDefinition extends AgentDefinition {
87
+ kind: "workflow";
88
+ /** The CSDL YAML definition of the workflow. */
89
+ workflow?: string;
90
+ }
91
+ export declare function workflowAgentDefinitionSerializer(item: WorkflowAgentDefinition): any;
92
+ export declare function workflowAgentDefinitionDeserializer(item: any): WorkflowAgentDefinition;
93
+ /** The hosted agent definition. */
94
+ export interface HostedAgentDefinition extends AgentDefinition {
95
+ /** The kind of agent definition. */
96
+ kind: "hosted";
97
+ /**
98
+ * An array of tools the hosted agent's model may call while generating a response. You
99
+ * can specify which tool to use by setting the `tool_choice` parameter.
100
+ */
101
+ tools?: ToolUnion[];
102
+ /** The protocols that the agent supports for ingress communication of the containers. */
103
+ container_protocol_versions: ProtocolVersionRecord[];
104
+ /** The CPU configuration for the hosted agent. */
105
+ cpu: string;
106
+ /** The memory configuration for the hosted agent. */
107
+ memory: string;
108
+ /** Environment variables to set in the hosted agent container. */
109
+ environment_variables?: Record<string, string>;
110
+ }
111
+ export declare function hostedAgentDefinitionSerializer(item: HostedAgentDefinition): any;
112
+ export declare function hostedAgentDefinitionDeserializer(item: any): HostedAgentDefinition;
113
+ /** Alias for HostedAgentDefinitionUnion */
114
+ export type HostedAgentDefinitionUnion = ImageBasedHostedAgentDefinition | HostedAgentDefinition;
115
+ export declare function hostedAgentDefinitionUnionSerializer(item: HostedAgentDefinitionUnion): any;
116
+ export declare function hostedAgentDefinitionUnionDeserializer(item: any): HostedAgentDefinitionUnion;
117
+ export declare function toolUnionArraySerializer(result: Array<ToolUnion>): any[];
118
+ export declare function toolUnionArrayDeserializer(result: Array<ToolUnion>): any[];
119
+ /** model interface Tool */
120
+ export interface Tool {
121
+ type: ToolType;
122
+ }
123
+ export declare function toolSerializer(item: Tool): any;
124
+ export declare function toolDeserializer(item: any): Tool;
125
+ /** Alias for ToolUnion */
126
+ export type ToolUnion = FunctionTool | FileSearchTool | ComputerUsePreviewTool | WebSearchPreviewTool | CodeInterpreterTool | ImageGenTool | LocalShellTool | MCPTool | BingGroundingAgentTool | MicrosoftFabricAgentTool | SharepointAgentTool | AzureAISearchAgentTool | OpenApiAgentTool | BingCustomSearchAgentTool | BrowserAutomationAgentTool | AzureFunctionAgentTool | CaptureStructuredOutputsTool | A2ATool | MemorySearchTool | Tool;
127
+ export declare function toolUnionSerializer(item: ToolUnion): any;
128
+ export declare function toolUnionDeserializer(item: any): ToolUnion;
129
+ /** A tool that can be used to generate a response. */
130
+ export type ToolType = "file_search" | "function" | "computer_use_preview" | "web_search_preview" | "mcp" | "code_interpreter" | "image_generation" | "local_shell" | "bing_grounding" | "browser_automation_preview" | "fabric_dataagent_preview" | "sharepoint_grounding_preview" | "azure_ai_search" | "openapi" | "bing_custom_search_preview" | "capture_structured_outputs" | "a2a_preview" | "azure_function" | "memory_search";
131
+ /**
132
+ * Function tool definition for agents.
133
+ * Allows the model to call functions defined in your code.
134
+ * Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).
135
+ */
136
+ export interface FunctionTool extends Tool {
137
+ /** The type of the function tool. Always `function`. */
138
+ type: "function";
139
+ /** The name of the function to call. */
140
+ name: string;
141
+ /** A description of the function. Used by the model to determine whether or not to call the function. */
142
+ description?: string;
143
+ /** A JSON schema object describing the parameters of the function. */
144
+ parameters: unknown;
145
+ /** Whether to enforce strict parameter validation. Default `true`. */
146
+ strict: boolean;
147
+ }
148
+ export declare function functionToolSerializer(item: FunctionTool): any;
149
+ export declare function functionToolDeserializer(item: any): FunctionTool;
150
+ /**
151
+ * File search tool definition for agents.
152
+ * Searches for relevant content from uploaded files.
153
+ * Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
154
+ */
155
+ export interface FileSearchTool extends Tool {
156
+ /** The type of the file search tool. Always `file_search`. */
157
+ type: "file_search";
158
+ /** The IDs of the vector stores to search. */
159
+ vector_store_ids: string[];
160
+ /** The maximum number of results to return. This number should be between 1 and 50 inclusive. */
161
+ max_num_results?: number;
162
+ /** Ranking options for search. */
163
+ ranking_options?: RankingOptions;
164
+ /** A filter to apply. */
165
+ filters?: Filters;
166
+ }
167
+ export declare function fileSearchToolSerializer(item: FileSearchTool): any;
168
+ export declare function fileSearchToolDeserializer(item: any): FileSearchTool;
169
+ /**
170
+ * Ranking options for file search.
171
+ * Controls which ranker to use and the score threshold for results.
172
+ */
173
+ export interface RankingOptions {
174
+ /** The ranker to use for the file search. */
175
+ ranker?: "auto" | "default-2024-11-15";
176
+ /** The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. */
177
+ score_threshold?: number;
178
+ }
179
+ export declare function rankingOptionsSerializer(item: RankingOptions): any;
180
+ export declare function rankingOptionsDeserializer(item: any): RankingOptions;
181
+ /**
182
+ * Filter types for file search.
183
+ * Can be either a comparison filter or a compound filter combining multiple filters.
184
+ */
185
+ export type Filters = ComparisonFilter | CompoundFilter;
186
+ export declare function filtersSerializer(item: Filters): any;
187
+ export declare function filtersDeserializer(item: any): Filters;
188
+ /**
189
+ * Comparison filter for file search.
190
+ * Compares a specified attribute key to a given value using a comparison operation.
191
+ */
192
+ export interface ComparisonFilter {
193
+ /**
194
+ * Specifies the comparison operator:
195
+ * `eq` (equal), `ne` (not equal), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal).
196
+ */
197
+ type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
198
+ /** The key to compare against the value. */
199
+ key: string;
200
+ /** The value to compare against the attribute key; supports string, number, or boolean types. */
201
+ value: string | number | boolean;
202
+ }
203
+ export declare function comparisonFilterSerializer(item: ComparisonFilter): any;
204
+ export declare function comparisonFilterDeserializer(item: any): ComparisonFilter;
205
+ /** Alias for _ComparisonFilterValue */
206
+ export type _ComparisonFilterValue = string | number | boolean;
207
+ export declare function _comparisonFilterValueSerializer(item: _ComparisonFilterValue): any;
208
+ export declare function _comparisonFilterValueDeserializer(item: any): _ComparisonFilterValue;
209
+ /**
210
+ * Compound filter for file search.
211
+ * Combines multiple filters using logical AND or OR operations.
212
+ */
213
+ export interface CompoundFilter {
214
+ /** Type of operation: `and` or `or`. */
215
+ type: "and" | "or";
216
+ /** Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. */
217
+ filters: (ComparisonFilter | CompoundFilter)[];
218
+ }
219
+ export declare function compoundFilterSerializer(item: CompoundFilter): any;
220
+ export declare function compoundFilterDeserializer(item: any): CompoundFilter;
221
+ export declare function _compoundFilterFilterArraySerializer(result: Array<_CompoundFilterFilter>): any[];
222
+ export declare function _compoundFilterFilterArrayDeserializer(result: Array<_CompoundFilterFilter>): any[];
223
+ /** Alias for _CompoundFilterFilter */
224
+ export type _CompoundFilterFilter = ComparisonFilter | CompoundFilter;
225
+ export declare function _compoundFilterFilterSerializer(item: _CompoundFilterFilter): any;
226
+ export declare function _compoundFilterFilterDeserializer(item: any): _CompoundFilterFilter;
227
+ /** A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). */
228
+ export interface ComputerUsePreviewTool extends Tool {
229
+ /** The type of the computer use tool. Always `computer_use_preview`. */
230
+ type: "computer_use_preview";
231
+ /** The type of computer environment to control. */
232
+ environment: "windows" | "mac" | "linux" | "browser";
233
+ /** The width of the computer display. */
234
+ display_width: number;
235
+ /** The height of the computer display. */
236
+ display_height: number;
237
+ }
238
+ export declare function computerUsePreviewToolSerializer(item: ComputerUsePreviewTool): any;
239
+ export declare function computerUsePreviewToolDeserializer(item: any): ComputerUsePreviewTool;
240
+ /**
241
+ * Web search tool definition for agents.
242
+ * Note: web_search is not yet available via Azure OpenAI.
243
+ */
244
+ export interface WebSearchPreviewTool extends Tool {
245
+ /** The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. */
246
+ type: "web_search_preview";
247
+ /** The user's location. */
248
+ user_location?: LocationUnion;
249
+ /** 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. */
250
+ search_context_size?: "low" | "medium" | "high";
251
+ }
252
+ export declare function webSearchPreviewToolSerializer(item: WebSearchPreviewTool): any;
253
+ export declare function webSearchPreviewToolDeserializer(item: any): WebSearchPreviewTool;
254
+ /**
255
+ * Base interface for location information.
256
+ */
257
+ export interface Location {
258
+ type: LocationType;
259
+ }
260
+ export declare function locationSerializer(item: Location): any;
261
+ export declare function locationDeserializer(item: any): Location;
262
+ /** Alias for LocationUnion */
263
+ export type LocationUnion = ApproximateLocation | Location;
264
+ export declare function locationUnionSerializer(item: LocationUnion): any;
265
+ export declare function locationUnionDeserializer(item: any): LocationUnion;
266
+ /**
267
+ * Type discriminator for location.
268
+ */
269
+ export type LocationType = "approximate";
270
+ /**
271
+ * Approximate location information for web search.
272
+ * Includes country, region, city, and timezone.
273
+ */
274
+ export interface ApproximateLocation extends Location {
275
+ type: "approximate";
276
+ /** The country of the location. */
277
+ country?: string;
278
+ /** The region of the location. */
279
+ region?: string;
280
+ /** The city of the location. */
281
+ city?: string;
282
+ /** The timezone of the location. */
283
+ timezone?: string;
284
+ }
285
+ export declare function approximateLocationSerializer(item: ApproximateLocation): any;
286
+ export declare function approximateLocationDeserializer(item: any): ApproximateLocation;
287
+ /**
288
+ * Code interpreter tool definition for agents.
289
+ * Runs Python code to help generate responses to prompts.
290
+ */
291
+ export interface CodeInterpreterTool extends Tool {
292
+ /** The type of the code interpreter tool. Always `code_interpreter`. */
293
+ type: "code_interpreter";
294
+ /**
295
+ * The code interpreter container. Can be a container ID or an object that
296
+ * specifies uploaded file IDs to make available to your code.
297
+ */
298
+ container: string | CodeInterpreterToolAuto;
299
+ }
300
+ export declare function codeInterpreterToolSerializer(item: CodeInterpreterTool): any;
301
+ export declare function codeInterpreterToolDeserializer(item: any): CodeInterpreterTool;
302
+ /** Alias for _CodeInterpreterToolContainer */
303
+ export type _CodeInterpreterToolContainer = string | CodeInterpreterToolAuto;
304
+ export declare function _codeInterpreterToolContainerSerializer(item: _CodeInterpreterToolContainer): any;
305
+ export declare function _codeInterpreterToolContainerDeserializer(item: any): _CodeInterpreterToolContainer;
306
+ /**
307
+ * Configuration for a code interpreter container. Optionally specify the IDs
308
+ * of the files to run the code on.
309
+ */
310
+ export interface CodeInterpreterToolAuto {
311
+ /** Always `auto`. */
312
+ type: "auto";
313
+ /** An optional list of uploaded files to make available to your code. */
314
+ file_ids?: string[];
315
+ }
316
+ export declare function codeInterpreterToolAutoSerializer(item: CodeInterpreterToolAuto): any;
317
+ export declare function codeInterpreterToolAutoDeserializer(item: any): CodeInterpreterToolAuto;
318
+ /**
319
+ * Image generation tool definition for agents.
320
+ * Generates images using a model like `gpt-image-1`.
321
+ */
322
+ export interface ImageGenTool extends Tool {
323
+ /** The type of the image generation tool. Always `image_generation`. */
324
+ type: "image_generation";
325
+ /** The image generation model to use. Default: `gpt-image-1`. */
326
+ model?: "gpt-image-1";
327
+ /**
328
+ * The quality of the generated image. One of `low`, `medium`, `high`,
329
+ * or `auto`. Default: `auto`.
330
+ */
331
+ quality?: "low" | "medium" | "high" | "auto";
332
+ /**
333
+ * The size of the generated image. One of `1024x1024`, `1024x1536`,
334
+ * `1536x1024`, or `auto`. Default: `auto`.
335
+ */
336
+ size?: "1024x1024" | "1024x1536" | "1536x1024" | "auto";
337
+ /**
338
+ * The output format of the generated image. One of `png`, `webp`, or
339
+ * `jpeg`. Default: `png`.
340
+ */
341
+ output_format?: "png" | "webp" | "jpeg";
342
+ /** Compression level for the output image. Default: 100. */
343
+ output_compression?: number;
344
+ /** Moderation level for the generated image. Default: `auto`. */
345
+ moderation?: "auto" | "low";
346
+ /**
347
+ * Background type for the generated image. One of `transparent`,
348
+ * `opaque`, or `auto`. Default: `auto`.
349
+ */
350
+ background?: "transparent" | "opaque" | "auto";
351
+ /**
352
+ * Optional mask for inpainting. Contains `image_url`
353
+ * (string, optional) and `file_id` (string, optional).
354
+ */
355
+ input_image_mask?: {
356
+ image_url?: string;
357
+ file_id?: string;
358
+ };
359
+ /** Number of partial images to generate in streaming mode, from 0 (default value) to 3. */
360
+ partial_images?: number;
361
+ }
362
+ export declare function imageGenToolSerializer(item: ImageGenTool): any;
363
+ export declare function imageGenToolDeserializer(item: any): ImageGenTool;
364
+ /**
365
+ * Input image mask configuration for image generation tool.
366
+ * Can specify either a base64-encoded image URL or a file ID.
367
+ */
368
+ export interface _ImageGenToolInputImageMask {
369
+ /** Base64-encoded mask image. */
370
+ image_url?: string;
371
+ /** File ID for the mask image. */
372
+ file_id?: string;
373
+ }
374
+ export declare function _imageGenToolInputImageMaskSerializer(item: _ImageGenToolInputImageMask): any;
375
+ export declare function _imageGenToolInputImageMaskDeserializer(item: any): _ImageGenToolInputImageMask;
376
+ /**
377
+ * Local shell tool definition for agents.
378
+ * Allows the model to execute shell commands in a local environment.
379
+ */
380
+ export interface LocalShellTool extends Tool {
381
+ /** The type of the local shell tool. Always `local_shell`. */
382
+ type: "local_shell";
383
+ }
384
+ export declare function localShellToolSerializer(item: LocalShellTool): any;
385
+ export declare function localShellToolDeserializer(item: any): LocalShellTool;
386
+ /**
387
+ * MCP (Model Context Protocol) tool definition for agents.
388
+ * Gives the model access to additional tools via remote MCP servers.
389
+ * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
390
+ */
391
+ export interface MCPTool extends Tool {
392
+ /** The type of the MCP tool. Always `mcp`. */
393
+ type: "mcp";
394
+ /** A label for this MCP server, used to identify it in tool calls. */
395
+ server_label: string;
396
+ /** The URL for the MCP server. */
397
+ server_url: string;
398
+ /**
399
+ * Optional HTTP headers to send to the MCP server. Use for authentication
400
+ * or other purposes.
401
+ */
402
+ headers?: Record<string, string>;
403
+ /** List of allowed tool names or a filter object. */
404
+ allowed_tools?: string[] | {
405
+ tool_names?: string[];
406
+ };
407
+ /** Specify which of the MCP server's tools require approval. */
408
+ require_approval?: {
409
+ /** A list of tools that always require approval. */
410
+ always?: {
411
+ /** List of tool names (snake_case) that always require approval. */
412
+ tool_names?: string[];
413
+ };
414
+ /** A list of tools that never require approval. */
415
+ never?: {
416
+ /** List of tool names (snake_case) that never require approval. */
417
+ tool_names?: string[];
418
+ };
419
+ } | "always" | "never";
420
+ /** 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. */
421
+ project_connection_id?: string;
422
+ }
423
+ export declare function mcpToolSerializer(item: MCPTool): any;
424
+ export declare function mcpToolDeserializer(item: any): MCPTool;
425
+ /** Alias for _MCPToolAllowedTools */
426
+ export type _MCPToolAllowedTools = string[] | {
427
+ tool_names?: string[];
428
+ };
429
+ export declare function _mcpToolAllowedToolsSerializer(item: _MCPToolAllowedTools): any;
430
+ export declare function _mcpToolAllowedToolsDeserializer(item: any): _MCPToolAllowedTools;
431
+ /** model interface _MCPToolAllowedTools1 */
432
+ export interface _MCPToolAllowedTools1 {
433
+ /** List of allowed tool names. */
434
+ tool_names?: string[];
435
+ }
436
+ export declare function _mcpToolAllowedTools1Serializer(item: _MCPToolAllowedTools1): any;
437
+ export declare function _mcpToolAllowedTools1Deserializer(item: any): _MCPToolAllowedTools1;
438
+ /** Alias for _MCPToolRequireApproval */
439
+ export type _MCPToolRequireApproval = {
440
+ always?: {
441
+ tool_names?: string[];
442
+ };
443
+ never?: {
444
+ tool_names?: string[];
445
+ };
446
+ } | "always" | "never";
447
+ export declare function _mcpToolRequireApprovalSerializer(item: _MCPToolRequireApproval): any;
448
+ export declare function _mcpToolRequireApprovalDeserializer(item: any): _MCPToolRequireApproval;
449
+ /** model interface _MCPToolRequireApproval1 */
450
+ export interface _MCPToolRequireApproval1 {
451
+ /** A list of tools that always require approval. */
452
+ always?: {
453
+ tool_names?: string[];
454
+ };
455
+ /** A list of tools that never require approval. */
456
+ never?: {
457
+ tool_names?: string[];
458
+ };
459
+ }
460
+ export declare function _mcpToolRequireApproval1Serializer(item: _MCPToolRequireApproval1): any;
461
+ export declare function _mcpToolRequireApproval1Deserializer(item: any): _MCPToolRequireApproval1;
462
+ /** model interface _MCPToolRequireApprovalAlways */
463
+ export interface _MCPToolRequireApprovalAlways {
464
+ /** List of tools that require approval. */
465
+ tool_names?: string[];
466
+ }
467
+ export declare function _mcpToolRequireApprovalAlwaysSerializer(item: _MCPToolRequireApprovalAlways): any;
468
+ export declare function _mcpToolRequireApprovalAlwaysDeserializer(item: any): _MCPToolRequireApprovalAlways;
469
+ /** model interface _MCPToolRequireApprovalNever */
470
+ export interface _MCPToolRequireApprovalNever {
471
+ /** List of tools that do not require approval. */
472
+ tool_names?: string[];
473
+ }
474
+ export declare function _mcpToolRequireApprovalNeverSerializer(item: _MCPToolRequireApprovalNever): any;
475
+ export declare function _mcpToolRequireApprovalNeverDeserializer(item: any): _MCPToolRequireApprovalNever;
476
+ /** The input definition information for a bing grounding search tool as used to configure an agent. */
477
+ export interface BingGroundingAgentTool extends Tool {
478
+ /** The object type, which is always 'bing_grounding'. */
479
+ type: "bing_grounding";
480
+ /** The bing grounding search tool parameters. */
481
+ bing_grounding: BingGroundingSearchToolParameters;
482
+ }
483
+ export declare function bingGroundingAgentToolSerializer(item: BingGroundingAgentTool): any;
484
+ export declare function bingGroundingAgentToolDeserializer(item: any): BingGroundingAgentTool;
485
+ /** The bing grounding search tool parameters. */
486
+ export interface BingGroundingSearchToolParameters {
487
+ /**
488
+ * The search configurations attached to this tool. There can be a maximum of 1
489
+ * search configuration resource attached to the tool.
490
+ */
491
+ search_configurations: BingGroundingSearchConfiguration[];
492
+ }
493
+ export declare function bingGroundingSearchToolParametersSerializer(item: BingGroundingSearchToolParameters): any;
494
+ export declare function bingGroundingSearchToolParametersDeserializer(item: any): BingGroundingSearchToolParameters;
495
+ export declare function bingGroundingSearchConfigurationArraySerializer(result: Array<BingGroundingSearchConfiguration>): any[];
496
+ export declare function bingGroundingSearchConfigurationArrayDeserializer(result: Array<BingGroundingSearchConfiguration>): any[];
497
+ /** Search configuration for Bing Grounding */
498
+ export interface BingGroundingSearchConfiguration {
499
+ /** Project connection id for grounding with bing search */
500
+ project_connection_id: string;
501
+ /** The market where the results come from. */
502
+ market?: string;
503
+ /** The language to use for user interface strings when calling Bing API. */
504
+ set_lang?: string;
505
+ /** The number of search results to return in the bing api response */
506
+ count?: number;
507
+ /** Filter search results by a specific time range. See [accepted values here](https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters). */
508
+ freshness?: string;
509
+ }
510
+ export declare function bingGroundingSearchConfigurationSerializer(item: BingGroundingSearchConfiguration): any;
511
+ export declare function bingGroundingSearchConfigurationDeserializer(item: any): BingGroundingSearchConfiguration;
512
+ /** The input definition information for a Microsoft Fabric tool as used to configure an agent. */
513
+ export interface MicrosoftFabricAgentTool extends Tool {
514
+ /** The object type, which is always 'fabric_dataagent'. */
515
+ type: "fabric_dataagent_preview";
516
+ /** The fabric data agent tool parameters. */
517
+ fabric_dataagent_preview: FabricDataAgentToolParameters;
518
+ }
519
+ export declare function microsoftFabricAgentToolSerializer(item: MicrosoftFabricAgentTool): any;
520
+ export declare function microsoftFabricAgentToolDeserializer(item: any): MicrosoftFabricAgentTool;
521
+ /** The fabric data agent tool parameters. */
522
+ export interface FabricDataAgentToolParameters {
523
+ /**
524
+ * The project connections attached to this tool. There can be a maximum of 1 connection
525
+ * resource attached to the tool.
526
+ */
527
+ project_connections?: ToolProjectConnection[];
528
+ }
529
+ export declare function fabricDataAgentToolParametersSerializer(item: FabricDataAgentToolParameters): any;
530
+ export declare function fabricDataAgentToolParametersDeserializer(item: any): FabricDataAgentToolParameters;
531
+ export declare function toolProjectConnectionArraySerializer(result: Array<ToolProjectConnection>): any[];
532
+ export declare function toolProjectConnectionArrayDeserializer(result: Array<ToolProjectConnection>): any[];
533
+ /** A project connection resource. */
534
+ export interface ToolProjectConnection {
535
+ /** A project connection in a ToolProjectConnectionList attached to this tool. */
536
+ project_connection_id: string;
537
+ }
538
+ export declare function toolProjectConnectionSerializer(item: ToolProjectConnection): any;
539
+ export declare function toolProjectConnectionDeserializer(item: any): ToolProjectConnection;
540
+ /** The input definition information for a sharepoint tool as used to configure an agent. */
541
+ export interface SharepointAgentTool extends Tool {
542
+ /** The object type, which is always 'sharepoint_grounding'. */
543
+ type: "sharepoint_grounding_preview";
544
+ /** The sharepoint grounding tool parameters. */
545
+ sharepoint_grounding_preview: SharepointGroundingToolParameters;
546
+ }
547
+ export declare function sharepointAgentToolSerializer(item: SharepointAgentTool): any;
548
+ export declare function sharepointAgentToolDeserializer(item: any): SharepointAgentTool;
549
+ /** The sharepoint grounding tool parameters. */
550
+ export interface SharepointGroundingToolParameters {
551
+ /**
552
+ * The project connections attached to this tool. There can be a maximum of 1 connection
553
+ * resource attached to the tool.
554
+ */
555
+ project_connections?: ToolProjectConnection[];
556
+ }
557
+ export declare function sharepointGroundingToolParametersSerializer(item: SharepointGroundingToolParameters): any;
558
+ export declare function sharepointGroundingToolParametersDeserializer(item: any): SharepointGroundingToolParameters;
559
+ /** The input definition information for an Azure AI search tool as used to configure an agent. */
560
+ export interface AzureAISearchAgentTool extends Tool {
561
+ /** The object type, which is always 'azure_ai_search'. */
562
+ type: "azure_ai_search";
563
+ /** The azure ai search index resource. */
564
+ azure_ai_search: AzureAISearchToolResource;
565
+ }
566
+ export declare function azureAISearchAgentToolSerializer(item: AzureAISearchAgentTool): any;
567
+ export declare function azureAISearchAgentToolDeserializer(item: any): AzureAISearchAgentTool;
568
+ /** A set of index resources used by the `azure_ai_search` tool. */
569
+ export interface AzureAISearchToolResource {
570
+ /**
571
+ * The indices attached to this agent. There can be a maximum of 1 index
572
+ * resource attached to the agent.
573
+ */
574
+ indexes: AISearchIndexResource[];
575
+ }
576
+ export declare function azureAISearchToolResourceSerializer(item: AzureAISearchToolResource): any;
577
+ export declare function azureAISearchToolResourceDeserializer(item: any): AzureAISearchToolResource;
578
+ export declare function aiSearchIndexResourceArraySerializer(result: Array<AISearchIndexResource>): any[];
579
+ export declare function aiSearchIndexResourceArrayDeserializer(result: Array<AISearchIndexResource>): any[];
580
+ /** A AI Search Index resource. */
581
+ export interface AISearchIndexResource {
582
+ /** An index connection ID in an IndexResource attached to this agent. */
583
+ project_connection_id?: string;
584
+ /** The name of an index in an IndexResource attached to this agent. */
585
+ index_name?: string;
586
+ /** Type of query in an AIIndexResource attached to this agent. */
587
+ query_type?: AzureAISearchQueryType;
588
+ /** Number of documents to retrieve from search and present to the model. */
589
+ top_k?: number;
590
+ /** filter string for search resource. [Learn more here](https://learn.microsoft.com/azure/search/search-filters). */
591
+ filter?: string;
592
+ /** Index asset id for search resource. */
593
+ index_asset_id?: string;
594
+ }
595
+ export declare function aiSearchIndexResourceSerializer(item: AISearchIndexResource): any;
596
+ export declare function aiSearchIndexResourceDeserializer(item: any): AISearchIndexResource;
597
+ /** Available query types for Azure AI Search tool. */
598
+ export type AzureAISearchQueryType = "simple" | "semantic" | "vector" | "vector_simple_hybrid" | "vector_semantic_hybrid";
599
+ /** The input definition information for an OpenAPI tool as used to configure an agent. */
600
+ export interface OpenApiAgentTool extends Tool {
601
+ /** The object type, which is always 'openapi'. */
602
+ type: "openapi";
603
+ /** The openapi function definition. */
604
+ openapi: OpenApiFunctionDefinition;
605
+ }
606
+ export declare function openApiAgentToolSerializer(item: OpenApiAgentTool): any;
607
+ export declare function openApiAgentToolDeserializer(item: any): OpenApiAgentTool;
608
+ /** The input definition information for an openapi function. */
609
+ export interface OpenApiFunctionDefinition {
610
+ /** The name of the function to be called. */
611
+ name: string;
612
+ /** A description of what the function does, used by the model to choose when and how to call the function. */
613
+ description?: string;
614
+ /** The openapi function shape, described as a JSON Schema object. */
615
+ spec: unknown;
616
+ /** Open API authentication details */
617
+ auth: OpenApiAuthDetailsUnion;
618
+ /** List of OpenAPI spec parameters that will use user-provided defaults */
619
+ default_params?: string[];
620
+ /** List of function definitions used by OpenApi tool */
621
+ readonly functions?: {
622
+ name: string;
623
+ description?: string;
624
+ parameters: unknown;
625
+ }[];
626
+ }
627
+ export declare function openApiFunctionDefinitionSerializer(item: OpenApiFunctionDefinition): any;
628
+ export declare function openApiFunctionDefinitionDeserializer(item: any): OpenApiFunctionDefinition;
629
+ /** authentication details for OpenApiFunctionDefinition */
630
+ export interface OpenApiAuthDetails {
631
+ /** The type of authentication, must be anonymous/project_connection/managed_identity */
632
+ /** The discriminator possible values: anonymous, project_connection, managed_identity */
633
+ type: OpenApiAuthType;
634
+ }
635
+ export declare function openApiAuthDetailsSerializer(item: OpenApiAuthDetails): any;
636
+ export declare function openApiAuthDetailsDeserializer(item: any): OpenApiAuthDetails;
637
+ /** Alias for OpenApiAuthDetailsUnion */
638
+ export type OpenApiAuthDetailsUnion = OpenApiAnonymousAuthDetails | OpenApiProjectConnectionAuthDetails | OpenApiManagedAuthDetails | OpenApiAuthDetails;
639
+ export declare function openApiAuthDetailsUnionSerializer(item: OpenApiAuthDetailsUnion): any;
640
+ export declare function openApiAuthDetailsUnionDeserializer(item: any): OpenApiAuthDetailsUnion;
641
+ /**
642
+ * Authentication type for OpenApi endpoint. Allowed types are:
643
+ * - Anonymous (no authentication required)
644
+ * - Project Connection (requires project_connection_id to endpoint, as setup in Microsoft Foundry)
645
+ * - Managed_Identity (requires audience for identity based auth)
646
+ */
647
+ export type OpenApiAuthType = "anonymous" | "project_connection" | "managed_identity";
648
+ /** Security details for OpenApi anonymous authentication */
649
+ export interface OpenApiAnonymousAuthDetails extends OpenApiAuthDetails {
650
+ /** The object type, which is always 'anonymous'. */
651
+ type: "anonymous";
652
+ }
653
+ export declare function openApiAnonymousAuthDetailsSerializer(item: OpenApiAnonymousAuthDetails): any;
654
+ export declare function openApiAnonymousAuthDetailsDeserializer(item: any): OpenApiAnonymousAuthDetails;
655
+ /** Security details for OpenApi project connection authentication */
656
+ export interface OpenApiProjectConnectionAuthDetails extends OpenApiAuthDetails {
657
+ /** The object type, which is always 'project_connection'. */
658
+ type: "project_connection";
659
+ /** Project connection auth security details */
660
+ security_scheme: OpenApiProjectConnectionSecurityScheme;
661
+ }
662
+ export declare function openApiProjectConnectionAuthDetailsSerializer(item: OpenApiProjectConnectionAuthDetails): any;
663
+ export declare function openApiProjectConnectionAuthDetailsDeserializer(item: any): OpenApiProjectConnectionAuthDetails;
664
+ /** Security scheme for OpenApi managed_identity authentication */
665
+ export interface OpenApiProjectConnectionSecurityScheme {
666
+ /** Project connection id for Project Connection auth type */
667
+ project_connection_id: string;
668
+ }
669
+ export declare function openApiProjectConnectionSecuritySchemeSerializer(item: OpenApiProjectConnectionSecurityScheme): any;
670
+ export declare function openApiProjectConnectionSecuritySchemeDeserializer(item: any): OpenApiProjectConnectionSecurityScheme;
671
+ /** Security details for OpenApi managed_identity authentication */
672
+ export interface OpenApiManagedAuthDetails extends OpenApiAuthDetails {
673
+ /** The object type, which is always 'managed_identity'. */
674
+ type: "managed_identity";
675
+ /** Connection auth security details */
676
+ security_scheme: OpenApiManagedSecurityScheme;
677
+ }
678
+ export declare function openApiManagedAuthDetailsSerializer(item: OpenApiManagedAuthDetails): any;
679
+ export declare function openApiManagedAuthDetailsDeserializer(item: any): OpenApiManagedAuthDetails;
680
+ /** Security scheme for OpenApi managed_identity authentication */
681
+ export interface OpenApiManagedSecurityScheme {
682
+ /** Authentication scope for managed_identity auth type */
683
+ audience: string;
684
+ }
685
+ export declare function openApiManagedSecuritySchemeSerializer(item: OpenApiManagedSecurityScheme): any;
686
+ export declare function openApiManagedSecuritySchemeDeserializer(item: any): OpenApiManagedSecurityScheme;
687
+ export declare function _openApiFunctionDefinitionFunctionArrayDeserializer(result: Array<_OpenApiFunctionDefinitionFunction>): any[];
688
+ /** model interface _OpenApiFunctionDefinitionFunction */
689
+ export interface _OpenApiFunctionDefinitionFunction {
690
+ /** The name of the function to be called. */
691
+ name: string;
692
+ /** A description of what the function does, used by the model to choose when and how to call the function. */
693
+ description?: string;
694
+ /** The parameters the functions accepts, described as a JSON Schema object. */
695
+ parameters: unknown;
696
+ }
697
+ export declare function _openApiFunctionDefinitionFunctionDeserializer(item: any): _OpenApiFunctionDefinitionFunction;
698
+ /** The input definition information for a Bing custom search tool as used to configure an agent. */
699
+ export interface BingCustomSearchAgentTool extends Tool {
700
+ /** The object type, which is always 'bing_custom_search'. */
701
+ type: "bing_custom_search_preview";
702
+ /** The bing custom search tool parameters. */
703
+ bing_custom_search_preview: BingCustomSearchToolParameters;
704
+ }
705
+ export declare function bingCustomSearchAgentToolSerializer(item: BingCustomSearchAgentTool): any;
706
+ export declare function bingCustomSearchAgentToolDeserializer(item: any): BingCustomSearchAgentTool;
707
+ /** The bing custom search tool parameters. */
708
+ export interface BingCustomSearchToolParameters {
709
+ /**
710
+ * The project connections attached to this tool. There can be a maximum of 1 connection
711
+ * resource attached to the tool.
712
+ */
713
+ search_configurations: BingCustomSearchConfiguration[];
714
+ }
715
+ export declare function bingCustomSearchToolParametersSerializer(item: BingCustomSearchToolParameters): any;
716
+ export declare function bingCustomSearchToolParametersDeserializer(item: any): BingCustomSearchToolParameters;
717
+ export declare function bingCustomSearchConfigurationArraySerializer(result: Array<BingCustomSearchConfiguration>): any[];
718
+ export declare function bingCustomSearchConfigurationArrayDeserializer(result: Array<BingCustomSearchConfiguration>): any[];
719
+ /** A bing custom search configuration. */
720
+ export interface BingCustomSearchConfiguration {
721
+ /** Project connection id for grounding with bing search */
722
+ project_connection_id: string;
723
+ /** Name of the custom configuration instance given to config. */
724
+ instance_name: string;
725
+ /** The market where the results come from. */
726
+ market?: string;
727
+ /** The language to use for user interface strings when calling Bing API. */
728
+ set_lang?: string;
729
+ /** The number of search results to return in the bing api response */
730
+ count?: number;
731
+ /** Filter search results by a specific time range. See [accepted values here](https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters). */
732
+ freshness?: string;
733
+ }
734
+ export declare function bingCustomSearchConfigurationSerializer(item: BingCustomSearchConfiguration): any;
735
+ export declare function bingCustomSearchConfigurationDeserializer(item: any): BingCustomSearchConfiguration;
736
+ /** The input definition information for a Browser Automation Tool, as used to configure an Agent. */
737
+ export interface BrowserAutomationAgentTool extends Tool {
738
+ /** The object type, which is always 'browser_automation'. */
739
+ type: "browser_automation_preview";
740
+ /** The Browser Automation Tool parameters. */
741
+ browser_automation_preview: BrowserAutomationToolParameters;
742
+ }
743
+ export declare function browserAutomationAgentToolSerializer(item: BrowserAutomationAgentTool): any;
744
+ export declare function browserAutomationAgentToolDeserializer(item: any): BrowserAutomationAgentTool;
745
+ /** Definition of input parameters for the Browser Automation Tool. */
746
+ export interface BrowserAutomationToolParameters {
747
+ /** The project connection parameters associated with the Browser Automation Tool. */
748
+ connection: BrowserAutomationToolConnectionParameters;
749
+ }
750
+ export declare function browserAutomationToolParametersSerializer(item: BrowserAutomationToolParameters): any;
751
+ export declare function browserAutomationToolParametersDeserializer(item: any): BrowserAutomationToolParameters;
752
+ /** Definition of input parameters for the connection used by the Browser Automation Tool. */
753
+ export interface BrowserAutomationToolConnectionParameters {
754
+ /** The ID of the project connection to your Azure Playwright resource. */
755
+ project_connection_id: string;
756
+ }
757
+ export declare function browserAutomationToolConnectionParametersSerializer(item: BrowserAutomationToolConnectionParameters): any;
758
+ export declare function browserAutomationToolConnectionParametersDeserializer(item: any): BrowserAutomationToolConnectionParameters;
759
+ /** The input definition information for an Azure Function Tool, as used to configure an Agent. */
760
+ export interface AzureFunctionAgentTool extends Tool {
761
+ /** The object type, which is always 'browser_automation'. */
762
+ type: "azure_function";
763
+ /** The Azure Function Tool definition. */
764
+ azure_function: AzureFunctionDefinition;
765
+ }
766
+ export declare function azureFunctionAgentToolSerializer(item: AzureFunctionAgentTool): any;
767
+ export declare function azureFunctionAgentToolDeserializer(item: any): AzureFunctionAgentTool;
768
+ /** The definition of Azure function. */
769
+ export interface AzureFunctionDefinition {
770
+ /** The definition of azure function and its parameters. */
771
+ function: {
772
+ name: string;
773
+ description?: string;
774
+ parameters: unknown;
775
+ };
776
+ /** Input storage queue. The queue storage trigger runs a function as messages are added to it. */
777
+ input_binding: AzureFunctionBinding;
778
+ /** Output storage queue. The function writes output to this queue when the input items are processed. */
779
+ output_binding: AzureFunctionBinding;
780
+ }
781
+ export declare function azureFunctionDefinitionSerializer(item: AzureFunctionDefinition): any;
782
+ export declare function azureFunctionDefinitionDeserializer(item: any): AzureFunctionDefinition;
783
+ /** model interface _AzureFunctionDefinitionFunction */
784
+ export interface _AzureFunctionDefinitionFunction {
785
+ /** The name of the function to be called. */
786
+ name: string;
787
+ /** A description of what the function does, used by the model to choose when and how to call the function. */
788
+ description?: string;
789
+ /** The parameters the functions accepts, described as a JSON Schema object. */
790
+ parameters: unknown;
791
+ }
792
+ export declare function _azureFunctionDefinitionFunctionSerializer(item: _AzureFunctionDefinitionFunction): any;
793
+ export declare function _azureFunctionDefinitionFunctionDeserializer(item: any): _AzureFunctionDefinitionFunction;
794
+ /** The structure for keeping storage queue name and URI. */
795
+ export interface AzureFunctionBinding {
796
+ /** The type of binding, which is always 'storage_queue'. */
797
+ type: "storage_queue";
798
+ /** Storage queue. */
799
+ storage_queue: AzureFunctionStorageQueue;
800
+ }
801
+ export declare function azureFunctionBindingSerializer(item: AzureFunctionBinding): any;
802
+ export declare function azureFunctionBindingDeserializer(item: any): AzureFunctionBinding;
803
+ /** The structure for keeping storage queue name and URI. */
804
+ export interface AzureFunctionStorageQueue {
805
+ /** URI to the Azure Storage Queue service allowing you to manipulate a queue. */
806
+ queue_service_endpoint: string;
807
+ /** The name of an Azure function storage queue. */
808
+ queue_name: string;
809
+ }
810
+ export declare function azureFunctionStorageQueueSerializer(item: AzureFunctionStorageQueue): any;
811
+ export declare function azureFunctionStorageQueueDeserializer(item: any): AzureFunctionStorageQueue;
812
+ /** A tool for capturing structured outputs */
813
+ export interface CaptureStructuredOutputsTool extends Tool {
814
+ /** The type of the tool. Always `capture_structured_outputs`. */
815
+ type: "capture_structured_outputs";
816
+ /** The structured outputs to capture from the model. */
817
+ outputs: StructuredOutputDefinition;
818
+ }
819
+ export declare function captureStructuredOutputsToolSerializer(item: CaptureStructuredOutputsTool): any;
820
+ export declare function captureStructuredOutputsToolDeserializer(item: any): CaptureStructuredOutputsTool;
821
+ /**
822
+ * A structured output definition for agents.
823
+ * Defines a named output schema that the agent can produce.
824
+ */
825
+ export interface StructuredOutputDefinition {
826
+ /** The name of the structured output. */
827
+ name: string;
828
+ /** A description of the output to emit. Used by the model to determine when to emit the output. */
829
+ description: string;
830
+ /** The JSON schema for the structured output. */
831
+ schema: Record<string, any>;
832
+ /** Whether to enforce strict validation. Default `true`. */
833
+ strict: boolean;
834
+ }
835
+ export declare function structuredOutputDefinitionSerializer(item: StructuredOutputDefinition): any;
836
+ export declare function structuredOutputDefinitionDeserializer(item: any): StructuredOutputDefinition;
837
+ /** An agent implementing the A2A protocol. */
838
+ export interface A2ATool extends Tool {
839
+ /** The type of the tool. Always `a2a`. */
840
+ type: "a2a_preview";
841
+ /** Base URL of the agent. */
842
+ base_url?: string;
843
+ /**
844
+ * The path to the agent card relative to the `base_url`.
845
+ * If not provided, defaults to `/.well-known/agent-card.json`
846
+ */
847
+ agent_card_path?: string;
848
+ /**
849
+ * The connection ID in the project for the A2A server.
850
+ * The connection stores authentication and other connection details needed to connect to the A2A server.
851
+ */
852
+ project_connection_id?: string;
853
+ }
854
+ export declare function a2AToolSerializer(item: A2ATool): any;
855
+ export declare function a2AToolDeserializer(item: any): A2ATool;
856
+ /** A tool for integrating memories into the agent. */
857
+ export interface MemorySearchTool extends Tool {
858
+ /** The type of the tool. Always `memory_search`. */
859
+ type: "memory_search";
860
+ /** The name of the memory store to use. */
861
+ memory_store_name: string;
862
+ /**
863
+ * The namespace used to group and isolate memories, such as a user ID.
864
+ * Limits which memories can be retrieved or updated.
865
+ * Use special variable `{{$userId}}` to scope memories to the current signed-in user.
866
+ */
867
+ scope: string;
868
+ /** Options for searching the memory store. */
869
+ search_options?: MemorySearchOptions;
870
+ /** Time to wait before updating memories after inactivity (seconds). Default 300. */
871
+ update_delay?: number;
872
+ }
873
+ export declare function memorySearchToolSerializer(item: MemorySearchTool): any;
874
+ export declare function memorySearchToolDeserializer(item: any): MemorySearchTool;
875
+ /** Memory search options. */
876
+ export interface MemorySearchOptions {
877
+ /** Maximum number of memory items to return. */
878
+ max_memories?: number;
879
+ }
880
+ export declare function memorySearchOptionsSerializer(item: MemorySearchOptions): any;
881
+ export declare function memorySearchOptionsDeserializer(item: any): MemorySearchOptions;
882
+ export declare function protocolVersionRecordArraySerializer(result: Array<ProtocolVersionRecord>): any[];
883
+ export declare function protocolVersionRecordArrayDeserializer(result: Array<ProtocolVersionRecord>): any[];
884
+ /** A record mapping for a single protocol and its version. */
885
+ export interface ProtocolVersionRecord {
886
+ /** The protocol type. */
887
+ protocol: AgentProtocol;
888
+ /** The version string for the protocol, e.g. 'v0.1.1'. */
889
+ version: string;
890
+ }
891
+ export declare function protocolVersionRecordSerializer(item: ProtocolVersionRecord): any;
892
+ export declare function protocolVersionRecordDeserializer(item: any): ProtocolVersionRecord;
893
+ /** Type of AgentProtocol */
894
+ export type AgentProtocol = "activity_protocol" | "responses";
895
+ /** The image-based deployment definition for a hosted agent. */
896
+ export interface ImageBasedHostedAgentDefinition extends HostedAgentDefinition {
897
+ kind: "hosted";
898
+ /** The image for the hosted agent. */
899
+ image: string;
900
+ }
901
+ export declare function imageBasedHostedAgentDefinitionSerializer(item: ImageBasedHostedAgentDefinition): any;
902
+ export declare function imageBasedHostedAgentDefinitionDeserializer(item: any): ImageBasedHostedAgentDefinition;
903
+ /** The container app agent definition. */
904
+ export interface ContainerAppAgentDefinition extends AgentDefinition {
905
+ kind: "container_app";
906
+ /** The protocols that the agent supports for ingress communication of the containers. */
907
+ container_protocol_versions: ProtocolVersionRecord[];
908
+ /** The resource ID of the Azure Container App that hosts this agent. Not mutable across versions. */
909
+ container_app_resource_id: string;
910
+ /** The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app. */
911
+ ingress_subdomain_suffix: string;
912
+ }
913
+ export declare function containerAppAgentDefinitionSerializer(item: ContainerAppAgentDefinition): any;
914
+ export declare function containerAppAgentDefinitionDeserializer(item: any): ContainerAppAgentDefinition;
915
+ /**
916
+ * Prompt-based agent definition.
917
+ * Defines an agent that uses a language model with custom instructions and tools.
918
+ */
919
+ export interface PromptAgentDefinition extends AgentDefinition {
920
+ kind: "prompt";
921
+ /** The model deployment to use for this agent. */
922
+ model: string;
923
+ /** A system (or developer) message inserted into the model's context. */
924
+ instructions?: string;
925
+ /**
926
+ * 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.
927
+ * We generally recommend altering this or `top_p` but not both.
928
+ */
929
+ temperature?: number;
930
+ /**
931
+ * An alternative to sampling with temperature, called nucleus sampling,
932
+ * where the model considers the results of the tokens with top_p probability
933
+ * mass. So 0.1 means only the tokens comprising the top 10% probability mass
934
+ * are considered.
935
+ *
936
+ * We generally recommend altering this or `temperature` but not both.
937
+ */
938
+ top_p?: number;
939
+ reasoning?: Reasoning;
940
+ /**
941
+ * An array of tools the model may call while generating a response. You
942
+ * can specify which tool to use by setting the `tool_choice` parameter.
943
+ */
944
+ tools?: ToolUnion[];
945
+ /** Configuration options for a text response from the model. Can be plain text or structured JSON data. */
946
+ text?: {
947
+ format?: ResponseTextFormatConfigurationUnion;
948
+ };
949
+ /** Set of structured inputs that can participate in prompt template substitution or tool argument bindings. */
950
+ structured_inputs?: Record<string, StructuredInputDefinition>;
951
+ }
952
+ export declare function promptAgentDefinitionSerializer(item: PromptAgentDefinition): any;
953
+ export declare function promptAgentDefinitionDeserializer(item: any): PromptAgentDefinition;
954
+ /**
955
+ * **o-series models only**
956
+ *
957
+ * Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
958
+ */
959
+ export interface Reasoning {
960
+ effort?: ReasoningEffort;
961
+ /**
962
+ * A summary of the reasoning performed by the model. This can be
963
+ * useful for debugging and understanding the model's reasoning process.
964
+ * One of `auto`, `concise`, or `detailed`.
965
+ */
966
+ summary?: "auto" | "concise" | "detailed";
967
+ /** **Deprecated**: use `summary` instead. A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`. */
968
+ generate_summary?: "auto" | "concise" | "detailed";
969
+ }
970
+ export declare function reasoningSerializer(item: Reasoning): any;
971
+ export declare function reasoningDeserializer(item: any): Reasoning;
972
+ /**
973
+ * **o-series models only**
974
+ *
975
+ * Constrains effort on reasoning for
976
+ * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
977
+ * Currently supported values are `low`, `medium`, and `high`. Reducing
978
+ * reasoning effort can result in faster responses and fewer tokens used
979
+ * on reasoning in a response.
980
+ */
981
+ export type ReasoningEffort = "low" | "medium" | "high";
982
+ /** model interface _PromptAgentDefinitionText */
983
+ export interface _PromptAgentDefinitionText {
984
+ format?: ResponseTextFormatConfigurationUnion;
985
+ }
986
+ export declare function _promptAgentDefinitionTextSerializer(item: _PromptAgentDefinitionText): any;
987
+ export declare function _promptAgentDefinitionTextDeserializer(item: any): _PromptAgentDefinitionText;
988
+ /** model interface ResponseTextFormatConfiguration */
989
+ export interface ResponseTextFormatConfiguration {
990
+ type: ResponseTextFormatConfigurationType;
991
+ }
992
+ export declare function responseTextFormatConfigurationSerializer(item: ResponseTextFormatConfiguration): any;
993
+ export declare function responseTextFormatConfigurationDeserializer(item: any): ResponseTextFormatConfiguration;
994
+ /** Alias for ResponseTextFormatConfigurationUnion */
995
+ export type ResponseTextFormatConfigurationUnion = ResponseTextFormatConfigurationText | ResponseTextFormatConfigurationJson | ResponseTextFormatConfigurationJsonSchema | ResponseTextFormatConfiguration;
996
+ export declare function responseTextFormatConfigurationUnionSerializer(item: ResponseTextFormatConfigurationUnion): any;
997
+ export declare function responseTextFormatConfigurationUnionDeserializer(item: any): ResponseTextFormatConfigurationUnion;
998
+ /**
999
+ * An object specifying the format that the model must output.
1000
+ *
1001
+ * Configuring `{ "type": "json_schema" }` enables Structured Outputs,
1002
+ * which ensures the model will match your supplied JSON schema. Learn more in the
1003
+ * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
1004
+ *
1005
+ * The default format is `{ "type": "text" }` with no additional options.
1006
+ *
1007
+ * **Not recommended for gpt-4o and newer models:**
1008
+ *
1009
+ * Setting to `{ "type": "json_object" }` enables the older JSON mode, which
1010
+ * ensures the message the model generates is valid JSON. Using `json_schema`
1011
+ * is preferred for models that support it.
1012
+ */
1013
+ export type ResponseTextFormatConfigurationType = "text" | "json_schema" | "json_object";
1014
+ /** model interface ResponseTextFormatConfigurationText */
1015
+ export interface ResponseTextFormatConfigurationText extends ResponseTextFormatConfiguration {
1016
+ type: "text";
1017
+ }
1018
+ export declare function responseTextFormatConfigurationTextSerializer(item: ResponseTextFormatConfigurationText): any;
1019
+ export declare function responseTextFormatConfigurationTextDeserializer(item: any): ResponseTextFormatConfigurationText;
1020
+ /** model interface ResponseTextFormatConfigurationJson */
1021
+ export interface ResponseTextFormatConfigurationJson extends ResponseTextFormatConfiguration {
1022
+ type: "json_object";
1023
+ }
1024
+ export declare function responseTextFormatConfigurationJsonObjectSerializer(item: ResponseTextFormatConfigurationJson): any;
1025
+ export declare function responseTextFormatConfigurationJsonObjectDeserializer(item: any): ResponseTextFormatConfigurationJson;
1026
+ /**
1027
+ * JSON Schema response format. Used to generate structured JSON responses.
1028
+ * Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
1029
+ */
1030
+ export interface ResponseTextFormatConfigurationJsonSchema extends ResponseTextFormatConfiguration {
1031
+ /** The type of response format being defined. Always `json_schema`. */
1032
+ type: "json_schema";
1033
+ /**
1034
+ * A description of what the response format is for, used by the model to
1035
+ * determine how to respond in the format.
1036
+ */
1037
+ description?: string;
1038
+ /**
1039
+ * The name of the response format. Must be a-z, A-Z, 0-9, or contain
1040
+ * underscores and dashes, with a maximum length of 64.
1041
+ */
1042
+ name: string;
1043
+ schema: ResponseFormatJsonSchemaSchema;
1044
+ /**
1045
+ * Whether to enable strict schema adherence when generating the output.
1046
+ * If set to true, the model will always follow the exact schema defined
1047
+ * in the `schema` field. Only a subset of JSON Schema is supported when
1048
+ * `strict` is `true`. To learn more, read the [Structured Outputs
1049
+ * guide](https://platform.openai.com/docs/guides/structured-outputs).
1050
+ */
1051
+ strict?: boolean;
1052
+ }
1053
+ /**
1054
+ * The schema for the response format, described as a JSON Schema object.
1055
+ * Learn how to build JSON schemas [here](https://json-schema.org/).
1056
+ */
1057
+ export interface ResponseFormatJsonSchemaSchema {
1058
+ /** Additional properties */
1059
+ additionalProperties?: Record<string, any>;
1060
+ }
1061
+ export declare function responseFormatJsonSchemaSchemaSerializer(item: ResponseFormatJsonSchemaSchema): any;
1062
+ export declare function responseFormatJsonSchemaSchemaDeserializer(item: any): ResponseFormatJsonSchemaSchema;
1063
+ export declare function responseTextFormatConfigurationJsonSchemaSerializer(item: ResponseTextFormatConfigurationJsonSchema): any;
1064
+ export declare function responseTextFormatConfigurationJsonSchemaDeserializer(item: any): ResponseTextFormatConfigurationJsonSchema;
1065
+ export declare function structuredInputDefinitionRecordSerializer(item: Record<string, StructuredInputDefinition>): Record<string, any>;
1066
+ export declare function structuredInputDefinitionRecordDeserializer(item: Record<string, any>): Record<string, StructuredInputDefinition>;
1067
+ /** An structured input that can participate in prompt template substitutions and tool argument binding. */
1068
+ export interface StructuredInputDefinition {
1069
+ /** A human-readable description of the input. */
1070
+ description?: string;
1071
+ /** The default value for the input if no run-time value is provided. */
1072
+ default_value?: unknown;
1073
+ /** When provided, the input value is bound to the specified tool arguments. */
1074
+ tool_argument_bindings?: ToolArgumentBinding[];
1075
+ /** The JSON schema for the structured input (optional). */
1076
+ schema?: unknown;
1077
+ /** Whether the input property is required when the agent is invoked. */
1078
+ required?: boolean;
1079
+ }
1080
+ export declare function structuredInputDefinitionSerializer(item: StructuredInputDefinition): any;
1081
+ export declare function structuredInputDefinitionDeserializer(item: any): StructuredInputDefinition;
1082
+ export declare function toolArgumentBindingArraySerializer(result: Array<ToolArgumentBinding>): any[];
1083
+ export declare function toolArgumentBindingArrayDeserializer(result: Array<ToolArgumentBinding>): any[];
1084
+ /** model interface ToolArgumentBinding */
1085
+ export interface ToolArgumentBinding {
1086
+ /** The name of the tool to participate in the argument binding. If not provided, then all tools with matching arguments will participate in binding. */
1087
+ tool_name?: string;
1088
+ /** The name of the argument within the tool. */
1089
+ argument_name: string;
1090
+ }
1091
+ export declare function toolArgumentBindingSerializer(item: ToolArgumentBinding): any;
1092
+ export declare function toolArgumentBindingDeserializer(item: any): ToolArgumentBinding;
1093
+ /** Error response for API failures. */
1094
+ export interface ApiErrorResponse {
1095
+ error: ApiError;
1096
+ }
1097
+ export declare function apiErrorResponseDeserializer(item: any): ApiErrorResponse;
1098
+ /** model interface ApiError */
1099
+ export interface ApiError {
1100
+ /** The error code. */
1101
+ code: string;
1102
+ /** A human-readable description of the error. */
1103
+ message: string;
1104
+ /** The target of the error, if applicable. */
1105
+ target?: string;
1106
+ /** Additional details about the error. */
1107
+ details: ApiError[];
1108
+ /** The inner error, if any. */
1109
+ innererror?: ApiInnerError;
1110
+ }
1111
+ export declare function apiErrorDeserializer(item: any): ApiError;
1112
+ export declare function apiErrorArrayDeserializer(result: Array<ApiError>): any[];
1113
+ /** model interface ApiInnerError */
1114
+ export interface ApiInnerError {
1115
+ /** The error code. */
1116
+ code: string;
1117
+ /** The inner error, if any. */
1118
+ innererror?: ApiInnerError;
1119
+ }
1120
+ export declare function apiInnerErrorDeserializer(item: any): ApiInnerError;
1121
+ /** A deleted agent Object */
1122
+ export interface DeleteAgentResponse {
1123
+ /** The object type. Always 'agent.deleted'. */
1124
+ object: "agent.deleted";
1125
+ /** The name of the agent. */
1126
+ name: string;
1127
+ /** Whether the agent was successfully deleted. */
1128
+ deleted: boolean;
1129
+ }
1130
+ export declare function deleteAgentResponseDeserializer(item: any): DeleteAgentResponse;
1131
+ /** The response data for a requested list of items. */
1132
+ export interface _AgentsPagedResultAgentObject {
1133
+ /** The requested list of items. */
1134
+ data: Agent[];
1135
+ /** The first ID represented in this list. */
1136
+ first_id?: string;
1137
+ /** The last ID represented in this list. */
1138
+ last_id?: string;
1139
+ /** A value indicating whether there are additional values available not captured in this list. */
1140
+ has_more: boolean;
1141
+ }
1142
+ export declare function _agentsPagedResultAgentObjectDeserializer(item: any): _AgentsPagedResultAgentObject;
1143
+ export declare function agentObjectArrayDeserializer(result: Array<Agent>): any[];
1144
+ /** A deleted agent version Object */
1145
+ export interface DeleteAgentVersionResponse {
1146
+ /** The object type. Always 'agent.deleted'. */
1147
+ object: "agent.version.deleted";
1148
+ /** The name of the agent. */
1149
+ name: string;
1150
+ /** The version identifier of the agent. */
1151
+ version: string;
1152
+ /** Whether the agent was successfully deleted. */
1153
+ deleted: boolean;
1154
+ }
1155
+ export declare function deleteAgentVersionResponseDeserializer(item: any): DeleteAgentVersionResponse;
1156
+ /** The response data for a requested list of items. */
1157
+ export interface _AgentsPagedResultAgentVersionObject {
1158
+ /** The requested list of items. */
1159
+ data: AgentVersion[];
1160
+ /** The first ID represented in this list. */
1161
+ first_id?: string;
1162
+ /** The last ID represented in this list. */
1163
+ last_id?: string;
1164
+ /** A value indicating whether there are additional values available not captured in this list. */
1165
+ has_more: boolean;
1166
+ }
1167
+ export declare function _agentsPagedResultAgentVersionObjectDeserializer(item: any): _AgentsPagedResultAgentVersionObject;
1168
+ export declare function agentVersionObjectArrayDeserializer(result: Array<AgentVersion>): any[];
1169
+ /** Base definition for memory store configurations. */
1170
+ export interface MemoryStoreDefinition {
1171
+ /** The kind of the memory store. */
1172
+ /** The discriminator possible values: default */
1173
+ kind: MemoryStoreKind;
1174
+ }
1175
+ export declare function memoryStoreDefinitionSerializer(item: MemoryStoreDefinition): any;
1176
+ export declare function memoryStoreDefinitionDeserializer(item: any): MemoryStoreDefinition;
1177
+ /** Alias for MemoryStoreDefinitionUnion */
1178
+ export type MemoryStoreDefinitionUnion = MemoryStoreDefaultDefinition | MemoryStoreDefinition;
1179
+ export declare function memoryStoreDefinitionUnionSerializer(item: MemoryStoreDefinitionUnion): any;
1180
+ export declare function memoryStoreDefinitionUnionDeserializer(item: any): MemoryStoreDefinitionUnion;
1181
+ /** The type of memory store implementation to use. */
1182
+ export type MemoryStoreKind = "default";
1183
+ /** Default memory store implementation. */
1184
+ export interface MemoryStoreDefaultDefinition extends MemoryStoreDefinition {
1185
+ /** The kind of the memory store. */
1186
+ kind: "default";
1187
+ /** The name or identifier of the chat completion model deployment used for memory processing. */
1188
+ chat_model: string;
1189
+ /** The name or identifier of the embedding model deployment used for memory processing. */
1190
+ embedding_model: string;
1191
+ /** Default memory store options. */
1192
+ options?: MemoryStoreDefaultOptions;
1193
+ }
1194
+ export declare function memoryStoreDefaultDefinitionSerializer(item: MemoryStoreDefaultDefinition): any;
1195
+ export declare function memoryStoreDefaultDefinitionDeserializer(item: any): MemoryStoreDefaultDefinition;
1196
+ /** Default memory store configurations. */
1197
+ export interface MemoryStoreDefaultOptions {
1198
+ /** Whether to enable user profile extraction and storage. Default is true. */
1199
+ user_profile_enabled: boolean;
1200
+ /** Specific categories or types of user profile information to extract and store. */
1201
+ user_profile_details?: string;
1202
+ /** Whether to enable chat summary extraction and storage. Default is true. */
1203
+ chat_summary_enabled: boolean;
1204
+ }
1205
+ export declare function memoryStoreDefaultOptionsSerializer(item: MemoryStoreDefaultOptions): any;
1206
+ export declare function memoryStoreDefaultOptionsDeserializer(item: any): MemoryStoreDefaultOptions;
1207
+ /** A memory store that can store and retrieve user memories. */
1208
+ export interface MemoryStore {
1209
+ /** The object type, which is always 'memory_store'. */
1210
+ object: "memory_store";
1211
+ /** The unique identifier of the memory store. */
1212
+ id: string;
1213
+ /** The Unix timestamp (seconds) when the memory store was created. */
1214
+ created_at: Date;
1215
+ /** The Unix timestamp (seconds) when the memory store was last updated. */
1216
+ updated_at: Date;
1217
+ /** The name of the memory store. */
1218
+ name: string;
1219
+ /** A human-readable description of the memory store. */
1220
+ description?: string;
1221
+ /** Arbitrary key-value metadata to associate with the memory store. */
1222
+ metadata?: Record<string, string>;
1223
+ /** The definition of the memory store. */
1224
+ definition: MemoryStoreDefinitionUnion;
1225
+ }
1226
+ export declare function memoryStoreObjectDeserializer(item: any): MemoryStore;
1227
+ /** The response data for a requested list of items. */
1228
+ export interface _AgentsPagedResultMemoryStore {
1229
+ /** The requested list of items. */
1230
+ data: MemoryStore[];
1231
+ /** The first ID represented in this list. */
1232
+ first_id?: string;
1233
+ /** The last ID represented in this list. */
1234
+ last_id?: string;
1235
+ /** A value indicating whether there are additional values available not captured in this list. */
1236
+ has_more: boolean;
1237
+ }
1238
+ export declare function _agentsPagedResultMemoryStoreObjectDeserializer(item: any): _AgentsPagedResultMemoryStore;
1239
+ export declare function memoryStoreObjectArrayDeserializer(result: Array<MemoryStore>): any[];
1240
+ /** model interface DeleteMemoryStoreResponse */
1241
+ export interface DeleteMemoryStoreResponse {
1242
+ /** The object type. Always 'memory_store.deleted'. */
1243
+ object: "memory_store.deleted";
1244
+ /** The name of the memory store. */
1245
+ name: string;
1246
+ /** Whether the memory store was successfully deleted. */
1247
+ deleted: boolean;
1248
+ }
1249
+ export declare function deleteMemoryStoreResponseDeserializer(item: any): DeleteMemoryStoreResponse;
1250
+ /** Content item used to generate a response. */
1251
+ export interface ItemParam {
1252
+ type: ItemType;
1253
+ }
1254
+ export declare function itemParamSerializer(item: ItemParam): any;
1255
+ /** Alias for ItemParamUnion */
1256
+ export type ItemParamUnion = ResponsesMessageItemParamUnion | FunctionToolCallOutputItemParam | FileSearchToolCallItemParam | ComputerToolCallItemParam | ComputerToolCallOutputItemParam | WebSearchToolCallItemParam | FunctionToolCallItemParam | ReasoningItemParam | ItemReferenceItemParam | ImageGenToolCallItemParam | CodeInterpreterToolCallItemParam | LocalShellToolCallItemParam | LocalShellToolCallOutputItemParam | MCPListToolsItemParam | MCPApprovalRequestItemParam | MCPApprovalResponseItemParam | MCPCallItemParam | MemorySearchToolCallItemParam | ItemParam;
1257
+ export declare function itemParamUnionSerializer(item: ItemParamUnion): any;
1258
+ /** Type of ItemType */
1259
+ export type ItemType = "message" | "file_search_call" | "function_call" | "function_call_output" | "computer_call" | "computer_call_output" | "web_search_call" | "reasoning" | "item_reference" | "image_generation_call" | "code_interpreter_call" | "local_shell_call" | "local_shell_call_output" | "mcp_list_tools" | "mcp_approval_request" | "mcp_approval_response" | "mcp_call" | "structured_outputs" | "workflow_action" | "memory_search_call" | "oauth_consent_request";
1260
+ /** A response message item, representing a role and content, as provided as client request parameters. */
1261
+ export interface ResponsesMessageItemParam extends ItemParam {
1262
+ /** The type of the responses item, which is always 'message'. */
1263
+ type: "message";
1264
+ /** The role associated with the message. */
1265
+ /** The discriminator possible values: user, system, developer, assistant */
1266
+ role: ResponsesMessageRole;
1267
+ }
1268
+ export declare function responsesMessageItemParamSerializer(item: ResponsesMessageItemParam): any;
1269
+ /** Alias for ResponsesMessageItemParamUnion */
1270
+ export type ResponsesMessageItemParamUnion = ResponsesUserMessageItemParam | ResponsesSystemMessageItemParam | ResponsesDeveloperMessageItemParam | ResponsesAssistantMessageItemParam | ResponsesMessageItemParam;
1271
+ export declare function responsesMessageItemParamUnionSerializer(item: ResponsesMessageItemParamUnion): any;
1272
+ /** The collection of valid roles for responses message items. */
1273
+ export type ResponsesMessageRole = "system" | "developer" | "user" | "assistant";
1274
+ /** A message parameter item with the `user` role. */
1275
+ export interface ResponsesUserMessageItemParam extends ResponsesMessageItemParam {
1276
+ /** The role of the message, which is always `user`. */
1277
+ role: "user";
1278
+ /** The content associated with the message. */
1279
+ content: string | ItemContentUnion[];
1280
+ }
1281
+ export declare function responsesUserMessageItemParamSerializer(item: ResponsesUserMessageItemParam): any;
1282
+ /** Alias for _ResponsesUserMessageItemParamContent */
1283
+ export type _ResponsesUserMessageItemParamContent = string | ItemContentUnion[];
1284
+ export declare function _responsesUserMessageItemParamContentSerializer(item: _ResponsesUserMessageItemParamContent): any;
1285
+ export declare function itemContentUnionArraySerializer(result: Array<ItemContentUnion>): any[];
1286
+ /** model interface ItemContent */
1287
+ export interface ItemContent {
1288
+ type: ItemContentType;
1289
+ }
1290
+ export declare function itemContentSerializer(item: ItemContent): any;
1291
+ /** Alias for ItemContentUnion */
1292
+ export type ItemContentUnion = ItemContentInputAudio | ItemContentOutputAudio | ItemContentRefusal | ItemContentInputText | ItemContentInputImage | ItemContentInputFile | ItemContentOutputText | ItemContent;
1293
+ export declare function itemContentUnionSerializer(item: ItemContentUnion): any;
1294
+ /** Multi-modal input and output contents. */
1295
+ export type ItemContentType = "input_text" | "input_audio" | "input_image" | "input_file" | "output_text" | "output_audio" | "refusal";
1296
+ /** An audio input to the model. */
1297
+ export interface ItemContentInputAudio extends ItemContent {
1298
+ /** The type of the input item. Always `input_audio`. */
1299
+ type: "input_audio";
1300
+ /** Base64-encoded audio data. */
1301
+ data: string;
1302
+ /**
1303
+ * The format of the audio data. Currently supported formats are `mp3` and
1304
+ * `wav`.
1305
+ */
1306
+ format: "mp3" | "wav";
1307
+ }
1308
+ export declare function itemContentInputAudioSerializer(item: ItemContentInputAudio): any;
1309
+ /** An audio output from the model. */
1310
+ export interface ItemContentOutputAudio extends ItemContent {
1311
+ /** The type of the output audio. Always `output_audio`. */
1312
+ type: "output_audio";
1313
+ /** Base64-encoded audio data from the model. */
1314
+ data: string;
1315
+ /** The transcript of the audio data from the model. */
1316
+ transcript: string;
1317
+ }
1318
+ export declare function itemContentOutputAudioSerializer(item: ItemContentOutputAudio): any;
1319
+ /** A refusal from the model. */
1320
+ export interface ItemContentRefusal extends ItemContent {
1321
+ /** The type of the refusal. Always `refusal`. */
1322
+ type: "refusal";
1323
+ /** The refusal explanationfrom the model. */
1324
+ refusal: string;
1325
+ }
1326
+ export declare function itemContentRefusalSerializer(item: ItemContentRefusal): any;
1327
+ /** A text input to the model. */
1328
+ export interface ItemContentInputText extends ItemContent {
1329
+ /** The type of the input item. Always `input_text`. */
1330
+ type: "input_text";
1331
+ /** The text input to the model. */
1332
+ text: string;
1333
+ }
1334
+ export declare function itemContentInputTextSerializer(item: ItemContentInputText): any;
1335
+ /**
1336
+ * Image input content for messages.
1337
+ * Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
1338
+ */
1339
+ export interface ItemContentInputImage extends ItemContent {
1340
+ /** The type of the input item. Always `input_image`. */
1341
+ type: "input_image";
1342
+ /** The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. */
1343
+ image_url?: string;
1344
+ /** The ID of the file to be sent to the model. */
1345
+ file_id?: string;
1346
+ /** The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. */
1347
+ detail?: "low" | "high" | "auto";
1348
+ }
1349
+ export declare function itemContentInputImageSerializer(item: ItemContentInputImage): any;
1350
+ /**
1351
+ * File input content for messages.
1352
+ * Can specify a file by ID or provide inline file data.
1353
+ */
1354
+ export interface ItemContentInputFile extends ItemContent {
1355
+ /** The type of the input item. Always `input_file`. */
1356
+ type: "input_file";
1357
+ /** The ID of the file to be sent to the model. */
1358
+ file_id?: string;
1359
+ /** The name of the file to be sent to the model. */
1360
+ filename?: string;
1361
+ /** The content of the file to be sent to the model. */
1362
+ file_data?: string;
1363
+ }
1364
+ export declare function itemContentInputFileSerializer(item: ItemContentInputFile): any;
1365
+ /** A text output from the model. */
1366
+ export interface ItemContentOutputText extends ItemContent {
1367
+ /** The type of the output text. Always `output_text`. */
1368
+ type: "output_text";
1369
+ /** The text output from the model. */
1370
+ text: string;
1371
+ /** The annotations of the text output. */
1372
+ annotations: AnnotationUnion[];
1373
+ logprobs?: LogProb[];
1374
+ }
1375
+ export declare function itemContentOutputTextSerializer(item: ItemContentOutputText): any;
1376
+ export declare function annotationUnionArraySerializer(result: Array<AnnotationUnion>): any[];
1377
+ /** model interface Annotation */
1378
+ export interface Annotation {
1379
+ type: AnnotationType;
1380
+ }
1381
+ export declare function annotationSerializer(item: Annotation): any;
1382
+ /** Alias for AnnotationUnion */
1383
+ export type AnnotationUnion = AnnotationFileCitation | AnnotationUrlCitation | AnnotationFilePath | Annotation;
1384
+ export declare function annotationUnionSerializer(item: AnnotationUnion): any;
1385
+ /** Type of AnnotationType */
1386
+ export type AnnotationType = "file_citation" | "url_citation" | "file_path" | "container_file_citation";
1387
+ /** A citation to a file. */
1388
+ export interface AnnotationFileCitation extends Annotation {
1389
+ /** The type of the file citation. Always `file_citation`. */
1390
+ type: "file_citation";
1391
+ /** The ID of the file. */
1392
+ file_id: string;
1393
+ /** The index of the file in the list of files. */
1394
+ index: number;
1395
+ /** The filename of the file cited. */
1396
+ filename: string;
1397
+ }
1398
+ export declare function annotationFileCitationSerializer(item: AnnotationFileCitation): any;
1399
+ /** A citation for a web resource used to generate a model response. */
1400
+ export interface AnnotationUrlCitation extends Annotation {
1401
+ /** The type of the URL citation. Always `url_citation`. */
1402
+ type: "url_citation";
1403
+ /** The URL of the web resource. */
1404
+ url: string;
1405
+ /** The index of the first character of the URL citation in the message. */
1406
+ start_index: number;
1407
+ /** The index of the last character of the URL citation in the message. */
1408
+ end_index: number;
1409
+ /** The title of the web resource. */
1410
+ title: string;
1411
+ }
1412
+ export declare function annotationUrlCitationSerializer(item: AnnotationUrlCitation): any;
1413
+ /** A path to a file. */
1414
+ export interface AnnotationFilePath extends Annotation {
1415
+ /** The type of the file path. Always `file_path`. */
1416
+ type: "file_path";
1417
+ /** The ID of the file. */
1418
+ file_id: string;
1419
+ /** The index of the file in the list of files. */
1420
+ index: number;
1421
+ }
1422
+ export declare function annotationFilePathSerializer(item: AnnotationFilePath): any;
1423
+ export declare function logProbArraySerializer(result: Array<LogProb>): any[];
1424
+ /** The log probability of a token. */
1425
+ export interface LogProb {
1426
+ token: string;
1427
+ logprob: number;
1428
+ bytes: number[];
1429
+ top_logprobs: TopLogProb[];
1430
+ }
1431
+ export declare function logProbSerializer(item: LogProb): any;
1432
+ export declare function topLogProbArraySerializer(result: Array<TopLogProb>): any[];
1433
+ /** The top log probability of a token. */
1434
+ export interface TopLogProb {
1435
+ token: string;
1436
+ logprob: number;
1437
+ bytes: number[];
1438
+ }
1439
+ export declare function topLogProbSerializer(item: TopLogProb): any;
1440
+ /** A message parameter item with the `system` role. */
1441
+ export interface ResponsesSystemMessageItemParam extends ResponsesMessageItemParam {
1442
+ /** The role of the message, which is always `system`. */
1443
+ role: "system";
1444
+ /** The content associated with the message. */
1445
+ content: string | ItemContentUnion[];
1446
+ }
1447
+ export declare function responsesSystemMessageItemParamSerializer(item: ResponsesSystemMessageItemParam): any;
1448
+ /** Alias for _ResponsesSystemMessageItemParamContent */
1449
+ export type _ResponsesSystemMessageItemParamContent = string | ItemContentUnion[];
1450
+ export declare function _responsesSystemMessageItemParamContentSerializer(item: _ResponsesSystemMessageItemParamContent): any;
1451
+ /** A message parameter item with the `developer` role. */
1452
+ export interface ResponsesDeveloperMessageItemParam extends ResponsesMessageItemParam {
1453
+ /** The role of the message, which is always `developer`. */
1454
+ role: "developer";
1455
+ /** The content associated with the message. */
1456
+ content: string | ItemContentUnion[];
1457
+ }
1458
+ export declare function responsesDeveloperMessageItemParamSerializer(item: ResponsesDeveloperMessageItemParam): any;
1459
+ /** Alias for _ResponsesDeveloperMessageItemParamContent */
1460
+ export type _ResponsesDeveloperMessageItemParamContent = string | ItemContentUnion[];
1461
+ export declare function _responsesDeveloperMessageItemParamContentSerializer(item: _ResponsesDeveloperMessageItemParamContent): any;
1462
+ /** A message parameter item with the `assistant` role. */
1463
+ export interface ResponsesAssistantMessageItemParam extends ResponsesMessageItemParam {
1464
+ /** The role of the message, which is always `assistant`. */
1465
+ role: "assistant";
1466
+ /** The content associated with the message. */
1467
+ content: string | ItemContentUnion[];
1468
+ }
1469
+ export declare function responsesAssistantMessageItemParamSerializer(item: ResponsesAssistantMessageItemParam): any;
1470
+ /** Alias for _ResponsesAssistantMessageItemParamContent */
1471
+ export type _ResponsesAssistantMessageItemParamContent = string | ItemContentUnion[];
1472
+ export declare function _responsesAssistantMessageItemParamContentSerializer(item: _ResponsesAssistantMessageItemParamContent): any;
1473
+ /**
1474
+ * The output of a function tool call.
1475
+ *
1476
+ */
1477
+ export interface FunctionToolCallOutputItemParam extends ItemParam {
1478
+ type: "function_call_output";
1479
+ /** The unique ID of the function tool call generated by the model. */
1480
+ call_id: string;
1481
+ /** A JSON string of the output of the function tool call. */
1482
+ output: string;
1483
+ }
1484
+ export declare function functionToolCallOutputItemParamSerializer(item: FunctionToolCallOutputItemParam): any;
1485
+ /**
1486
+ * File search tool call item.
1487
+ * Contains queries and results from a file search operation.
1488
+ * See the [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information.
1489
+ */
1490
+ export interface FileSearchToolCallItemParam extends ItemParam {
1491
+ type: "file_search_call";
1492
+ /** The queries used to search for files. */
1493
+ queries: string[];
1494
+ /** The results of the file search tool call. */
1495
+ results?: {
1496
+ file_id?: string;
1497
+ text?: string;
1498
+ filename?: string;
1499
+ attributes?: VectorStoreFileAttributes;
1500
+ score?: number;
1501
+ }[];
1502
+ }
1503
+ export declare function fileSearchToolCallItemParamSerializer(item: FileSearchToolCallItemParam): any;
1504
+ export declare function _fileSearchToolCallItemParamResultArraySerializer(result: Array<_FileSearchToolCallItemParamResult>): any[];
1505
+ /** model interface _FileSearchToolCallItemParamResult */
1506
+ export interface _FileSearchToolCallItemParamResult {
1507
+ /** The unique ID of the file. */
1508
+ file_id?: string;
1509
+ /** The text that was retrieved from the file. */
1510
+ text?: string;
1511
+ /** The name of the file. */
1512
+ filename?: string;
1513
+ attributes?: VectorStoreFileAttributes;
1514
+ /** The relevance score of the file - a value between 0 and 1. */
1515
+ score?: number;
1516
+ }
1517
+ export declare function _fileSearchToolCallItemParamResultSerializer(item: _FileSearchToolCallItemParamResult): any;
1518
+ /**
1519
+ * Set of 16 key-value pairs that can be attached to an object. This can be
1520
+ * useful for storing additional information about the object in a structured
1521
+ * format, and querying for objects via API or the dashboard. Keys are strings
1522
+ * with a maximum length of 64 characters. Values are strings with a maximum
1523
+ * length of 512 characters, booleans, or numbers.
1524
+ */
1525
+ export interface VectorStoreFileAttributes {
1526
+ /** Additional properties */
1527
+ additionalProperties?: Record<string, string | boolean | number>;
1528
+ }
1529
+ export declare function vectorStoreFileAttributesSerializer(item: VectorStoreFileAttributes): any;
1530
+ /** Alias for _VectorStoreFileAttributesAdditionalProperty */
1531
+ export type _VectorStoreFileAttributesAdditionalProperty = string | boolean | number | number;
1532
+ export declare function _vectorStoreFileAttributesAdditionalPropertySerializer(item: _VectorStoreFileAttributesAdditionalProperty): any;
1533
+ /**
1534
+ * A tool call to a computer use tool. See the
1535
+ * [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information.
1536
+ *
1537
+ */
1538
+ export interface ComputerToolCallItemParam extends ItemParam {
1539
+ type: "computer_call";
1540
+ /** An identifier used when responding to the tool call with output. */
1541
+ call_id: string;
1542
+ action: ComputerActionUnion;
1543
+ /** The pending safety checks for the computer call. */
1544
+ pending_safety_checks: ComputerToolCallSafetyCheck[];
1545
+ }
1546
+ export declare function computerToolCallItemParamSerializer(item: ComputerToolCallItemParam): any;
1547
+ /** model interface ComputerAction */
1548
+ export interface ComputerAction {
1549
+ type: ComputerActionType;
1550
+ }
1551
+ export declare function computerActionSerializer(item: ComputerAction): any;
1552
+ /** Alias for ComputerActionUnion */
1553
+ export type ComputerActionUnion = ComputerActionClick | ComputerActionDoubleClick | ComputerActionDrag | ComputerActionMove | ComputerActionScreenshot | ComputerActionScroll | ComputerActionTypeKeys | ComputerActionWait | ComputerActionKeyPress | ComputerAction;
1554
+ export declare function computerActionUnionSerializer(item: ComputerActionUnion): any;
1555
+ /** Type of ComputerActionType */
1556
+ export type ComputerActionType = "screenshot" | "click" | "double_click" | "scroll" | "type" | "wait" | "keypress" | "drag" | "move";
1557
+ /** A click action. */
1558
+ export interface ComputerActionClick extends ComputerAction {
1559
+ /**
1560
+ * Specifies the event type. For a click action, this property is
1561
+ * always set to `click`.
1562
+ */
1563
+ type: "click";
1564
+ /** Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. */
1565
+ button: "left" | "right" | "wheel" | "back" | "forward";
1566
+ /** The x-coordinate where the click occurred. */
1567
+ x: number;
1568
+ /** The y-coordinate where the click occurred. */
1569
+ y: number;
1570
+ }
1571
+ export declare function computerActionClickSerializer(item: ComputerActionClick): any;
1572
+ /** A double click action. */
1573
+ export interface ComputerActionDoubleClick extends ComputerAction {
1574
+ /**
1575
+ * Specifies the event type. For a double click action, this property is
1576
+ * always set to `double_click`.
1577
+ */
1578
+ type: "double_click";
1579
+ /** The x-coordinate where the double click occurred. */
1580
+ x: number;
1581
+ /** The y-coordinate where the double click occurred. */
1582
+ y: number;
1583
+ }
1584
+ export declare function computerActionDoubleClickSerializer(item: ComputerActionDoubleClick): any;
1585
+ /** A drag action. */
1586
+ export interface ComputerActionDrag extends ComputerAction {
1587
+ /**
1588
+ * Specifies the event type. For a drag action, this property is
1589
+ * always set to `drag`.
1590
+ */
1591
+ type: "drag";
1592
+ /**
1593
+ * An array of coordinates representing the path of the drag action. Coordinates will appear as an array
1594
+ * of objects, eg
1595
+ * ```
1596
+ * [
1597
+ * { x: 100, y: 200 },
1598
+ * { x: 200, y: 300 }
1599
+ * ]
1600
+ * ```
1601
+ */
1602
+ path: Coordinate[];
1603
+ }
1604
+ export declare function computerActionDragSerializer(item: ComputerActionDrag): any;
1605
+ export declare function coordinateArraySerializer(result: Array<Coordinate>): any[];
1606
+ /** An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`. */
1607
+ export interface Coordinate {
1608
+ /** The x-coordinate. */
1609
+ x: number;
1610
+ /** The y-coordinate. */
1611
+ y: number;
1612
+ }
1613
+ export declare function coordinateSerializer(item: Coordinate): any;
1614
+ /** A mouse move action. */
1615
+ export interface ComputerActionMove extends ComputerAction {
1616
+ /**
1617
+ * Specifies the event type. For a move action, this property is
1618
+ * always set to `move`.
1619
+ */
1620
+ type: "move";
1621
+ /** The x-coordinate to move to. */
1622
+ x: number;
1623
+ /** The y-coordinate to move to. */
1624
+ y: number;
1625
+ }
1626
+ export declare function computerActionMoveSerializer(item: ComputerActionMove): any;
1627
+ /** A screenshot action. */
1628
+ export interface ComputerActionScreenshot extends ComputerAction {
1629
+ /**
1630
+ * Specifies the event type. For a screenshot action, this property is
1631
+ * always set to `screenshot`.
1632
+ */
1633
+ type: "screenshot";
1634
+ }
1635
+ export declare function computerActionScreenshotSerializer(item: ComputerActionScreenshot): any;
1636
+ /** A scroll action. */
1637
+ export interface ComputerActionScroll extends ComputerAction {
1638
+ /**
1639
+ * Specifies the event type. For a scroll action, this property is
1640
+ * always set to `scroll`.
1641
+ */
1642
+ type: "scroll";
1643
+ /** The x-coordinate where the scroll occurred. */
1644
+ x: number;
1645
+ /** The y-coordinate where the scroll occurred. */
1646
+ y: number;
1647
+ /** The horizontal scroll distance. */
1648
+ scroll_x: number;
1649
+ /** The vertical scroll distance. */
1650
+ scroll_y: number;
1651
+ }
1652
+ export declare function computerActionScrollSerializer(item: ComputerActionScroll): any;
1653
+ /** An action to type in text. */
1654
+ export interface ComputerActionTypeKeys extends ComputerAction {
1655
+ /**
1656
+ * Specifies the event type. For a type action, this property is
1657
+ * always set to `type`.
1658
+ */
1659
+ type: "type";
1660
+ /** The text to type. */
1661
+ text: string;
1662
+ }
1663
+ export declare function computerActionTypeKeysSerializer(item: ComputerActionTypeKeys): any;
1664
+ /** A wait action. */
1665
+ export interface ComputerActionWait extends ComputerAction {
1666
+ /**
1667
+ * Specifies the event type. For a wait action, this property is
1668
+ * always set to `wait`.
1669
+ */
1670
+ type: "wait";
1671
+ }
1672
+ export declare function computerActionWaitSerializer(item: ComputerActionWait): any;
1673
+ /** A collection of keypresses the model would like to perform. */
1674
+ export interface ComputerActionKeyPress extends ComputerAction {
1675
+ /**
1676
+ * Specifies the event type. For a keypress action, this property is
1677
+ * always set to `keypress`.
1678
+ */
1679
+ type: "keypress";
1680
+ /**
1681
+ * The combination of keys the model is requesting to be pressed. This is an
1682
+ * array of strings, each representing a key.
1683
+ */
1684
+ keys: string[];
1685
+ }
1686
+ export declare function computerActionKeyPressSerializer(item: ComputerActionKeyPress): any;
1687
+ export declare function computerToolCallSafetyCheckArraySerializer(result: Array<ComputerToolCallSafetyCheck>): any[];
1688
+ /** A pending safety check for the computer call. */
1689
+ export interface ComputerToolCallSafetyCheck {
1690
+ /** The ID of the pending safety check. */
1691
+ id: string;
1692
+ /** The type of the pending safety check. */
1693
+ code: string;
1694
+ /** Details about the pending safety check. */
1695
+ message: string;
1696
+ }
1697
+ export declare function computerToolCallSafetyCheckSerializer(item: ComputerToolCallSafetyCheck): any;
1698
+ /**
1699
+ * The output of a computer tool call.
1700
+ *
1701
+ */
1702
+ export interface ComputerToolCallOutputItemParam extends ItemParam {
1703
+ type: "computer_call_output";
1704
+ /** The ID of the computer tool call that produced the output. */
1705
+ call_id: string;
1706
+ /**
1707
+ * The safety checks reported by the API that have been acknowledged by the
1708
+ * developer.
1709
+ */
1710
+ acknowledged_safety_checks?: ComputerToolCallSafetyCheck[];
1711
+ output: ComputerToolCallOutputItemOutputUnion;
1712
+ }
1713
+ export declare function computerToolCallOutputItemParamSerializer(item: ComputerToolCallOutputItemParam): any;
1714
+ /** model interface ComputerToolCallOutputItemOutput */
1715
+ export interface ComputerToolCallOutputItemOutput {
1716
+ type: ComputerToolCallOutputItemOutputType;
1717
+ }
1718
+ export declare function computerToolCallOutputItemOutputSerializer(item: ComputerToolCallOutputItemOutput): any;
1719
+ /** Alias for ComputerToolCallOutputItemOutputUnion */
1720
+ export type ComputerToolCallOutputItemOutputUnion = ComputerToolCallOutputItemOutputComputerScreenshot | ComputerToolCallOutputItemOutput;
1721
+ export declare function computerToolCallOutputItemOutputUnionSerializer(item: ComputerToolCallOutputItemOutputUnion): any;
1722
+ /** A computer screenshot image used with the computer use tool. */
1723
+ export type ComputerToolCallOutputItemOutputType = "computer_screenshot";
1724
+ /** model interface ComputerToolCallOutputItemOutputComputerScreenshot */
1725
+ export interface ComputerToolCallOutputItemOutputComputerScreenshot extends ComputerToolCallOutputItemOutput {
1726
+ type: "computer_screenshot";
1727
+ /** The URL of the screenshot image. */
1728
+ image_url?: string;
1729
+ /** The ID of the screenshot file. */
1730
+ file_id?: string;
1731
+ }
1732
+ export declare function computerToolCallOutputItemOutputComputerScreenshotSerializer(item: ComputerToolCallOutputItemOutputComputerScreenshot): any;
1733
+ /**
1734
+ * The results of a web search tool call. See the
1735
+ * [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information.
1736
+ *
1737
+ */
1738
+ export interface WebSearchToolCallItemParam extends ItemParam {
1739
+ type: "web_search_call";
1740
+ /**
1741
+ * An object describing the specific action taken in this web search call.
1742
+ * Includes details on how the model used the web (search, open_page, find).
1743
+ */
1744
+ action: WebSearchActionUnion;
1745
+ }
1746
+ export declare function webSearchToolCallItemParamSerializer(item: WebSearchToolCallItemParam): any;
1747
+ /** model interface WebSearchAction */
1748
+ export interface WebSearchAction {
1749
+ type: WebSearchActionType;
1750
+ }
1751
+ export declare function webSearchActionSerializer(item: WebSearchAction): any;
1752
+ /** Alias for WebSearchActionUnion */
1753
+ export type WebSearchActionUnion = WebSearchActionFind | WebSearchActionOpenPage | WebSearchActionSearch | WebSearchAction;
1754
+ export declare function webSearchActionUnionSerializer(item: WebSearchActionUnion): any;
1755
+ /** Type of WebSearchActionType */
1756
+ export type WebSearchActionType = "search" | "open_page" | "find";
1757
+ /** Action type "find": Searches for a pattern within a loaded page. */
1758
+ export interface WebSearchActionFind extends WebSearchAction {
1759
+ /** The action type. */
1760
+ type: "find";
1761
+ /** The URL of the page searched for the pattern. */
1762
+ url: string;
1763
+ /** The pattern or text to search for within the page. */
1764
+ pattern: string;
1765
+ }
1766
+ export declare function webSearchActionFindSerializer(item: WebSearchActionFind): any;
1767
+ /** Action type "open_page" - Opens a specific URL from search results. */
1768
+ export interface WebSearchActionOpenPage extends WebSearchAction {
1769
+ /** The action type. */
1770
+ type: "open_page";
1771
+ /** The URL opened by the model. */
1772
+ url: string;
1773
+ }
1774
+ export declare function webSearchActionOpenPageSerializer(item: WebSearchActionOpenPage): any;
1775
+ /** Action type "search" - Performs a web search query. */
1776
+ export interface WebSearchActionSearch extends WebSearchAction {
1777
+ /** The action type. */
1778
+ type: "search";
1779
+ /** The search query. */
1780
+ query: string;
1781
+ /** The sources used in the search. */
1782
+ sources?: WebSearchActionSearchSources[];
1783
+ }
1784
+ export declare function webSearchActionSearchSerializer(item: WebSearchActionSearch): any;
1785
+ export declare function webSearchActionSearchSourcesArraySerializer(result: Array<WebSearchActionSearchSources>): any[];
1786
+ /** model interface WebSearchActionSearchSources */
1787
+ export interface WebSearchActionSearchSources {
1788
+ type: "url";
1789
+ url: string;
1790
+ }
1791
+ export declare function webSearchActionSearchSourcesSerializer(item: WebSearchActionSearchSources): any;
1792
+ /**
1793
+ * A tool call to run a function. See the
1794
+ * [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.
1795
+ *
1796
+ */
1797
+ export interface FunctionToolCallItemParam extends ItemParam {
1798
+ type: "function_call";
1799
+ /** The unique ID of the function tool call generated by the model. */
1800
+ call_id: string;
1801
+ /** The name of the function to run. */
1802
+ name: string;
1803
+ /** A JSON string of the arguments to pass to the function. */
1804
+ arguments: string;
1805
+ }
1806
+ export declare function functionToolCallItemParamSerializer(item: FunctionToolCallItemParam): any;
1807
+ /**
1808
+ * Reasoning item parameter for o-series models.
1809
+ * Contains the chain of thought used by a reasoning model while generating a response.
1810
+ * Be sure to include these items in your `input` to the Responses API
1811
+ * for subsequent turns of a conversation if you are manually
1812
+ * [managing conversation state](https://platform.openai.com/docs/guides/conversation-state).
1813
+ */
1814
+ export interface ReasoningItemParam extends ItemParam {
1815
+ type: "reasoning";
1816
+ /**
1817
+ * The encrypted content of the reasoning item - populated when a response is
1818
+ * generated with `reasoning.encrypted_content` in the `include` parameter.
1819
+ */
1820
+ encrypted_content?: string;
1821
+ /** Reasoning text contents. */
1822
+ summary: ReasoningItemSummaryPartUnion[];
1823
+ }
1824
+ export declare function reasoningItemParamSerializer(item: ReasoningItemParam): any;
1825
+ export declare function reasoningItemSummaryPartUnionArraySerializer(result: Array<ReasoningItemSummaryPartUnion>): any[];
1826
+ /** model interface ReasoningItemSummaryPart */
1827
+ export interface ReasoningItemSummaryPart {
1828
+ type: ReasoningItemSummaryPartType;
1829
+ }
1830
+ export declare function reasoningItemSummaryPartSerializer(item: ReasoningItemSummaryPart): any;
1831
+ /** Alias for ReasoningItemSummaryPartUnion */
1832
+ export type ReasoningItemSummaryPartUnion = ReasoningItemSummaryTextPart | ReasoningItemSummaryPart;
1833
+ export declare function reasoningItemSummaryPartUnionSerializer(item: ReasoningItemSummaryPartUnion): any;
1834
+ /** Type of ReasoningItemSummaryPartType */
1835
+ export type ReasoningItemSummaryPartType = "summary_text";
1836
+ /** model interface ReasoningItemSummaryTextPart */
1837
+ export interface ReasoningItemSummaryTextPart extends ReasoningItemSummaryPart {
1838
+ type: "summary_text";
1839
+ text: string;
1840
+ }
1841
+ export declare function reasoningItemSummaryTextPartSerializer(item: ReasoningItemSummaryTextPart): any;
1842
+ /** An internal identifier for an item to reference. */
1843
+ export interface ItemReferenceItemParam extends ItemParam {
1844
+ type: "item_reference";
1845
+ /** The service-originated ID of the previously generated response item being referenced. */
1846
+ id: string;
1847
+ }
1848
+ export declare function itemReferenceItemParamSerializer(item: ItemReferenceItemParam): any;
1849
+ /**
1850
+ * Image generation tool call item.
1851
+ * Contains the request made by the model to generate an image.
1852
+ */
1853
+ export interface ImageGenToolCallItemParam extends ItemParam {
1854
+ type: "image_generation_call";
1855
+ /** The generated image encoded in base64. */
1856
+ result: string;
1857
+ }
1858
+ export declare function imageGenToolCallItemParamSerializer(item: ImageGenToolCallItemParam): any;
1859
+ /**
1860
+ * Code interpreter tool call item.
1861
+ * Contains code execution request and outputs from the code interpreter.
1862
+ */
1863
+ export interface CodeInterpreterToolCallItemParam extends ItemParam {
1864
+ type: "code_interpreter_call";
1865
+ /** The ID of the container used to run the code. */
1866
+ container_id: string;
1867
+ /** The code to run. */
1868
+ code: string;
1869
+ /**
1870
+ * The outputs generated by the code interpreter, such as logs or images.
1871
+ */
1872
+ outputs: CodeInterpreterOutputUnion[];
1873
+ }
1874
+ export declare function codeInterpreterToolCallItemParamSerializer(item: CodeInterpreterToolCallItemParam): any;
1875
+ export declare function codeInterpreterOutputUnionArraySerializer(result: Array<CodeInterpreterOutputUnion>): any[];
1876
+ /** model interface CodeInterpreterOutput */
1877
+ export interface CodeInterpreterOutput {
1878
+ type: CodeInterpreterOutputType;
1879
+ }
1880
+ export declare function codeInterpreterOutputSerializer(item: CodeInterpreterOutput): any;
1881
+ /** Alias for CodeInterpreterOutputUnion */
1882
+ export type CodeInterpreterOutputUnion = CodeInterpreterOutputImage | CodeInterpreterOutputLogs | CodeInterpreterOutput;
1883
+ export declare function codeInterpreterOutputUnionSerializer(item: CodeInterpreterOutputUnion): any;
1884
+ /** Type of CodeInterpreterOutputType */
1885
+ export type CodeInterpreterOutputType = "logs" | "image";
1886
+ /** The image output from the code interpreter. */
1887
+ export interface CodeInterpreterOutputImage extends CodeInterpreterOutput {
1888
+ /** The type of the output. Always 'image'. */
1889
+ type: "image";
1890
+ /** The URL of the image output from the code interpreter. */
1891
+ url: string;
1892
+ }
1893
+ export declare function codeInterpreterOutputImageSerializer(item: CodeInterpreterOutputImage): any;
1894
+ /** The logs output from the code interpreter. */
1895
+ export interface CodeInterpreterOutputLogs extends CodeInterpreterOutput {
1896
+ /** The type of the output. Always 'logs'. */
1897
+ type: "logs";
1898
+ /** The logs output from the code interpreter. */
1899
+ logs: string;
1900
+ }
1901
+ export declare function codeInterpreterOutputLogsSerializer(item: CodeInterpreterOutputLogs): any;
1902
+ /**
1903
+ * A tool call to run a command on the local shell.
1904
+ *
1905
+ */
1906
+ export interface LocalShellToolCallItemParam extends ItemParam {
1907
+ type: "local_shell_call";
1908
+ /** The unique ID of the local shell tool call generated by the model. */
1909
+ call_id: string;
1910
+ action: LocalShellExecAction;
1911
+ }
1912
+ export declare function localShellToolCallItemParamSerializer(item: LocalShellToolCallItemParam): any;
1913
+ /**
1914
+ * Execute a shell command action.
1915
+ * Defines the command, environment, and execution context for local shell execution.
1916
+ */
1917
+ export interface LocalShellExecAction {
1918
+ /** The type of the local shell action. Always `exec`. */
1919
+ type: "exec";
1920
+ /** The command to run. */
1921
+ command: string[];
1922
+ /** Optional timeout in milliseconds for the command. */
1923
+ timeout_ms?: number;
1924
+ /** Optional working directory to run the command in. */
1925
+ working_directory?: string;
1926
+ /** Environment variables to set for the command. */
1927
+ env: Record<string, string>;
1928
+ /** Optional user to run the command as. */
1929
+ user?: string;
1930
+ }
1931
+ export declare function localShellExecActionSerializer(item: LocalShellExecAction): any;
1932
+ /**
1933
+ * The output of a local shell tool call.
1934
+ *
1935
+ */
1936
+ export interface LocalShellToolCallOutputItemParam extends ItemParam {
1937
+ type: "local_shell_call_output";
1938
+ /** A JSON string of the output of the local shell tool call. */
1939
+ output: string;
1940
+ }
1941
+ export declare function localShellToolCallOutputItemParamSerializer(item: LocalShellToolCallOutputItemParam): any;
1942
+ /**
1943
+ * MCP tool list item.
1944
+ * Contains the list of tools available on an MCP server.
1945
+ */
1946
+ export interface MCPListToolsItemParam extends ItemParam {
1947
+ type: "mcp_list_tools";
1948
+ /** The label of the MCP server. */
1949
+ server_label: string;
1950
+ /** The tools available on the server. */
1951
+ tools: MCPListToolsTool[];
1952
+ /** Error message if the server could not list tools. */
1953
+ error?: string;
1954
+ }
1955
+ export declare function mcpListToolsItemParamSerializer(item: MCPListToolsItemParam): any;
1956
+ export declare function mcpListToolsToolArraySerializer(result: Array<MCPListToolsTool>): any[];
1957
+ /**
1958
+ * A tool available on an MCP server.
1959
+ * Describes a single tool with its name, description, input schema, and annotations.
1960
+ */
1961
+ export interface MCPListToolsTool {
1962
+ /** The name of the tool. */
1963
+ name: string;
1964
+ /** The description of the tool. */
1965
+ description?: string;
1966
+ /** The JSON schema describing the tool's input. */
1967
+ input_schema: unknown;
1968
+ /** Additional annotations about the tool. */
1969
+ annotations?: unknown;
1970
+ }
1971
+ export declare function mcpListToolsToolSerializer(item: MCPListToolsTool): any;
1972
+ /**
1973
+ * A request for human approval of a tool invocation.
1974
+ *
1975
+ */
1976
+ export interface MCPApprovalRequestItemParam extends ItemParam {
1977
+ type: "mcp_approval_request";
1978
+ /** The label of the MCP server making the request. */
1979
+ server_label: string;
1980
+ /** The name of the tool to run. */
1981
+ name: string;
1982
+ /** A JSON string of arguments for the tool. */
1983
+ arguments: string;
1984
+ }
1985
+ export declare function mcpApprovalRequestItemParamSerializer(item: MCPApprovalRequestItemParam): any;
1986
+ /**
1987
+ * MCP approval response item.
1988
+ * Contains the response to an MCP tool approval request.
1989
+ */
1990
+ export interface MCPApprovalResponseItemParam extends ItemParam {
1991
+ type: "mcp_approval_response";
1992
+ /** The ID of the approval request being answered. */
1993
+ approval_request_id: string;
1994
+ /** Whether the request was approved. */
1995
+ approve: boolean;
1996
+ /** Optional reason for the decision. */
1997
+ reason?: string;
1998
+ }
1999
+ export declare function mcpApprovalResponseItemParamSerializer(item: MCPApprovalResponseItemParam): any;
2000
+ /**
2001
+ * MCP tool call item.
2002
+ * Contains an invocation of a tool on an MCP server with its arguments and results.
2003
+ */
2004
+ export interface MCPCallItemParam extends ItemParam {
2005
+ type: "mcp_call";
2006
+ /** The label of the MCP server running the tool. */
2007
+ server_label: string;
2008
+ /** The name of the tool that was run. */
2009
+ name: string;
2010
+ /** A JSON string of the arguments passed to the tool. */
2011
+ arguments: string;
2012
+ /** The output from the tool call. */
2013
+ output?: string;
2014
+ /** The error from the tool call, if any. */
2015
+ error?: string;
2016
+ }
2017
+ export declare function mcpCallItemParamSerializer(item: MCPCallItemParam): any;
2018
+ /**
2019
+ * Memory search tool call item.
2020
+ * Contains results from a memory store search operation.
2021
+ */
2022
+ export interface MemorySearchToolCallItemParam extends ItemParam {
2023
+ type: "memory_search_call";
2024
+ /** The results returned from the memory search. */
2025
+ results?: MemorySearchItem[];
2026
+ }
2027
+ export declare function memorySearchToolCallItemParamSerializer(item: MemorySearchToolCallItemParam): any;
2028
+ export declare function memorySearchItemArraySerializer(result: Array<MemorySearchItem>): any[];
2029
+ export declare function memorySearchItemArrayDeserializer(result: Array<MemorySearchItem>): any[];
2030
+ /** A retrieved memory item from memory search. */
2031
+ export interface MemorySearchItem {
2032
+ /** Retrieved memory item. */
2033
+ memory_item: MemoryItemUnion;
2034
+ }
2035
+ export declare function memorySearchItemSerializer(item: MemorySearchItem): any;
2036
+ export declare function memorySearchItemDeserializer(item: any): MemorySearchItem;
2037
+ /** A single memory item stored in the memory store, containing content and metadata. */
2038
+ export interface MemoryItem {
2039
+ /** The unique ID of the memory item. */
2040
+ memory_id: string;
2041
+ /** The last update time of the memory item. */
2042
+ updated_at: Date;
2043
+ /** The namespace that logically groups and isolates memories, such as a user ID. */
2044
+ scope: string;
2045
+ /** The content of the memory. */
2046
+ content: string;
2047
+ /** The kind of the memory item. */
2048
+ /** The discriminator possible values: user_profile, chat_summary */
2049
+ kind: MemoryItemKind;
2050
+ }
2051
+ export declare function memoryItemSerializer(item: MemoryItem): any;
2052
+ export declare function memoryItemDeserializer(item: any): MemoryItem;
2053
+ /** Alias for MemoryItemUnion */
2054
+ export type MemoryItemUnion = UserProfileMemoryItem | ChatSummaryMemoryItem | MemoryItem;
2055
+ export declare function memoryItemUnionSerializer(item: MemoryItemUnion): any;
2056
+ export declare function memoryItemUnionDeserializer(item: any): MemoryItemUnion;
2057
+ /** Memory item kind. */
2058
+ export type MemoryItemKind = "user_profile" | "chat_summary";
2059
+ /** A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details. */
2060
+ export interface UserProfileMemoryItem extends MemoryItem {
2061
+ /** The kind of the memory item. */
2062
+ kind: "user_profile";
2063
+ }
2064
+ export declare function userProfileMemoryItemSerializer(item: UserProfileMemoryItem): any;
2065
+ export declare function userProfileMemoryItemDeserializer(item: any): UserProfileMemoryItem;
2066
+ /** A memory item containing a summary extracted from conversations. */
2067
+ export interface ChatSummaryMemoryItem extends MemoryItem {
2068
+ /** The kind of the memory item. */
2069
+ kind: "chat_summary";
2070
+ }
2071
+ export declare function chatSummaryMemoryItemSerializer(item: ChatSummaryMemoryItem): any;
2072
+ export declare function chatSummaryMemoryItemDeserializer(item: any): ChatSummaryMemoryItem;
2073
+ export declare function itemParamUnionArraySerializer(result: Array<ItemParamUnion>): any[];
2074
+ /** Memory search response. */
2075
+ export interface MemoryStoreSearchResponse {
2076
+ /** The unique ID of this search request. Use this value as previous_search_id in subsequent requests to perform incremental searches. */
2077
+ search_id: string;
2078
+ /** Related memory items found during the search operation. */
2079
+ memories: MemorySearchItem[];
2080
+ /** Usage statistics associated with the memory search operation. */
2081
+ usage: MemoryStoreOperationUsage;
2082
+ }
2083
+ export declare function memoryStoreSearchResponseDeserializer(item: any): MemoryStoreSearchResponse;
2084
+ /** Usage statistics of a memory store operation. */
2085
+ export interface MemoryStoreOperationUsage {
2086
+ /** The number of embedding tokens. */
2087
+ embedding_tokens: number;
2088
+ /** The number of input tokens. */
2089
+ input_tokens: number;
2090
+ /** A detailed breakdown of the input tokens. */
2091
+ input_tokens_details: {
2092
+ cached_tokens: number;
2093
+ };
2094
+ /** The number of output tokens. */
2095
+ output_tokens: number;
2096
+ /** A detailed breakdown of the output tokens. */
2097
+ output_tokens_details: {
2098
+ reasoning_tokens: number;
2099
+ };
2100
+ /** The total number of tokens used. */
2101
+ total_tokens: number;
2102
+ }
2103
+ export declare function memoryStoreOperationUsageDeserializer(item: any): MemoryStoreOperationUsage;
2104
+ /** model interface _MemoryStoreOperationUsageInputTokensDetails */
2105
+ export interface _MemoryStoreOperationUsageInputTokensDetails {
2106
+ /**
2107
+ * The number of tokens that were retrieved from the cache.
2108
+ * [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
2109
+ */
2110
+ cached_tokens: number;
2111
+ }
2112
+ export declare function _memoryStoreOperationUsageInputTokensDetailsDeserializer(item: any): _MemoryStoreOperationUsageInputTokensDetails;
2113
+ /** model interface _MemoryStoreOperationUsageOutputTokensDetails */
2114
+ export interface _MemoryStoreOperationUsageOutputTokensDetails {
2115
+ /** The number of reasoning tokens. */
2116
+ reasoning_tokens: number;
2117
+ }
2118
+ export declare function _memoryStoreOperationUsageOutputTokensDetailsDeserializer(item: any): _MemoryStoreOperationUsageOutputTokensDetails;
2119
+ /** Provides the status of a memory store update operation. */
2120
+ export interface MemoryStoreUpdateResponse {
2121
+ /** The unique ID of this update request. Use this value as previous_update_id in subsequent requests to perform incremental updates. */
2122
+ update_id: string;
2123
+ /** The status of the memory update operation. One of "queued", "in_progress", "completed", "failed", or "superseded". */
2124
+ status: MemoryStoreUpdateStatus;
2125
+ /** The update_id the operation was superseded by when status is "superseded". */
2126
+ superseded_by?: string;
2127
+ /** The result of memory store update operation when status is "completed". */
2128
+ result?: MemoryStoreUpdateResult;
2129
+ /** Error object that describes the error when status is "failed". */
2130
+ error?: ApiError;
2131
+ }
2132
+ export declare function memoryStoreUpdateResponseDeserializer(item: any): MemoryStoreUpdateResponse;
2133
+ /** Status of a memory store update operation. */
2134
+ export type MemoryStoreUpdateStatus = "queued" | "in_progress" | "completed" | "failed" | "superseded";
2135
+ /** Memory update result. */
2136
+ export interface MemoryStoreUpdateResult {
2137
+ /** A list of individual memory operations that were performed during the update. */
2138
+ memory_operations: MemoryOperation[];
2139
+ /** Usage statistics associated with the memory update operation. */
2140
+ usage: MemoryStoreOperationUsage;
2141
+ }
2142
+ export declare function MemoryStoreUpdateResultDeserializer(item: any): MemoryStoreUpdateResult;
2143
+ export declare function memoryOperationArrayDeserializer(result: Array<MemoryOperation>): any[];
2144
+ /** Represents a single memory operation (create, update, or delete) performed on a memory item. */
2145
+ export interface MemoryOperation {
2146
+ /** The type of memory operation being performed. */
2147
+ kind: MemoryOperationKind;
2148
+ /** The memory item to create, update, or delete. */
2149
+ memory_item: MemoryItemUnion;
2150
+ }
2151
+ export declare function memoryOperationDeserializer(item: any): MemoryOperation;
2152
+ /** Memory operation kind. */
2153
+ export type MemoryOperationKind = "create" | "update" | "delete";
2154
+ /** Response for deleting memories from a scope. */
2155
+ export interface MemoryStoreDeleteScopeResponse {
2156
+ /** The object type. Always 'memory_store.scope.deleted'. */
2157
+ object: "memory_store.scope.deleted";
2158
+ /** The name of the memory store. */
2159
+ name: string;
2160
+ /** The scope from which memories were deleted. */
2161
+ scope: string;
2162
+ /** Whether the deletion operation was successful. */
2163
+ deleted: boolean;
2164
+ }
2165
+ export declare function memoryStoreDeleteScopeResponseDeserializer(item: any): MemoryStoreDeleteScopeResponse;
1
2166
  /** Response from the list and get connections operations */
2
2167
  export interface Connection {
3
2168
  /** The friendly name of the connection, provided by the user. */
@@ -15,27 +2180,27 @@ export interface Connection {
15
2180
  /** Metadata of the connection */
16
2181
  readonly metadata: Record<string, string>;
17
2182
  }
2183
+ export declare function connectionDeserializer(item: any): Connection;
18
2184
  /** The Type (or category) of the connection */
19
- export type ConnectionType = "AzureOpenAI" | "AzureBlob" | "AzureStorageAccount" | "CognitiveSearch" | "CosmosDB" | "ApiKey" | "AppConfig" | "AppInsights" | "CustomKeys";
2185
+ export type ConnectionType = "AzureOpenAI" | "AzureBlob" | "AzureStorageAccount" | "CognitiveSearch" | "CosmosDB" | "ApiKey" | "AppConfig" | "AppInsights" | "CustomKeys" | "RemoteTool";
20
2186
  /** A base class for connection credentials */
21
2187
  export interface BaseCredentials {
22
2188
  /** The type of credential used by the connection */
23
- /** The discriminator possible values: ApiKey, AAD, CustomKeys, SAS, None */
2189
+ /** The discriminator possible values: ApiKey, AAD, CustomKeys, SAS, None, AgenticIdentityToken */
24
2190
  readonly type: CredentialType;
25
2191
  }
26
- export declare function connectionDeserializer(item: any): Connection;
27
2192
  export declare function baseCredentialsDeserializer(item: any): BaseCredentials;
28
2193
  /** Alias for BaseCredentialsUnion */
29
- export type BaseCredentialsUnion = ApiKeyCredentials | EntraIDCredentials | CustomCredential | SASCredentials | NoAuthenticationCredentials | BaseCredentials;
2194
+ export type BaseCredentialsUnion = ApiKeyCredentials | EntraIDCredentials | CustomCredential | SASTokenCredentials | NoAuthenticationCredentials | AgenticIdentityCredentials | BaseCredentials;
30
2195
  export declare function baseCredentialsUnionDeserializer(item: any): BaseCredentialsUnion;
31
2196
  /** The credential type used by the connection */
32
- export type CredentialType = "ApiKey" | "AAD" | "SAS" | "CustomKeys" | "None";
2197
+ export type CredentialType = "ApiKey" | "AAD" | "SAS" | "CustomKeys" | "None" | "AgenticIdentityToken";
33
2198
  /** API Key Credential definition */
34
2199
  export interface ApiKeyCredentials extends BaseCredentials {
35
2200
  /** The credential type */
36
2201
  readonly type: "ApiKey";
37
2202
  /** API Key */
38
- readonly apiKey?: string;
2203
+ readonly apiKey: string;
39
2204
  }
40
2205
  export declare function apiKeyCredentialsDeserializer(item: any): ApiKeyCredentials;
41
2206
  /** Entra ID credential definition */
@@ -48,24 +2213,30 @@ export declare function entraIDCredentialsDeserializer(item: any): EntraIDCreden
48
2213
  export interface CustomCredential extends BaseCredentials {
49
2214
  /** The credential type */
50
2215
  readonly type: "CustomKeys";
51
- /** The credential type */
52
- readonly keys: Record<string, string>;
2216
+ /** Additional properties */
2217
+ additionalProperties?: Record<string, string>;
53
2218
  }
54
2219
  export declare function customCredentialDeserializer(item: any): CustomCredential;
55
2220
  /** Shared Access Signature (SAS) credential definition */
56
- export interface SASCredentials extends BaseCredentials {
2221
+ export interface SASTokenCredentials extends BaseCredentials {
57
2222
  /** The credential type */
58
2223
  readonly type: "SAS";
59
2224
  /** SAS token */
60
- readonly sasToken?: string;
2225
+ readonly sasToken: string;
61
2226
  }
62
- export declare function sasCredentialsDeserializer(item: any): SASCredentials;
2227
+ export declare function sasCredentialsDeserializer(item: any): SASTokenCredentials;
63
2228
  /** Credentials that do not require authentication */
64
2229
  export interface NoAuthenticationCredentials extends BaseCredentials {
65
2230
  /** The credential type */
66
2231
  readonly type: "None";
67
2232
  }
68
2233
  export declare function noAuthenticationCredentialsDeserializer(item: any): NoAuthenticationCredentials;
2234
+ /** Agentic identity credential definition */
2235
+ export interface AgenticIdentityCredentials extends BaseCredentials {
2236
+ /** The credential type */
2237
+ readonly type: "AgenticIdentityToken";
2238
+ }
2239
+ export declare function agenticIdentityCredentialsDeserializer(item: any): AgenticIdentityCredentials;
69
2240
  /** Paged collection of Connection items */
70
2241
  export interface _PagedConnection {
71
2242
  /** The Connection items on this page */
@@ -87,7 +2258,7 @@ export declare function datasetVersionUnionArraySerializer(result: Array<Dataset
87
2258
  export declare function datasetVersionUnionArrayDeserializer(result: Array<DatasetVersionUnion>): any[];
88
2259
  /** DatasetVersion Definition */
89
2260
  export interface DatasetVersion {
90
- /** URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 */
2261
+ /** URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330)) */
91
2262
  dataUri: string;
92
2263
  /** Dataset type */
93
2264
  /** The discriminator possible values: uri_file, uri_folder */
@@ -153,7 +2324,7 @@ export interface PendingUploadResponse {
153
2324
  export declare function pendingUploadResponseDeserializer(item: any): PendingUploadResponse;
154
2325
  /** Blob reference details. */
155
2326
  export interface BlobReference {
156
- /** Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path */
2327
+ /** Blob URI path for client to upload data. Example: `https://blob.windows.core.net/Container/Path` */
157
2328
  blobUri: string;
158
2329
  /** ARM ID of the storage account to use. */
159
2330
  storageAccountArmId: string;
@@ -168,13 +2339,13 @@ export interface SasCredential {
168
2339
  /** Type of credential */
169
2340
  readonly type: "SAS";
170
2341
  }
171
- export declare function sasCredentialDeserializer(item: any): SasCredential;
2342
+ export declare function SasCredentialDeserializer(item: any): SasCredential;
172
2343
  /** Represents a reference to a blob for consumption */
173
- export interface AssetCredentialResponse {
2344
+ export interface DatasetCredential {
174
2345
  /** Credential info to access the storage account. */
175
2346
  blobReference: BlobReference;
176
2347
  }
177
- export declare function assetCredentialResponseDeserializer(item: any): AssetCredentialResponse;
2348
+ export declare function datasetCredentialDeserializer(item: any): DatasetCredential;
178
2349
  /** Paged collection of Index items */
179
2350
  export interface _PagedIndex {
180
2351
  /** The Index items on this page */
@@ -301,13 +2472,13 @@ export interface ModelDeployment extends Deployment {
301
2472
  /** Capabilities of deployed model */
302
2473
  readonly capabilities: Record<string, string>;
303
2474
  /** Sku of the model deployment */
304
- readonly sku: Sku;
2475
+ readonly sku: ModelDeploymentSku;
305
2476
  /** Name of the connection the deployment comes from */
306
2477
  readonly connectionName?: string;
307
2478
  }
308
2479
  export declare function modelDeploymentDeserializer(item: any): ModelDeployment;
309
2480
  /** Sku information */
310
- export interface Sku {
2481
+ export interface ModelDeploymentSku {
311
2482
  /** Sku capacity */
312
2483
  capacity: number;
313
2484
  /** Sku family */
@@ -319,7 +2490,7 @@ export interface Sku {
319
2490
  /** Sku tier */
320
2491
  tier: string;
321
2492
  }
322
- export declare function skuDeserializer(item: any): Sku;
2493
+ export declare function modelDeploymentSkuDeserializer(item: any): ModelDeploymentSku;
323
2494
  /** Paged collection of Deployment items */
324
2495
  export interface _PagedDeployment {
325
2496
  /** The Deployment items on this page */
@@ -329,13 +2500,899 @@ export interface _PagedDeployment {
329
2500
  }
330
2501
  export declare function _pagedDeploymentDeserializer(item: any): _PagedDeployment;
331
2502
  export declare function deploymentUnionArrayDeserializer(result: Array<DeploymentUnion>): any[];
2503
+ /** Red team details. */
2504
+ export interface RedTeam {
2505
+ /** Identifier of the red team run. */
2506
+ readonly name: string;
2507
+ /** Name of the red-team run. */
2508
+ displayName?: string;
2509
+ /** Number of simulation rounds. */
2510
+ numTurns?: number;
2511
+ /** List of attack strategies or nested lists of attack strategies. */
2512
+ attackStrategies?: AttackStrategy[];
2513
+ /** Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. */
2514
+ simulationOnly?: boolean;
2515
+ /** List of risk categories to generate attack objectives for. */
2516
+ riskCategories?: RiskCategory[];
2517
+ /** Application scenario for the red team operation, to generate scenario specific attacks. */
2518
+ applicationScenario?: string;
2519
+ /** Red team's tags. Unlike properties, tags are fully mutable. */
2520
+ tags?: Record<string, string>;
2521
+ /** Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. */
2522
+ properties?: Record<string, string>;
2523
+ /** Status of the red-team. It is set by service and is read-only. */
2524
+ readonly status?: string;
2525
+ /** Target configuration for the red-team run. */
2526
+ target: TargetConfigUnion;
2527
+ }
2528
+ export declare function redTeamSerializer(item: RedTeam): any;
2529
+ export declare function redTeamDeserializer(item: any): RedTeam;
2530
+ /** Strategies for attacks. */
2531
+ export type AttackStrategy = "easy" | "moderate" | "difficult" | "ascii_art" | "ascii_smuggler" | "atbash" | "base64" | "binary" | "caesar" | "character_space" | "jailbreak" | "ansii_attack" | "character_swap" | "suffix_append" | "string_join" | "unicode_confusable" | "unicode_substitution" | "diacritic" | "flip" | "leetspeak" | "rot13" | "morse" | "url" | "baseline" | "indirect_jailbreak" | "tense" | "multi_turn" | "crescendo";
2532
+ /** Risk category for the attack objective. */
2533
+ export type RiskCategory = "HateUnfairness" | "Violence" | "Sexual" | "SelfHarm" | "ProtectedMaterial" | "CodeVulnerability" | "UngroundedAttributes" | "ProhibitedActions" | "SensitiveDataLeakage" | "TaskAdherence";
2534
+ /** Abstract class for target configuration. */
2535
+ export interface TargetConfig {
2536
+ /** Type of the model configuration. */
2537
+ /** The discriminator possible values: AzureOpenAIModel */
2538
+ type: string;
2539
+ }
2540
+ export declare function targetConfigSerializer(item: TargetConfig): any;
2541
+ export declare function targetConfigDeserializer(item: any): TargetConfig;
2542
+ /** Alias for TargetConfigUnion */
2543
+ export type TargetConfigUnion = AzureOpenAIModelConfiguration | TargetConfig;
2544
+ export declare function targetConfigUnionSerializer(item: TargetConfigUnion): any;
2545
+ export declare function targetConfigUnionDeserializer(item: any): TargetConfigUnion;
2546
+ /** Azure OpenAI model configuration. The API version would be selected by the service for querying the model. */
2547
+ export interface AzureOpenAIModelConfiguration extends TargetConfig {
2548
+ type: "AzureOpenAIModel";
2549
+ /** 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`). */
2550
+ modelDeploymentName: string;
2551
+ }
2552
+ export declare function azureOpenAIModelConfigurationSerializer(item: AzureOpenAIModelConfiguration): any;
2553
+ export declare function azureOpenAIModelConfigurationDeserializer(item: any): AzureOpenAIModelConfiguration;
2554
+ /** Paged collection of RedTeam items */
2555
+ export interface _PagedRedTeam {
2556
+ /** The RedTeam items on this page */
2557
+ value: RedTeam[];
2558
+ /** The link to the next page of items */
2559
+ nextLink?: string;
2560
+ }
2561
+ export declare function _pagedRedTeamDeserializer(item: any): _PagedRedTeam;
2562
+ export declare function redTeamArraySerializer(result: Array<RedTeam>): any[];
2563
+ export declare function redTeamArrayDeserializer(result: Array<RedTeam>): any[];
2564
+ /** Evaluation rule model. */
2565
+ export interface EvaluationRule {
2566
+ /** Unique identifier for the evaluation rule. */
2567
+ readonly id: string;
2568
+ /** Display Name for the evaluation rule. */
2569
+ displayName?: string;
2570
+ /** Description for the evaluation rule. */
2571
+ description?: string;
2572
+ /** Definition of the evaluation rule action. */
2573
+ action: EvaluationRuleActionUnion;
2574
+ /** Filter condition of the evaluation rule. */
2575
+ filter?: EvaluationRuleFilter;
2576
+ /** Event type that the evaluation rule applies to. */
2577
+ eventType: EvaluationRuleEventType;
2578
+ /** Indicates whether the evaluation rule is enabled. Default is true. */
2579
+ enabled: boolean;
2580
+ /** System metadata for the evaluation rule. */
2581
+ readonly systemData: Record<string, string>;
2582
+ }
2583
+ export declare function evaluationRuleSerializer(item: EvaluationRule): any;
2584
+ export declare function evaluationRuleDeserializer(item: any): EvaluationRule;
2585
+ /** Evaluation action model. */
2586
+ export interface EvaluationRuleAction {
2587
+ /** Type of the evaluation action. */
2588
+ /** The discriminator possible values: continuousEvaluation, humanEvaluation */
2589
+ type: EvaluationRuleActionType;
2590
+ }
2591
+ export declare function evaluationRuleActionSerializer(item: EvaluationRuleAction): any;
2592
+ export declare function evaluationRuleActionDeserializer(item: any): EvaluationRuleAction;
2593
+ /** Alias for EvaluationRuleActionUnion */
2594
+ export type EvaluationRuleActionUnion = ContinuousEvaluationRuleAction | HumanEvaluationRuleAction | EvaluationRuleAction;
2595
+ export declare function evaluationRuleActionUnionSerializer(item: EvaluationRuleActionUnion): any;
2596
+ export declare function evaluationRuleActionUnionDeserializer(item: any): EvaluationRuleActionUnion;
2597
+ /** Type of the evaluation action. */
2598
+ export type EvaluationRuleActionType = "continuousEvaluation" | "humanEvaluation";
2599
+ /** Evaluation rule action for continuous evaluation. */
2600
+ export interface ContinuousEvaluationRuleAction extends EvaluationRuleAction {
2601
+ type: "continuousEvaluation";
2602
+ /** Eval Id to add continuous evaluation runs to. */
2603
+ evalId: string;
2604
+ /** Maximum number of evaluation runs allowed per hour. */
2605
+ maxHourlyRuns?: number;
2606
+ }
2607
+ export declare function continuousEvaluationRuleActionSerializer(item: ContinuousEvaluationRuleAction): any;
2608
+ export declare function continuousEvaluationRuleActionDeserializer(item: any): ContinuousEvaluationRuleAction;
2609
+ /** Evaluation rule action for human evaluation. */
2610
+ export interface HumanEvaluationRuleAction extends EvaluationRuleAction {
2611
+ type: "humanEvaluation";
2612
+ /** Human evaluation template Id. */
2613
+ templateId: string;
2614
+ }
2615
+ export declare function humanEvaluationRuleActionSerializer(item: HumanEvaluationRuleAction): any;
2616
+ export declare function humanEvaluationRuleActionDeserializer(item: any): HumanEvaluationRuleAction;
2617
+ /** Evaluation filter model. */
2618
+ export interface EvaluationRuleFilter {
2619
+ /** Filter by agent name. */
2620
+ agentName: string;
2621
+ }
2622
+ export declare function evaluationRuleFilterSerializer(item: EvaluationRuleFilter): any;
2623
+ export declare function evaluationRuleFilterDeserializer(item: any): EvaluationRuleFilter;
2624
+ /** Type of the evaluation rule event. */
2625
+ export type EvaluationRuleEventType = "responseCompleted" | "manual";
2626
+ /** Paged collection of EvaluationRule items */
2627
+ export interface _PagedEvaluationRule {
2628
+ /** The EvaluationRule items on this page */
2629
+ value: EvaluationRule[];
2630
+ /** The link to the next page of items */
2631
+ nextLink?: string;
2632
+ }
2633
+ export declare function _pagedEvaluationRuleDeserializer(item: any): _PagedEvaluationRule;
2634
+ export declare function evaluationRuleArraySerializer(result: Array<EvaluationRule>): any[];
2635
+ export declare function evaluationRuleArrayDeserializer(result: Array<EvaluationRule>): any[];
2636
+ /** Evaluation Taxonomy Definition */
2637
+ export interface EvaluationTaxonomy {
2638
+ /** Asset ID, a unique identifier for the asset */
2639
+ readonly id?: string;
2640
+ /** The name of the resource */
2641
+ readonly name: string;
2642
+ /** The version of the resource */
2643
+ readonly version: string;
2644
+ /** The asset description text. */
2645
+ description?: string;
2646
+ /** Tag dictionary. Tags can be added, removed, and updated. */
2647
+ tags?: Record<string, string>;
2648
+ /** Input configuration for the evaluation taxonomy. */
2649
+ taxonomyInput: EvaluationTaxonomyInputUnion;
2650
+ /** List of taxonomy categories. */
2651
+ taxonomyCategories?: TaxonomyCategory[];
2652
+ /** Additional properties for the evaluation taxonomy. */
2653
+ properties?: Record<string, string>;
2654
+ }
2655
+ export declare function evaluationTaxonomySerializer(item: EvaluationTaxonomy): any;
2656
+ export declare function evaluationTaxonomyDeserializer(item: any): EvaluationTaxonomy;
2657
+ /** Input configuration for the evaluation taxonomy. */
2658
+ export interface EvaluationTaxonomyInput {
2659
+ /** Input type of the evaluation taxonomy. */
2660
+ /** The discriminator possible values: agent */
2661
+ type: EvaluationTaxonomyInputType;
2662
+ }
2663
+ export declare function evaluationTaxonomyInputSerializer(item: EvaluationTaxonomyInput): any;
2664
+ export declare function evaluationTaxonomyInputDeserializer(item: any): EvaluationTaxonomyInput;
2665
+ /** Alias for EvaluationTaxonomyInputUnion */
2666
+ export type EvaluationTaxonomyInputUnion = AgentTaxonomyInput | EvaluationTaxonomyInput;
2667
+ export declare function evaluationTaxonomyInputUnionSerializer(item: EvaluationTaxonomyInputUnion): any;
2668
+ export declare function evaluationTaxonomyInputUnionDeserializer(item: any): EvaluationTaxonomyInputUnion;
2669
+ /** Type of the evaluation taxonomy input. */
2670
+ export type EvaluationTaxonomyInputType = "agent" | "policy";
2671
+ /** Input configuration for the evaluation taxonomy when the input type is agent. */
2672
+ export interface AgentTaxonomyInput extends EvaluationTaxonomyInput {
2673
+ /** Input type of the evaluation taxonomy. */
2674
+ type: "agent";
2675
+ /** Target configuration for the agent. */
2676
+ target: AzureAIAgentTarget;
2677
+ /** List of risk categories to evaluate against. */
2678
+ riskCategories: RiskCategory[];
2679
+ }
2680
+ export declare function agentTaxonomyInputSerializer(item: AgentTaxonomyInput): any;
2681
+ export declare function agentTaxonomyInputDeserializer(item: any): AgentTaxonomyInput;
2682
+ /** Represents a target specifying an Azure AI agent. */
2683
+ export interface AzureAIAgentTarget extends Target {
2684
+ /** The type of target, always `azure_ai_agent`. */
2685
+ type: "azure_ai_agent";
2686
+ /** The unique identifier of the Azure AI agent. */
2687
+ name: string;
2688
+ /** The version of the Azure AI agent. */
2689
+ version?: string;
2690
+ /** The parameters used to control the sampling behavior of the agent during text generation. */
2691
+ tool_descriptions?: ToolDescription[];
2692
+ }
2693
+ export declare function azureAIAgentTargetSerializer(item: AzureAIAgentTarget): any;
2694
+ export declare function azureAIAgentTargetDeserializer(item: any): AzureAIAgentTarget;
2695
+ export declare function toolDescriptionArraySerializer(result: Array<ToolDescription>): any[];
2696
+ export declare function toolDescriptionArrayDeserializer(result: Array<ToolDescription>): any[];
2697
+ /** Description of a tool that can be used by an agent. */
2698
+ export interface ToolDescription {
2699
+ /** The name of the tool. */
2700
+ name?: string;
2701
+ /** A brief description of the tool's purpose. */
2702
+ description?: string;
2703
+ }
2704
+ export declare function toolDescriptionSerializer(item: ToolDescription): any;
2705
+ export declare function toolDescriptionDeserializer(item: any): ToolDescription;
2706
+ export declare function taxonomyCategoryArraySerializer(result: Array<TaxonomyCategory>): any[];
2707
+ export declare function taxonomyCategoryArrayDeserializer(result: Array<TaxonomyCategory>): any[];
2708
+ /** Taxonomy category definition. */
2709
+ export interface TaxonomyCategory {
2710
+ /** Unique identifier of the taxonomy category. */
2711
+ id: string;
2712
+ /** Name of the taxonomy category. */
2713
+ name: string;
2714
+ /** Description of the taxonomy category. */
2715
+ description?: string;
2716
+ /** Risk category associated with this taxonomy category. */
2717
+ riskCategory: RiskCategory;
2718
+ /** List of taxonomy sub categories. */
2719
+ subCategories: TaxonomySubCategory[];
2720
+ /** Additional properties for the taxonomy category. */
2721
+ properties?: Record<string, string>;
2722
+ }
2723
+ export declare function taxonomyCategorySerializer(item: TaxonomyCategory): any;
2724
+ export declare function taxonomyCategoryDeserializer(item: any): TaxonomyCategory;
2725
+ export declare function taxonomySubCategoryArraySerializer(result: Array<TaxonomySubCategory>): any[];
2726
+ export declare function taxonomySubCategoryArrayDeserializer(result: Array<TaxonomySubCategory>): any[];
2727
+ /** Taxonomy sub-category definition. */
2728
+ export interface TaxonomySubCategory {
2729
+ /** Unique identifier of the taxonomy sub-category. */
2730
+ id: string;
2731
+ /** Name of the taxonomy sub-category. */
2732
+ name: string;
2733
+ /** Description of the taxonomy sub-category. */
2734
+ description?: string;
2735
+ /** List of taxonomy items under this sub-category. */
2736
+ enabled: boolean;
2737
+ /** Additional properties for the taxonomy sub-category. */
2738
+ properties?: Record<string, string>;
2739
+ }
2740
+ export declare function taxonomySubCategorySerializer(item: TaxonomySubCategory): any;
2741
+ export declare function taxonomySubCategoryDeserializer(item: any): TaxonomySubCategory;
2742
+ /** Base class for targets with discriminator support. */
2743
+ export interface Target {
2744
+ /** The type of target. */
2745
+ /** The discriminator possible values: azure_ai_model, azure_ai_agent, azure_ai_assistant */
2746
+ type: string;
2747
+ }
2748
+ export declare function targetSerializer(item: Target): any;
2749
+ export declare function targetDeserializer(item: any): Target;
2750
+ /** Alias for TargetUnion */
2751
+ export type TargetUnion = AzureAIAgentTarget | Target;
2752
+ export declare function targetUnionSerializer(item: TargetUnion): any;
2753
+ export declare function targetUnionDeserializer(item: any): TargetUnion;
2754
+ /** Paged collection of EvaluationTaxonomy items */
2755
+ export interface _PagedEvaluationTaxonomy {
2756
+ /** The EvaluationTaxonomy items on this page */
2757
+ value: EvaluationTaxonomy[];
2758
+ /** The link to the next page of items */
2759
+ nextLink?: string;
2760
+ }
2761
+ export declare function _pagedEvaluationTaxonomyDeserializer(item: any): _PagedEvaluationTaxonomy;
2762
+ export declare function evaluationTaxonomyArraySerializer(result: Array<EvaluationTaxonomy>): any[];
2763
+ export declare function evaluationTaxonomyArrayDeserializer(result: Array<EvaluationTaxonomy>): any[];
2764
+ /** Paged collection of EvaluatorVersion items */
2765
+ export interface _PagedEvaluatorVersion {
2766
+ /** The EvaluatorVersion items on this page */
2767
+ value: EvaluatorVersion[];
2768
+ /** The link to the next page of items */
2769
+ nextLink?: string;
2770
+ }
2771
+ export declare function _pagedEvaluatorVersionDeserializer(item: any): _PagedEvaluatorVersion;
2772
+ export declare function evaluatorVersionArraySerializer(result: Array<EvaluatorVersion>): any[];
2773
+ export declare function evaluatorVersionArrayDeserializer(result: Array<EvaluatorVersion>): any[];
2774
+ /** Evaluator Definition */
2775
+ export interface EvaluatorVersion {
2776
+ /** Display Name for evaluator. It helps to find the evaluator easily in Microsoft Foundry. It does not need to be unique. */
2777
+ display_name?: string;
2778
+ /** Metadata about the evaluator */
2779
+ metadata?: Record<string, string>;
2780
+ /** The type of the evaluator */
2781
+ evaluator_type: EvaluatorType;
2782
+ /** The categories of the evaluator */
2783
+ categories: EvaluatorCategory[];
2784
+ /** Definition of the evaluator */
2785
+ definition: EvaluatorDefinitionUnion;
2786
+ /** Creator of the evaluator */
2787
+ readonly created_by: string;
2788
+ /** Creation date/time of the evaluator */
2789
+ readonly created_at: number;
2790
+ /** Last modified date/time of the evaluator */
2791
+ readonly modified_at: number;
2792
+ /** Asset ID, a unique identifier for the asset */
2793
+ readonly id?: string;
2794
+ /** The name of the resource */
2795
+ readonly name: string;
2796
+ /** The version of the resource */
2797
+ readonly version: string;
2798
+ /** The asset description text. */
2799
+ description?: string;
2800
+ /** Tag dictionary. Tags can be added, removed, and updated. */
2801
+ tags?: Record<string, string>;
2802
+ }
2803
+ export declare function evaluatorVersionSerializer(item: EvaluatorVersion): any;
2804
+ export declare function evaluatorVersionDeserializer(item: any): EvaluatorVersion;
2805
+ /** The type of the evaluator */
2806
+ export type EvaluatorType = "builtin" | "custom";
2807
+ /** The category of the evaluator */
2808
+ export type EvaluatorCategory = "quality" | "safety" | "agents";
2809
+ /** Base evaluator configuration with discriminator */
2810
+ export interface EvaluatorDefinition {
2811
+ /** The type of evaluator definition */
2812
+ /** The discriminator possible values: code, prompt */
2813
+ type: EvaluatorDefinitionType;
2814
+ /** The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. */
2815
+ init_parameters?: unknown;
2816
+ /** The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. */
2817
+ data_schema?: unknown;
2818
+ /** List of output metrics produced by this evaluator */
2819
+ metrics?: Record<string, EvaluatorMetric>;
2820
+ }
2821
+ export declare function evaluatorDefinitionSerializer(item: EvaluatorDefinition): any;
2822
+ export declare function evaluatorDefinitionDeserializer(item: any): EvaluatorDefinition;
2823
+ /** Alias for EvaluatorDefinitionUnion */
2824
+ export type EvaluatorDefinitionUnion = CodeBasedEvaluatorDefinition | PromptBasedEvaluatorDefinition | EvaluatorDefinition;
2825
+ export declare function evaluatorDefinitionUnionSerializer(item: EvaluatorDefinitionUnion): any;
2826
+ export declare function evaluatorDefinitionUnionDeserializer(item: any): EvaluatorDefinitionUnion;
2827
+ /** The type of evaluator definition */
2828
+ export type EvaluatorDefinitionType = "prompt" | "code" | "prompt_and_code" | "service" | "openai_graders";
2829
+ export declare function evaluatorMetricRecordSerializer(item: Record<string, EvaluatorMetric>): Record<string, any>;
2830
+ export declare function evaluatorMetricRecordDeserializer(item: Record<string, any>): Record<string, EvaluatorMetric>;
2831
+ /** Evaluator Metric */
2832
+ export interface EvaluatorMetric {
2833
+ /** Type of the metric. */
2834
+ type?: EvaluatorMetricType;
2835
+ /** It indicates whether a higher value is better or a lower value is better for this metric. */
2836
+ desirable_direction?: EvaluatorMetricDirection;
2837
+ /** Minimum value for the metric */
2838
+ min_value?: number;
2839
+ /** Maximum value for the metric. If not specified, it is assumed to be unbounded. */
2840
+ max_value?: number;
2841
+ /** Indicates if this metric is primary when there are multiple metrics. */
2842
+ is_primary?: boolean;
2843
+ }
2844
+ export declare function evaluatorMetricSerializer(item: EvaluatorMetric): any;
2845
+ export declare function evaluatorMetricDeserializer(item: any): EvaluatorMetric;
2846
+ /** The type of the evaluator */
2847
+ export type EvaluatorMetricType = "ordinal" | "continuous" | "boolean";
2848
+ /** The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral */
2849
+ export type EvaluatorMetricDirection = "increase" | "decrease" | "neutral";
2850
+ /** Code-based evaluator definition using python code */
2851
+ export interface CodeBasedEvaluatorDefinition extends EvaluatorDefinition {
2852
+ type: "code";
2853
+ /** Inline code text for the evaluator */
2854
+ code_text: string;
2855
+ }
2856
+ export declare function codeBasedEvaluatorDefinitionSerializer(item: CodeBasedEvaluatorDefinition): any;
2857
+ export declare function codeBasedEvaluatorDefinitionDeserializer(item: any): CodeBasedEvaluatorDefinition;
2858
+ /** Prompt-based evaluator */
2859
+ export interface PromptBasedEvaluatorDefinition extends EvaluatorDefinition {
2860
+ type: "prompt";
2861
+ /** The prompt text used for evaluation */
2862
+ prompt_text: string;
2863
+ }
2864
+ export declare function promptBasedEvaluatorDefinitionSerializer(item: PromptBasedEvaluatorDefinition): any;
2865
+ export declare function promptBasedEvaluatorDefinitionDeserializer(item: any): PromptBasedEvaluatorDefinition;
2866
+ /** The response body for cluster insights. */
2867
+ export interface Insight {
2868
+ /** The unique identifier for the insights report. */
2869
+ readonly id: string;
2870
+ /** Metadata about the insights report. */
2871
+ readonly metadata: InsightsMetadata;
2872
+ /** The current state of the insights. */
2873
+ readonly state: OperationState;
2874
+ /** User friendly display name for the insight. */
2875
+ displayName: string;
2876
+ /** Request for the insights analysis. */
2877
+ request: InsightRequestUnion;
2878
+ /** The result of the insights report. */
2879
+ readonly result?: InsightResultUnion;
2880
+ }
2881
+ export declare function insightSerializer(item: Insight): any;
2882
+ export declare function insightDeserializer(item: any): Insight;
2883
+ /** Metadata about the insights. */
2884
+ export interface InsightsMetadata {
2885
+ /** The timestamp when the insights were created. */
2886
+ createdAt: Date;
2887
+ /** The timestamp when the insights were completed. */
2888
+ completedAt?: Date;
2889
+ }
2890
+ export declare function insightsMetadataDeserializer(item: any): InsightsMetadata;
2891
+ /** Enum describing allowed operation states. */
2892
+ export type OperationState = "NotStarted" | "Running" | "Succeeded" | "Failed" | "Canceled";
2893
+ /** The request of the insights report. */
2894
+ export interface InsightRequest {
2895
+ /** The type of request. */
2896
+ /** The discriminator possible values: EvaluationRunClusterInsight, AgentClusterInsight, EvaluationComparison */
2897
+ type: InsightType;
2898
+ }
2899
+ export declare function insightRequestSerializer(item: InsightRequest): any;
2900
+ export declare function insightRequestDeserializer(item: any): InsightRequest;
2901
+ /** Alias for InsightRequestUnion */
2902
+ export type InsightRequestUnion = EvaluationRunClusterInsightsRequest | AgentClusterInsightsRequest | EvaluationComparisonRequest | InsightRequest;
2903
+ export declare function insightRequestUnionSerializer(item: InsightRequestUnion): any;
2904
+ export declare function insightRequestUnionDeserializer(item: any): InsightRequestUnion;
2905
+ /** The request of the insights. */
2906
+ export type InsightType = "EvaluationRunClusterInsight" | "AgentClusterInsight" | "EvaluationComparison";
2907
+ /** Insights on set of Evaluation Results */
2908
+ export interface EvaluationRunClusterInsightsRequest extends InsightRequest {
2909
+ /** The type of insights request. */
2910
+ type: "EvaluationRunClusterInsight";
2911
+ /** Evaluation Id for the insights. */
2912
+ evalId: string;
2913
+ /** List of evaluation run IDs for the insights. */
2914
+ runIds: string[];
2915
+ /** Configuration of the model used in the insight generation. */
2916
+ modelConfiguration?: InsightModelConfiguration;
2917
+ }
2918
+ export declare function evaluationRunClusterInsightsRequestSerializer(item: EvaluationRunClusterInsightsRequest): any;
2919
+ export declare function evaluationRunClusterInsightsRequestDeserializer(item: any): EvaluationRunClusterInsightsRequest;
2920
+ /** Configuration of the model used in the insight generation. */
2921
+ export interface InsightModelConfiguration {
2922
+ /** The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'. */
2923
+ modelDeploymentName: string;
2924
+ }
2925
+ export declare function insightModelConfigurationSerializer(item: InsightModelConfiguration): any;
2926
+ export declare function insightModelConfigurationDeserializer(item: any): InsightModelConfiguration;
2927
+ /** Insights on set of Agent Evaluation Results */
2928
+ export interface AgentClusterInsightsRequest extends InsightRequest {
2929
+ /** The type of request. */
2930
+ type: "AgentClusterInsight";
2931
+ /** Identifier for the agent. */
2932
+ agentName: string;
2933
+ /** Configuration of the model used in the insight generation. */
2934
+ modelConfiguration?: InsightModelConfiguration;
2935
+ }
2936
+ export declare function agentClusterInsightsRequestSerializer(item: AgentClusterInsightsRequest): any;
2937
+ export declare function agentClusterInsightsRequestDeserializer(item: any): AgentClusterInsightsRequest;
2938
+ /** Evaluation Comparison Request */
2939
+ export interface EvaluationComparisonRequest extends InsightRequest {
2940
+ /** The type of request. */
2941
+ type: "EvaluationComparison";
2942
+ /** Identifier for the evaluation. */
2943
+ evalId: string;
2944
+ /** The baseline run ID for comparison. */
2945
+ baselineRunId: string;
2946
+ /** List of treatment run IDs for comparison. */
2947
+ treatmentRunIds: string[];
2948
+ }
2949
+ export declare function evaluationComparisonRequestSerializer(item: EvaluationComparisonRequest): any;
2950
+ export declare function evaluationComparisonRequestDeserializer(item: any): EvaluationComparisonRequest;
2951
+ /** The result of the insights. */
2952
+ export interface InsightResult {
2953
+ /** The type of insights result. */
2954
+ /** The discriminator possible values: EvaluationComparison, EvaluationRunClusterInsight, AgentClusterInsight */
2955
+ type: InsightType;
2956
+ }
2957
+ export declare function insightResultDeserializer(item: any): InsightResult;
2958
+ /** Alias for InsightResultUnion */
2959
+ export type InsightResultUnion = EvalCompareReport | EvaluationRunClusterInsightResult | AgentClusterInsightResult | InsightResult;
2960
+ export declare function insightResultUnionDeserializer(item: any): InsightResultUnion;
2961
+ /** Insights from the evaluation comparison. */
2962
+ export interface EvalCompareReport extends InsightResult {
2963
+ /** The type of insights result. */
2964
+ type: "EvaluationComparison";
2965
+ /** Comparison results for each treatment run against the baseline. */
2966
+ comparisons: EvalRunResultComparison[];
2967
+ /** The statistical method used for comparison. */
2968
+ method: string;
2969
+ }
2970
+ export declare function evalCompareReportDeserializer(item: any): EvalCompareReport;
2971
+ export declare function evalRunResultComparisonArrayDeserializer(result: Array<EvalRunResultComparison>): any[];
2972
+ /** Comparison results for treatment runs against the baseline. */
2973
+ export interface EvalRunResultComparison {
2974
+ /** Name of the testing criteria. */
2975
+ testingCriteria: string;
2976
+ /** Metric being evaluated. */
2977
+ metric: string;
2978
+ /** Name of the evaluator for this testing criteria. */
2979
+ evaluator: string;
2980
+ /** Summary statistics of the baseline run. */
2981
+ baselineRunSummary: EvalRunResultSummary;
2982
+ /** List of comparison results for each treatment run. */
2983
+ compareItems: EvalRunResultCompareItem[];
2984
+ }
2985
+ export declare function evalRunResultComparisonDeserializer(item: any): EvalRunResultComparison;
2986
+ /** Summary statistics of a metric in an evaluation run. */
2987
+ export interface EvalRunResultSummary {
2988
+ /** The evaluation run ID. */
2989
+ runId: string;
2990
+ /** Number of samples in the evaluation run. */
2991
+ sampleCount: number;
2992
+ /** Average value of the metric in the evaluation run. */
2993
+ average: number;
2994
+ /** Standard deviation of the metric in the evaluation run. */
2995
+ standardDeviation: number;
2996
+ }
2997
+ export declare function evalRunResultSummaryDeserializer(item: any): EvalRunResultSummary;
2998
+ export declare function evalRunResultCompareItemArrayDeserializer(result: Array<EvalRunResultCompareItem>): any[];
2999
+ /** Metric comparison for a treatment against the baseline. */
3000
+ export interface EvalRunResultCompareItem {
3001
+ /** The treatment run ID. */
3002
+ treatmentRunId: string;
3003
+ /** Summary statistics of the treatment run. */
3004
+ treatmentRunSummary: EvalRunResultSummary;
3005
+ /** Estimated difference between treatment and baseline. */
3006
+ deltaEstimate: number;
3007
+ /** P-value for the treatment effect. */
3008
+ pValue: number;
3009
+ /** Type of treatment effect. */
3010
+ treatmentEffect: TreatmentEffectType;
3011
+ }
3012
+ export declare function evalRunResultCompareItemDeserializer(item: any): EvalRunResultCompareItem;
3013
+ /** Treatment Effect Type. */
3014
+ export type TreatmentEffectType = "TooFewSamples" | "Inconclusive" | "Changed" | "Improved" | "Degraded";
3015
+ /** Insights from the evaluation run cluster analysis. */
3016
+ export interface EvaluationRunClusterInsightResult extends InsightResult {
3017
+ /** The type of insights result. */
3018
+ type: "EvaluationRunClusterInsight";
3019
+ clusterInsight: ClusterInsightResult;
3020
+ }
3021
+ export declare function evaluationRunClusterInsightResultDeserializer(item: any): EvaluationRunClusterInsightResult;
3022
+ /** Insights from the cluster analysis. */
3023
+ export interface ClusterInsightResult {
3024
+ /** Summary of the insights report. */
3025
+ summary: InsightSummary;
3026
+ /** List of clusters identified in the insights. */
3027
+ clusters: InsightCluster[];
3028
+ /**
3029
+ * Optional mapping of IDs to 2D coordinates used by the UX for visualization.
3030
+ *
3031
+ * The map keys are string identifiers (for example, a cluster id or a sample id)
3032
+ * and the values are the coordinates and visual size for rendering on a 2D chart.
3033
+ *
3034
+ * This property is omitted unless the client requests coordinates (for example,
3035
+ * by passing `includeCoordinates=true` as a query parameter).
3036
+ *
3037
+ * Example:
3038
+ * ```
3039
+ * {
3040
+ * "cluster-1": { "x": 12, "y": 34, "size": 8 },
3041
+ * "sample-123": { "x": 18, "y": 22, "size": 4 }
3042
+ * }
3043
+ * ```
3044
+ *
3045
+ * Coordinates are intended only for client-side visualization and do not
3046
+ * modify the canonical insights results.
3047
+ */
3048
+ coordinates?: Record<string, ChartCoordinate>;
3049
+ }
3050
+ export declare function clusterInsightResultDeserializer(item: any): ClusterInsightResult;
3051
+ /** Summary of the error cluster analysis. */
3052
+ export interface InsightSummary {
3053
+ /** Total number of samples analyzed. */
3054
+ sampleCount: number;
3055
+ /** Total number of unique subcluster labels. */
3056
+ uniqueSubclusterCount: number;
3057
+ /** Total number of unique clusters. */
3058
+ uniqueClusterCount: number;
3059
+ /** Method used for clustering. */
3060
+ method: string;
3061
+ /** Token usage while performing clustering analysis */
3062
+ usage: ClusterTokenUsage;
3063
+ }
3064
+ export declare function insightSummaryDeserializer(item: any): InsightSummary;
3065
+ /** Token usage for cluster analysis */
3066
+ export interface ClusterTokenUsage {
3067
+ /** input token usage */
3068
+ inputTokenUsage: number;
3069
+ /** output token usage */
3070
+ outputTokenUsage: number;
3071
+ /** total token usage */
3072
+ totalTokenUsage: number;
3073
+ }
3074
+ export declare function clusterTokenUsageDeserializer(item: any): ClusterTokenUsage;
3075
+ export declare function insightClusterArrayDeserializer(result: Array<InsightCluster>): any[];
3076
+ /** A cluster of analysis samples. */
3077
+ export interface InsightCluster {
3078
+ /** The id of the analysis cluster. */
3079
+ id: string;
3080
+ /** Label for the cluster */
3081
+ label: string;
3082
+ /** Suggestion for the cluster */
3083
+ suggestion: string;
3084
+ /** The title of the suggestion for the cluster */
3085
+ suggestionTitle: string;
3086
+ /** Description of the analysis cluster. */
3087
+ description: string;
3088
+ /** The weight of the analysis cluster. This indicate number of samples in the cluster. */
3089
+ weight: number;
3090
+ /** List of subclusters within this cluster. Empty if no subclusters exist. */
3091
+ subClusters?: InsightCluster[];
3092
+ /** List of samples that belong to this cluster. Empty if samples are part of subclusters. */
3093
+ samples?: InsightSampleUnion[];
3094
+ }
3095
+ export declare function insightClusterDeserializer(item: any): InsightCluster;
3096
+ export declare function insightSampleUnionArrayDeserializer(result: Array<InsightSampleUnion>): any[];
3097
+ /** A sample from the analysis. */
3098
+ export interface InsightSample {
3099
+ /** The unique identifier for the analysis sample. */
3100
+ id: string;
3101
+ /** Sample type */
3102
+ /** The discriminator possible values: EvaluationResultSample */
3103
+ type: SampleType;
3104
+ /** Features to help with additional filtering of data in UX. */
3105
+ features: Record<string, any>;
3106
+ /** Info about the correlation for the analysis sample. */
3107
+ correlationInfo: Record<string, any>;
3108
+ }
3109
+ export declare function insightSampleDeserializer(item: any): InsightSample;
3110
+ /** Alias for InsightSampleUnion */
3111
+ export type InsightSampleUnion = EvaluationResultSample | InsightSample;
3112
+ export declare function insightSampleUnionDeserializer(item: any): InsightSampleUnion;
3113
+ /** The type of sample used in the analysis. */
3114
+ export type SampleType = "EvaluationResultSample";
3115
+ /** A sample from the evaluation result. */
3116
+ export interface EvaluationResultSample extends InsightSample {
3117
+ /** Evaluation Result Sample Type */
3118
+ type: "EvaluationResultSample";
3119
+ /** Evaluation result for the analysis sample. */
3120
+ evaluationResult: EvalResult;
3121
+ }
3122
+ export declare function evaluationResultSampleDeserializer(item: any): EvaluationResultSample;
3123
+ /** Result of the evaluation. */
3124
+ export interface EvalResult {
3125
+ /** name of the check */
3126
+ name: string;
3127
+ /** type of the check */
3128
+ type: string;
3129
+ /** score */
3130
+ score: number;
3131
+ /** indicates if the check passed or failed */
3132
+ passed: boolean;
3133
+ }
3134
+ export declare function evalResultDeserializer(item: any): EvalResult;
3135
+ export declare function chartCoordinateRecordDeserializer(item: Record<string, any>): Record<string, ChartCoordinate>;
3136
+ /** Coordinates for the analysis chart. */
3137
+ export interface ChartCoordinate {
3138
+ /** X-axis coordinate. */
3139
+ x: number;
3140
+ /** Y-axis coordinate. */
3141
+ y: number;
3142
+ /** Size of the chart element. */
3143
+ size: number;
3144
+ }
3145
+ export declare function chartCoordinateDeserializer(item: any): ChartCoordinate;
3146
+ /** Insights from the agent cluster analysis. */
3147
+ export interface AgentClusterInsightResult extends InsightResult {
3148
+ /** The type of insights result. */
3149
+ type: "AgentClusterInsight";
3150
+ clusterInsight: ClusterInsightResult;
3151
+ }
3152
+ export declare function agentClusterInsightResultDeserializer(item: any): AgentClusterInsightResult;
3153
+ /** Paged collection of Insight items */
3154
+ export interface _PagedInsight {
3155
+ /** The Insight items on this page */
3156
+ value: Insight[];
3157
+ /** The link to the next page of items */
3158
+ nextLink?: string;
3159
+ }
3160
+ export declare function _pagedInsightDeserializer(item: any): _PagedInsight;
3161
+ export declare function insightArraySerializer(result: Array<Insight>): any[];
3162
+ export declare function insightArrayDeserializer(result: Array<Insight>): any[];
3163
+ /** Schedule model. */
3164
+ export interface Schedule {
3165
+ /** Identifier of the schedule. */
3166
+ readonly id: string;
3167
+ /** Name of the schedule. */
3168
+ displayName?: string;
3169
+ /** Description of the schedule. */
3170
+ description?: string;
3171
+ /** Enabled status of the schedule. */
3172
+ enabled: boolean;
3173
+ /** Provisioning status of the schedule. */
3174
+ readonly provisioningStatus?: ScheduleProvisioningStatus;
3175
+ /** Trigger for the schedule. */
3176
+ trigger: TriggerUnion;
3177
+ /** Task for the schedule. */
3178
+ task: ScheduleTaskUnion;
3179
+ /** Schedule's tags. Unlike properties, tags are fully mutable. */
3180
+ tags?: Record<string, string>;
3181
+ /** Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. */
3182
+ properties?: Record<string, string>;
3183
+ /** System metadata for the resource. */
3184
+ readonly systemData: Record<string, string>;
3185
+ }
3186
+ export declare function scheduleSerializer(item: Schedule): any;
3187
+ export declare function scheduleDeserializer(item: any): Schedule;
3188
+ /** Schedule provisioning status. */
3189
+ export type ScheduleProvisioningStatus = "Creating" | "Updating" | "Deleting" | "Succeeded" | "Failed";
3190
+ /** Base model for Trigger of the schedule. */
3191
+ export interface Trigger {
3192
+ /** Type of the trigger. */
3193
+ /** The discriminator possible values: Cron, Recurrence, OneTime */
3194
+ type: TriggerType;
3195
+ }
3196
+ export declare function triggerSerializer(item: Trigger): any;
3197
+ export declare function triggerDeserializer(item: any): Trigger;
3198
+ /** Alias for TriggerUnion */
3199
+ export type TriggerUnion = CronTrigger | RecurrenceTrigger | OneTimeTrigger | Trigger;
3200
+ export declare function triggerUnionSerializer(item: TriggerUnion): any;
3201
+ export declare function triggerUnionDeserializer(item: any): TriggerUnion;
3202
+ /** Type of the trigger. */
3203
+ export type TriggerType = "Cron" | "Recurrence" | "OneTime";
3204
+ /** Cron based trigger. */
3205
+ export interface CronTrigger extends Trigger {
3206
+ type: "Cron";
3207
+ /** Cron expression that defines the schedule frequency. */
3208
+ expression: string;
3209
+ /** Time zone for the cron schedule. */
3210
+ timeZone?: string;
3211
+ /** Start time for the cron schedule in ISO 8601 format. */
3212
+ startTime?: string;
3213
+ /** End time for the cron schedule in ISO 8601 format. */
3214
+ endTime?: string;
3215
+ }
3216
+ export declare function cronTriggerSerializer(item: CronTrigger): any;
3217
+ export declare function cronTriggerDeserializer(item: any): CronTrigger;
3218
+ /** Recurrence based trigger. */
3219
+ export interface RecurrenceTrigger extends Trigger {
3220
+ /** Type of the trigger. */
3221
+ type: "Recurrence";
3222
+ /** Start time for the recurrence schedule in ISO 8601 format. */
3223
+ startTime?: string;
3224
+ /** End time for the recurrence schedule in ISO 8601 format. */
3225
+ endTime?: string;
3226
+ /** Time zone for the recurrence schedule. */
3227
+ timeZone?: string;
3228
+ /** Interval for the recurrence schedule. */
3229
+ interval: number;
3230
+ /** Recurrence schedule for the recurrence trigger. */
3231
+ schedule: RecurrenceScheduleUnion;
3232
+ }
3233
+ export declare function recurrenceTriggerSerializer(item: RecurrenceTrigger): any;
3234
+ export declare function recurrenceTriggerDeserializer(item: any): RecurrenceTrigger;
3235
+ /** Recurrence schedule model. */
3236
+ export interface RecurrenceSchedule {
3237
+ /** Recurrence type for the recurrence schedule. */
3238
+ /** The discriminator possible values: Hourly, Daily, Weekly, Monthly */
3239
+ type: RecurrenceType;
3240
+ }
3241
+ export declare function recurrenceScheduleSerializer(item: RecurrenceSchedule): any;
3242
+ export declare function recurrenceScheduleDeserializer(item: any): RecurrenceSchedule;
3243
+ /** Alias for RecurrenceScheduleUnion */
3244
+ export type RecurrenceScheduleUnion = HourlyRecurrenceSchedule | DailyRecurrenceSchedule | WeeklyRecurrenceSchedule | MonthlyRecurrenceSchedule | RecurrenceSchedule;
3245
+ export declare function recurrenceScheduleUnionSerializer(item: RecurrenceScheduleUnion): any;
3246
+ export declare function recurrenceScheduleUnionDeserializer(item: any): RecurrenceScheduleUnion;
3247
+ /** Recurrence type. */
3248
+ export type RecurrenceType = "Hourly" | "Daily" | "Weekly" | "Monthly";
3249
+ /** Hourly recurrence schedule. */
3250
+ export interface HourlyRecurrenceSchedule extends RecurrenceSchedule {
3251
+ type: "Hourly";
3252
+ }
3253
+ export declare function hourlyRecurrenceScheduleSerializer(item: HourlyRecurrenceSchedule): any;
3254
+ export declare function hourlyRecurrenceScheduleDeserializer(item: any): HourlyRecurrenceSchedule;
3255
+ /** Daily recurrence schedule. */
3256
+ export interface DailyRecurrenceSchedule extends RecurrenceSchedule {
3257
+ /** Daily recurrence type. */
3258
+ type: "Daily";
3259
+ /** Hours for the recurrence schedule. */
3260
+ hours: number[];
3261
+ }
3262
+ export declare function dailyRecurrenceScheduleSerializer(item: DailyRecurrenceSchedule): any;
3263
+ export declare function dailyRecurrenceScheduleDeserializer(item: any): DailyRecurrenceSchedule;
3264
+ /** Weekly recurrence schedule. */
3265
+ export interface WeeklyRecurrenceSchedule extends RecurrenceSchedule {
3266
+ /** Weekly recurrence type. */
3267
+ type: "Weekly";
3268
+ /** Days of the week for the recurrence schedule. */
3269
+ daysOfWeek: DayOfWeek[];
3270
+ }
3271
+ export declare function weeklyRecurrenceScheduleSerializer(item: WeeklyRecurrenceSchedule): any;
3272
+ export declare function weeklyRecurrenceScheduleDeserializer(item: any): WeeklyRecurrenceSchedule;
3273
+ /** Days of the week for recurrence schedule. */
3274
+ export type DayOfWeek = "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday";
3275
+ /** Monthly recurrence schedule. */
3276
+ export interface MonthlyRecurrenceSchedule extends RecurrenceSchedule {
3277
+ /** Monthly recurrence type. */
3278
+ type: "Monthly";
3279
+ /** Days of the month for the recurrence schedule. */
3280
+ daysOfMonth: number[];
3281
+ }
3282
+ export declare function monthlyRecurrenceScheduleSerializer(item: MonthlyRecurrenceSchedule): any;
3283
+ export declare function monthlyRecurrenceScheduleDeserializer(item: any): MonthlyRecurrenceSchedule;
3284
+ /** One-time trigger. */
3285
+ export interface OneTimeTrigger extends Trigger {
3286
+ type: "OneTime";
3287
+ /** Date and time for the one-time trigger in ISO 8601 format. */
3288
+ triggerAt: string;
3289
+ /** Time zone for the one-time trigger. */
3290
+ timeZone?: string;
3291
+ }
3292
+ export declare function oneTimeTriggerSerializer(item: OneTimeTrigger): any;
3293
+ export declare function oneTimeTriggerDeserializer(item: any): OneTimeTrigger;
3294
+ /** Schedule task model. */
3295
+ export interface ScheduleTask {
3296
+ /** Type of the task. */
3297
+ /** The discriminator possible values: Evaluation, Insight */
3298
+ type: ScheduleTaskType;
3299
+ /** Configuration for the task. */
3300
+ configuration?: Record<string, string>;
3301
+ }
3302
+ export declare function scheduleTaskSerializer(item: ScheduleTask): any;
3303
+ export declare function scheduleTaskDeserializer(item: any): ScheduleTask;
3304
+ /** Alias for ScheduleTaskUnion */
3305
+ export type ScheduleTaskUnion = EvaluationScheduleTask | InsightScheduleTask | ScheduleTask;
3306
+ export declare function scheduleTaskUnionSerializer(item: ScheduleTaskUnion): any;
3307
+ export declare function scheduleTaskUnionDeserializer(item: any): ScheduleTaskUnion;
3308
+ /** Type of the task. */
3309
+ export type ScheduleTaskType = "Evaluation" | "Insight";
3310
+ /** Evaluation task for the schedule. */
3311
+ export interface EvaluationScheduleTask extends ScheduleTask {
3312
+ type: "Evaluation";
3313
+ /** Identifier of the evaluation group. */
3314
+ evalId: string;
3315
+ /** The evaluation run payload. */
3316
+ evalRun: Record<string, any>;
3317
+ }
3318
+ export declare function evaluationScheduleTaskSerializer(item: EvaluationScheduleTask): any;
3319
+ export declare function evaluationScheduleTaskDeserializer(item: any): EvaluationScheduleTask;
3320
+ /** model interface _EvaluationScheduleTaskEvalRun */
3321
+ export interface _EvaluationScheduleTaskEvalRun {
3322
+ }
3323
+ export declare function _evaluationScheduleTaskEvalRunSerializer(item: _EvaluationScheduleTaskEvalRun): any;
3324
+ export declare function _evaluationScheduleTaskEvalRunDeserializer(item: any): _EvaluationScheduleTaskEvalRun;
3325
+ /** Insight task for the schedule. */
3326
+ export interface InsightScheduleTask extends ScheduleTask {
3327
+ type: "Insight";
3328
+ /** The insight payload. */
3329
+ insight: Insight;
3330
+ }
3331
+ export declare function insightScheduleTaskSerializer(item: InsightScheduleTask): any;
3332
+ export declare function insightScheduleTaskDeserializer(item: any): InsightScheduleTask;
3333
+ /** Paged collection of Schedule items */
3334
+ export interface _PagedSchedule {
3335
+ /** The Schedule items on this page */
3336
+ value: Schedule[];
3337
+ /** The link to the next page of items */
3338
+ nextLink?: string;
3339
+ }
3340
+ export declare function _pagedScheduleDeserializer(item: any): _PagedSchedule;
3341
+ export declare function scheduleArraySerializer(result: Array<Schedule>): any[];
3342
+ export declare function scheduleArrayDeserializer(result: Array<Schedule>): any[];
3343
+ /** Schedule run model. */
3344
+ export interface ScheduleRun {
3345
+ /** Identifier of the schedule run. */
3346
+ readonly id: string;
3347
+ /** Identifier of the schedule. */
3348
+ scheduleId: string;
3349
+ /** Trigger success status of the schedule run. */
3350
+ readonly success: boolean;
3351
+ /** Trigger time of the schedule run. */
3352
+ triggerTime?: string;
3353
+ /** Error information for the schedule run. */
3354
+ readonly error?: string;
3355
+ /** Properties of the schedule run. */
3356
+ readonly properties: Record<string, string>;
3357
+ }
3358
+ export declare function scheduleRunDeserializer(item: any): ScheduleRun;
3359
+ /** Paged collection of ScheduleRun items */
3360
+ export interface PagedScheduleRun {
3361
+ /** The ScheduleRun items on this page */
3362
+ value: ScheduleRun[];
3363
+ /** The link to the next page of items */
3364
+ nextLink?: string;
3365
+ }
3366
+ export declare function pagedScheduleRunDeserializer(item: any): PagedScheduleRun;
3367
+ export declare function scheduleRunArrayDeserializer(result: Array<ScheduleRun>): any[];
3368
+ /** model interface AgentId */
3369
+ export interface AgentId {
3370
+ type: "agent_id";
3371
+ /** The name of the agent. */
3372
+ name: string;
3373
+ /** The version identifier of the agent. */
3374
+ version: string;
3375
+ }
3376
+ export declare function agentIdDeserializer(item: any): AgentId;
3377
+ /** Alias for _ResponseInstructions */
3378
+ export type _ResponseInstructions = string | ItemParamUnion[];
3379
+ /** model interface AgentReference */
3380
+ export interface AgentReference {
3381
+ type: "agent_reference";
3382
+ /** The name of the agent. */
3383
+ name: string;
3384
+ /** The version identifier of the agent. */
3385
+ version?: string;
3386
+ }
3387
+ export declare function agentReferenceSerializer(item: AgentReference): any;
3388
+ /** Alias for _ListVersionsRequestType */
3389
+ export type _ListVersionsRequestType = EvaluatorType | "all";
3390
+ export declare function _listVersionsRequestTypeSerializer(item: _ListVersionsRequestType): any;
332
3391
  /** The type of pending upload. */
333
3392
  export type PendingUploadType = "None" | "BlobReference";
334
3393
  /** Azure AI Projects API versions */
335
- export declare enum KnownVersions {
336
- /** Azure AI API version 2025-05-01. */
337
- V20250501 = "2025-05-01",
338
- /** Azure AI API version v1. */
339
- V1 = "v1"
3394
+ export declare enum KnownApiVersions {
3395
+ /** Azure AI API version 2025-11-15-preview. */
3396
+ v2025_11_15_preview = "2025-11-15-preview"
340
3397
  }
341
3398
  //# sourceMappingURL=models.d.ts.map