@takeshape/schema 11.144.1 → 11.154.2

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 (537) hide show
  1. package/examples/latest/all-fields-shapes-inline.json +1 -1
  2. package/examples/latest/all-fields-shapes.json +1 -1
  3. package/examples/latest/betzino.json +1 -1
  4. package/examples/latest/blog-schema.json +1 -1
  5. package/examples/latest/brewery-schema.json +1 -1
  6. package/examples/latest/chat-agent-schema.json +1 -1
  7. package/examples/latest/clear-cache-schema.json +1 -1
  8. package/examples/latest/complex-project-schema.json +1 -1
  9. package/examples/latest/complex-schema.json +1 -1
  10. package/examples/latest/edit-schema.json +1 -1
  11. package/examples/latest/frank-and-fred-schema.json +1 -1
  12. package/examples/latest/generate-agent-schema.json +1 -1
  13. package/examples/latest/klirr-schema.json +1 -1
  14. package/examples/latest/layers/rick-and-morty-layer.json +1 -1
  15. package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
  16. package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
  17. package/examples/latest/layers/wordpress-2024-01.json +1 -1
  18. package/examples/latest/massive-schema.json +1 -1
  19. package/examples/latest/mill-components-schema.json +1 -1
  20. package/examples/latest/nested-shape-arrays.json +1 -1
  21. package/examples/latest/one-earth.json +1 -1
  22. package/examples/latest/pet-oneof-array.json +1 -1
  23. package/examples/latest/post-schema.json +1 -1
  24. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  25. package/examples/latest/rag-example.json +1 -1
  26. package/examples/latest/real-world-schema.json +1 -1
  27. package/examples/latest/recursive-repeater-schema.json +1 -1
  28. package/examples/latest/recursive-schema.json +1 -1
  29. package/examples/latest/rick-and-morty-ast.json +1 -1
  30. package/examples/latest/rick-and-morty-graphql.json +1 -1
  31. package/examples/latest/rick-and-morty-rest.json +1 -1
  32. package/examples/latest/rick-and-morty-user-schema.json +1 -1
  33. package/examples/latest/rick-and-morty-with-indexing.json +1 -1
  34. package/examples/latest/schema-where-filter.json +1 -1
  35. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  36. package/examples/latest/schema-with-rick-and-morty.json +1 -1
  37. package/examples/latest/shape-books-v3_2_0.json +1 -1
  38. package/examples/latest/shape-books.json +1 -1
  39. package/examples/latest/shape-editor-schema-edited.json +1 -1
  40. package/examples/latest/shape-editor-schema-initial.json +1 -1
  41. package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
  42. package/examples/latest/shopify-lookbook.json +1 -1
  43. package/examples/latest/shopify-product-2022-07.json +1 -1
  44. package/examples/latest/shopify-product-2023-04.json +1 -1
  45. package/examples/latest/shopify-store-with-widget.json +1 -1
  46. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  47. package/examples/latest/stripe-starter-resolved.json +1 -1
  48. package/examples/latest/user-schema-no-required.json +1 -1
  49. package/examples/latest/user-schema-with-defaults.json +1 -1
  50. package/examples/latest/valvoline-ai-demo.json +1461 -1421
  51. package/examples/latest/vector-search-schema.json +1 -1
  52. package/package.json +10 -9
  53. package/dist/agents.d.ts +0 -62
  54. package/dist/agents.js +0 -338
  55. package/dist/api-version.d.ts +0 -5
  56. package/dist/api-version.js +0 -17
  57. package/dist/auth-schemas.d.ts +0 -128
  58. package/dist/auth-schemas.js +0 -7
  59. package/dist/auth-utils.d.ts +0 -5
  60. package/dist/auth-utils.js +0 -6
  61. package/dist/builtin-schema.d.ts +0 -18
  62. package/dist/builtin-schema.js +0 -683
  63. package/dist/constants.d.ts +0 -1
  64. package/dist/constants.js +0 -1
  65. package/dist/content-schema-transform.d.ts +0 -35
  66. package/dist/content-schema-transform.js +0 -162
  67. package/dist/create-input-schema.d.ts +0 -9
  68. package/dist/create-input-schema.js +0 -68
  69. package/dist/enum.d.ts +0 -2
  70. package/dist/enum.js +0 -9
  71. package/dist/flatten-templates.d.ts +0 -2
  72. package/dist/flatten-templates.js +0 -20
  73. package/dist/get-is-leaf.d.ts +0 -3
  74. package/dist/get-is-leaf.js +0 -56
  75. package/dist/index.d.ts +0 -62
  76. package/dist/index.js +0 -59
  77. package/dist/interfaces.d.ts +0 -14
  78. package/dist/interfaces.js +0 -86
  79. package/dist/layers/layers.d.ts +0 -26
  80. package/dist/layers/layers.js +0 -301
  81. package/dist/layers/refs.d.ts +0 -102
  82. package/dist/layers/refs.js +0 -220
  83. package/dist/layers/type-utils.d.ts +0 -59
  84. package/dist/layers/type-utils.js +0 -118
  85. package/dist/layers/visitor.d.ts +0 -5
  86. package/dist/layers/visitor.js +0 -38
  87. package/dist/migration/index.d.ts +0 -73
  88. package/dist/migration/index.js +0 -103
  89. package/dist/migration/to/v3.0.0.d.ts +0 -4
  90. package/dist/migration/to/v3.0.0.js +0 -212
  91. package/dist/migration/to/v3.1.0.d.ts +0 -4
  92. package/dist/migration/to/v3.1.0.js +0 -194
  93. package/dist/migration/to/v3.10.0.d.ts +0 -4
  94. package/dist/migration/to/v3.10.0.js +0 -67
  95. package/dist/migration/to/v3.11.0.d.ts +0 -4
  96. package/dist/migration/to/v3.11.0.js +0 -85
  97. package/dist/migration/to/v3.12.3.d.ts +0 -4
  98. package/dist/migration/to/v3.12.3.js +0 -87
  99. package/dist/migration/to/v3.13.0.d.ts +0 -4
  100. package/dist/migration/to/v3.13.0.js +0 -17
  101. package/dist/migration/to/v3.17.0.d.ts +0 -4
  102. package/dist/migration/to/v3.17.0.js +0 -22
  103. package/dist/migration/to/v3.18.0.d.ts +0 -4
  104. package/dist/migration/to/v3.18.0.js +0 -64
  105. package/dist/migration/to/v3.18.1.d.ts +0 -4
  106. package/dist/migration/to/v3.18.1.js +0 -12
  107. package/dist/migration/to/v3.18.2.d.ts +0 -4
  108. package/dist/migration/to/v3.18.2.js +0 -19
  109. package/dist/migration/to/v3.20.0.d.ts +0 -4
  110. package/dist/migration/to/v3.20.0.js +0 -24
  111. package/dist/migration/to/v3.22.0.d.ts +0 -4
  112. package/dist/migration/to/v3.22.0.js +0 -25
  113. package/dist/migration/to/v3.24.0.d.ts +0 -4
  114. package/dist/migration/to/v3.24.0.js +0 -11
  115. package/dist/migration/to/v3.25.0.d.ts +0 -4
  116. package/dist/migration/to/v3.25.0.js +0 -11
  117. package/dist/migration/to/v3.3.0.d.ts +0 -4
  118. package/dist/migration/to/v3.3.0.js +0 -13
  119. package/dist/migration/to/v3.31.0.d.ts +0 -4
  120. package/dist/migration/to/v3.31.0.js +0 -38
  121. package/dist/migration/to/v3.32.0.d.ts +0 -4
  122. package/dist/migration/to/v3.32.0.js +0 -59
  123. package/dist/migration/to/v3.34.0.d.ts +0 -6
  124. package/dist/migration/to/v3.34.0.js +0 -111
  125. package/dist/migration/to/v3.36.0.d.ts +0 -4
  126. package/dist/migration/to/v3.36.0.js +0 -22
  127. package/dist/migration/to/v3.39.0.d.ts +0 -4
  128. package/dist/migration/to/v3.39.0.js +0 -45
  129. package/dist/migration/to/v3.40.0.d.ts +0 -4
  130. package/dist/migration/to/v3.40.0.js +0 -26
  131. package/dist/migration/to/v3.46.0.d.ts +0 -4
  132. package/dist/migration/to/v3.46.0.js +0 -35
  133. package/dist/migration/to/v3.57.0.d.ts +0 -4
  134. package/dist/migration/to/v3.57.0.js +0 -18
  135. package/dist/migration/to/v3.9.0.d.ts +0 -4
  136. package/dist/migration/to/v3.9.0.js +0 -79
  137. package/dist/migration/types.d.ts +0 -26
  138. package/dist/migration/types.js +0 -3
  139. package/dist/migration/utils.d.ts +0 -2
  140. package/dist/migration/utils.js +0 -6
  141. package/dist/mocks.d.ts +0 -14
  142. package/dist/mocks.js +0 -58
  143. package/dist/models/agent.d.ts +0 -3
  144. package/dist/models/agent.js +0 -29
  145. package/dist/models/project-schema.d.ts +0 -18
  146. package/dist/models/project-schema.js +0 -119
  147. package/dist/models/query.d.ts +0 -3
  148. package/dist/models/query.js +0 -38
  149. package/dist/models/runtime-schema.d.ts +0 -9
  150. package/dist/models/runtime-schema.js +0 -20
  151. package/dist/models/shape.d.ts +0 -4
  152. package/dist/models/shape.js +0 -36
  153. package/dist/models/types.d.ts +0 -36
  154. package/dist/models/types.js +0 -1
  155. package/dist/models/user-schema.d.ts +0 -7
  156. package/dist/models/user-schema.js +0 -9
  157. package/dist/patterns.d.ts +0 -12
  158. package/dist/patterns.js +0 -1
  159. package/dist/project-schema/index.d.ts +0 -211
  160. package/dist/project-schema/index.js +0 -83
  161. package/dist/project-schema/latest.d.ts +0 -2619
  162. package/dist/project-schema/latest.js +0 -7
  163. package/dist/project-schema/migrate.d.ts +0 -4
  164. package/dist/project-schema/migrate.js +0 -218
  165. package/dist/project-schema/v1.0.0.d.ts +0 -299
  166. package/dist/project-schema/v1.0.0.js +0 -7
  167. package/dist/project-schema/v3.0.0.d.ts +0 -478
  168. package/dist/project-schema/v3.0.0.js +0 -7
  169. package/dist/project-schema/v3.1.0.d.ts +0 -621
  170. package/dist/project-schema/v3.1.0.js +0 -7
  171. package/dist/project-schema/v3.10.0.d.ts +0 -1201
  172. package/dist/project-schema/v3.10.0.js +0 -7
  173. package/dist/project-schema/v3.11.0.d.ts +0 -1210
  174. package/dist/project-schema/v3.11.0.js +0 -7
  175. package/dist/project-schema/v3.12.0.d.ts +0 -1214
  176. package/dist/project-schema/v3.12.0.js +0 -7
  177. package/dist/project-schema/v3.12.1.d.ts +0 -1273
  178. package/dist/project-schema/v3.12.1.js +0 -7
  179. package/dist/project-schema/v3.12.2.d.ts +0 -1283
  180. package/dist/project-schema/v3.12.2.js +0 -7
  181. package/dist/project-schema/v3.12.3.d.ts +0 -1306
  182. package/dist/project-schema/v3.12.3.js +0 -7
  183. package/dist/project-schema/v3.13.0.d.ts +0 -1317
  184. package/dist/project-schema/v3.13.0.js +0 -7
  185. package/dist/project-schema/v3.13.1.d.ts +0 -1412
  186. package/dist/project-schema/v3.13.1.js +0 -7
  187. package/dist/project-schema/v3.14.0.d.ts +0 -1436
  188. package/dist/project-schema/v3.14.0.js +0 -7
  189. package/dist/project-schema/v3.15.0.d.ts +0 -1458
  190. package/dist/project-schema/v3.15.0.js +0 -7
  191. package/dist/project-schema/v3.16.0.d.ts +0 -1470
  192. package/dist/project-schema/v3.16.0.js +0 -7
  193. package/dist/project-schema/v3.17.0.d.ts +0 -1467
  194. package/dist/project-schema/v3.17.0.js +0 -7
  195. package/dist/project-schema/v3.17.1.d.ts +0 -1468
  196. package/dist/project-schema/v3.17.1.js +0 -7
  197. package/dist/project-schema/v3.18.0.d.ts +0 -1333
  198. package/dist/project-schema/v3.18.0.js +0 -7
  199. package/dist/project-schema/v3.18.1.d.ts +0 -1332
  200. package/dist/project-schema/v3.18.1.js +0 -7
  201. package/dist/project-schema/v3.18.2.d.ts +0 -1332
  202. package/dist/project-schema/v3.18.2.js +0 -7
  203. package/dist/project-schema/v3.19.0.d.ts +0 -1336
  204. package/dist/project-schema/v3.19.0.js +0 -7
  205. package/dist/project-schema/v3.2.0.d.ts +0 -632
  206. package/dist/project-schema/v3.2.0.js +0 -7
  207. package/dist/project-schema/v3.20.0.d.ts +0 -1336
  208. package/dist/project-schema/v3.20.0.js +0 -7
  209. package/dist/project-schema/v3.21.0.d.ts +0 -1338
  210. package/dist/project-schema/v3.21.0.js +0 -7
  211. package/dist/project-schema/v3.22.0.d.ts +0 -1344
  212. package/dist/project-schema/v3.22.0.js +0 -7
  213. package/dist/project-schema/v3.23.0.d.ts +0 -1376
  214. package/dist/project-schema/v3.23.0.js +0 -7
  215. package/dist/project-schema/v3.24.0.d.ts +0 -1364
  216. package/dist/project-schema/v3.24.0.js +0 -7
  217. package/dist/project-schema/v3.25.0.d.ts +0 -1363
  218. package/dist/project-schema/v3.25.0.js +0 -7
  219. package/dist/project-schema/v3.26.0.d.ts +0 -1388
  220. package/dist/project-schema/v3.26.0.js +0 -7
  221. package/dist/project-schema/v3.27.0.d.ts +0 -1397
  222. package/dist/project-schema/v3.27.0.js +0 -7
  223. package/dist/project-schema/v3.28.0.d.ts +0 -1416
  224. package/dist/project-schema/v3.28.0.js +0 -7
  225. package/dist/project-schema/v3.29.0.d.ts +0 -1423
  226. package/dist/project-schema/v3.29.0.js +0 -7
  227. package/dist/project-schema/v3.3.0.d.ts +0 -632
  228. package/dist/project-schema/v3.3.0.js +0 -7
  229. package/dist/project-schema/v3.30.0.d.ts +0 -1416
  230. package/dist/project-schema/v3.30.0.js +0 -7
  231. package/dist/project-schema/v3.31.0.d.ts +0 -1448
  232. package/dist/project-schema/v3.31.0.js +0 -7
  233. package/dist/project-schema/v3.32.0.d.ts +0 -1439
  234. package/dist/project-schema/v3.32.0.js +0 -7
  235. package/dist/project-schema/v3.33.0.d.ts +0 -1445
  236. package/dist/project-schema/v3.33.0.js +0 -7
  237. package/dist/project-schema/v3.34.0.d.ts +0 -1445
  238. package/dist/project-schema/v3.34.0.js +0 -7
  239. package/dist/project-schema/v3.35.0.d.ts +0 -1464
  240. package/dist/project-schema/v3.35.0.js +0 -7
  241. package/dist/project-schema/v3.36.0.d.ts +0 -1470
  242. package/dist/project-schema/v3.36.0.js +0 -7
  243. package/dist/project-schema/v3.37.0.d.ts +0 -1522
  244. package/dist/project-schema/v3.37.0.js +0 -7
  245. package/dist/project-schema/v3.38.0.d.ts +0 -1522
  246. package/dist/project-schema/v3.38.0.js +0 -7
  247. package/dist/project-schema/v3.39.0.d.ts +0 -1529
  248. package/dist/project-schema/v3.39.0.js +0 -7
  249. package/dist/project-schema/v3.4.0.d.ts +0 -624
  250. package/dist/project-schema/v3.4.0.js +0 -7
  251. package/dist/project-schema/v3.40.0.d.ts +0 -1530
  252. package/dist/project-schema/v3.40.0.js +0 -7
  253. package/dist/project-schema/v3.41.0.d.ts +0 -1530
  254. package/dist/project-schema/v3.41.0.js +0 -7
  255. package/dist/project-schema/v3.42.0.d.ts +0 -1534
  256. package/dist/project-schema/v3.42.0.js +0 -7
  257. package/dist/project-schema/v3.43.0.d.ts +0 -1536
  258. package/dist/project-schema/v3.43.0.js +0 -7
  259. package/dist/project-schema/v3.44.0.d.ts +0 -1621
  260. package/dist/project-schema/v3.44.0.js +0 -7
  261. package/dist/project-schema/v3.45.0.d.ts +0 -1650
  262. package/dist/project-schema/v3.45.0.js +0 -7
  263. package/dist/project-schema/v3.46.0.d.ts +0 -1703
  264. package/dist/project-schema/v3.46.0.js +0 -7
  265. package/dist/project-schema/v3.47.0.d.ts +0 -1736
  266. package/dist/project-schema/v3.47.0.js +0 -7
  267. package/dist/project-schema/v3.48.0.d.ts +0 -2208
  268. package/dist/project-schema/v3.48.0.js +0 -7
  269. package/dist/project-schema/v3.49.0.d.ts +0 -2217
  270. package/dist/project-schema/v3.49.0.js +0 -7
  271. package/dist/project-schema/v3.5.0.d.ts +0 -649
  272. package/dist/project-schema/v3.5.0.js +0 -7
  273. package/dist/project-schema/v3.5.1.d.ts +0 -649
  274. package/dist/project-schema/v3.5.1.js +0 -7
  275. package/dist/project-schema/v3.50.0.d.ts +0 -2269
  276. package/dist/project-schema/v3.50.0.js +0 -7
  277. package/dist/project-schema/v3.51.0.d.ts +0 -2269
  278. package/dist/project-schema/v3.51.0.js +0 -7
  279. package/dist/project-schema/v3.52.0.d.ts +0 -2269
  280. package/dist/project-schema/v3.52.0.js +0 -7
  281. package/dist/project-schema/v3.53.0.d.ts +0 -2350
  282. package/dist/project-schema/v3.53.0.js +0 -7
  283. package/dist/project-schema/v3.54.0.d.ts +0 -2369
  284. package/dist/project-schema/v3.54.0.js +0 -7
  285. package/dist/project-schema/v3.55.0.d.ts +0 -2369
  286. package/dist/project-schema/v3.55.0.js +0 -7
  287. package/dist/project-schema/v3.56.0.d.ts +0 -2405
  288. package/dist/project-schema/v3.56.0.js +0 -7
  289. package/dist/project-schema/v3.57.0.d.ts +0 -2601
  290. package/dist/project-schema/v3.57.0.js +0 -7
  291. package/dist/project-schema/v3.58.0.d.ts +0 -2601
  292. package/dist/project-schema/v3.58.0.js +0 -7
  293. package/dist/project-schema/v3.59.0.d.ts +0 -2619
  294. package/dist/project-schema/v3.59.0.js +0 -7
  295. package/dist/project-schema/v3.6.0.d.ts +0 -658
  296. package/dist/project-schema/v3.6.0.js +0 -7
  297. package/dist/project-schema/v3.7.0.d.ts +0 -961
  298. package/dist/project-schema/v3.7.0.js +0 -7
  299. package/dist/project-schema/v3.8.0.d.ts +0 -979
  300. package/dist/project-schema/v3.8.0.js +0 -7
  301. package/dist/project-schema/v3.9.0.d.ts +0 -1178
  302. package/dist/project-schema/v3.9.0.js +0 -7
  303. package/dist/project-schema/v4.0.0.d.ts +0 -1328
  304. package/dist/project-schema/v4.0.0.js +0 -7
  305. package/dist/refs.d.ts +0 -218
  306. package/dist/refs.js +0 -616
  307. package/dist/relationships.d.ts +0 -40
  308. package/dist/relationships.js +0 -302
  309. package/dist/resolvers/ai/abort-agent-message-args.d.ts +0 -16
  310. package/dist/resolvers/ai/abort-agent-message-args.js +0 -13
  311. package/dist/resolvers/ai/abort-agent-message-response.d.ts +0 -39
  312. package/dist/resolvers/ai/abort-agent-message-response.js +0 -19
  313. package/dist/resolvers/ai/agent-chat-args.d.ts +0 -17
  314. package/dist/resolvers/ai/agent-chat-args.js +0 -14
  315. package/dist/resolvers/ai/agent-chat-payload.d.ts +0 -35
  316. package/dist/resolvers/ai/agent-chat-payload.js +0 -26
  317. package/dist/resolvers/ai/agent-chat-response.d.ts +0 -289
  318. package/dist/resolvers/ai/agent-chat-response.js +0 -21
  319. package/dist/resolvers/ai/agent-generate-args.d.ts +0 -17
  320. package/dist/resolvers/ai/agent-generate-args.js +0 -14
  321. package/dist/resolvers/ai/agent-message-input.d.ts +0 -73
  322. package/dist/resolvers/ai/agent-message-input.js +0 -39
  323. package/dist/resolvers/ai/agent-message-output.d.ts +0 -169
  324. package/dist/resolvers/ai/agent-message-output.js +0 -77
  325. package/dist/resolvers/ai/agent-message-payload.d.ts +0 -507
  326. package/dist/resolvers/ai/agent-message-payload.js +0 -156
  327. package/dist/resolvers/ai/agent-run-mode.d.ts +0 -7
  328. package/dist/resolvers/ai/agent-run-mode.js +0 -9
  329. package/dist/resolvers/ai/agent-session-payload.d.ts +0 -515
  330. package/dist/resolvers/ai/agent-session-payload.js +0 -175
  331. package/dist/resolvers/ai/create-agent-session-response.d.ts +0 -199
  332. package/dist/resolvers/ai/create-agent-session-response.js +0 -9
  333. package/dist/resolvers/ai/embedding-search.d.ts +0 -54
  334. package/dist/resolvers/ai/embedding-search.js +0 -46
  335. package/dist/resolvers/ai/get-agent-message-args.d.ts +0 -16
  336. package/dist/resolvers/ai/get-agent-message-args.js +0 -13
  337. package/dist/resolvers/ai/get-agent-message-response.d.ts +0 -805
  338. package/dist/resolvers/ai/get-agent-message-response.js +0 -63
  339. package/dist/resolvers/ai/inspect-agent-args.d.ts +0 -16
  340. package/dist/resolvers/ai/inspect-agent-args.js +0 -13
  341. package/dist/resolvers/ai/inspect-agent-response.d.ts +0 -504
  342. package/dist/resolvers/ai/inspect-agent-response.js +0 -48
  343. package/dist/resolvers/ai/send-agent-feedback-args.d.ts +0 -52
  344. package/dist/resolvers/ai/send-agent-feedback-args.js +0 -16
  345. package/dist/resolvers/ai/send-agent-message-args.d.ts +0 -48
  346. package/dist/resolvers/ai/send-agent-message-args.js +0 -36
  347. package/dist/resolvers/ai/send-agent-message-response.d.ts +0 -353
  348. package/dist/resolvers/ai/send-agent-message-response.js +0 -51
  349. package/dist/resolvers/ai/types.d.ts +0 -6
  350. package/dist/resolvers/ai/types.js +0 -1
  351. package/dist/resolvers/takeshape/assets/asset-image-meta.d.ts +0 -79
  352. package/dist/resolvers/takeshape/assets/asset-image-meta.js +0 -98
  353. package/dist/resolvers/takeshape/assets/asset-image-params.d.ts +0 -901
  354. package/dist/resolvers/takeshape/assets/asset-image-params.js +0 -726
  355. package/dist/resolvers/takeshape/assets/asset-image.d.ts +0 -17
  356. package/dist/resolvers/takeshape/assets/asset-image.js +0 -15
  357. package/dist/resolvers/takeshape/assets/asset.d.ts +0 -125
  358. package/dist/resolvers/takeshape/assets/asset.js +0 -107
  359. package/dist/resolvers/takeshape/assets/constants.d.ts +0 -11
  360. package/dist/resolvers/takeshape/assets/constants.js +0 -11
  361. package/dist/resolvers/takeshape/builtins/constants.d.ts +0 -1
  362. package/dist/resolvers/takeshape/builtins/constants.js +0 -1
  363. package/dist/runtime-schema.d.ts +0 -6
  364. package/dist/runtime-schema.js +0 -85
  365. package/dist/scalars.d.ts +0 -2
  366. package/dist/scalars.js +0 -4
  367. package/dist/schema-transform.d.ts +0 -19
  368. package/dist/schema-transform.js +0 -74
  369. package/dist/schema-util.d.ts +0 -266
  370. package/dist/schema-util.js +0 -1127
  371. package/dist/schemas/auth-schemas.json +0 -374
  372. package/dist/schemas/index.d.ts +0 -4
  373. package/dist/schemas/index.js +0 -170
  374. package/dist/schemas/project-schema/experimental-2025-07.json +0 -1297
  375. package/dist/schemas/project-schema/latest.d.ts +0 -180
  376. package/dist/schemas/project-schema/latest.js +0 -11
  377. package/dist/schemas/project-schema/latest.json +0 -4846
  378. package/dist/schemas/project-schema/meta-schema-v1.0.0.json +0 -193
  379. package/dist/schemas/project-schema/meta-schema-v3.0.0.json +0 -608
  380. package/dist/schemas/project-schema/meta-schema-v3.1.0.json +0 -608
  381. package/dist/schemas/project-schema/meta-schema-v3.2.0.json +0 -612
  382. package/dist/schemas/project-schema/meta-schema-v3.3.0.json +0 -612
  383. package/dist/schemas/project-schema/meta-schema-v3.4.0.json +0 -637
  384. package/dist/schemas/project-schema/meta-schema-v3.5.0.json +0 -626
  385. package/dist/schemas/project-schema/meta-schema-v3.5.1.json +0 -626
  386. package/dist/schemas/project-schema/meta-schema-v3.6.0.json +0 -629
  387. package/dist/schemas/project-schema/meta-schema-v3.7.0.json +0 -1137
  388. package/dist/schemas/project-schema/meta-schema-v3.8.0.json +0 -1137
  389. package/dist/schemas/project-schema/meta-schema-v3.9.0.json +0 -1477
  390. package/dist/schemas/project-schema/v1.0.0.json +0 -321
  391. package/dist/schemas/project-schema/v3.0.0.json +0 -414
  392. package/dist/schemas/project-schema/v3.1.0.json +0 -572
  393. package/dist/schemas/project-schema/v3.10.0.json +0 -2097
  394. package/dist/schemas/project-schema/v3.11.0.json +0 -2141
  395. package/dist/schemas/project-schema/v3.12.0.json +0 -2144
  396. package/dist/schemas/project-schema/v3.12.1.json +0 -2282
  397. package/dist/schemas/project-schema/v3.12.2.json +0 -2304
  398. package/dist/schemas/project-schema/v3.12.3.json +0 -2357
  399. package/dist/schemas/project-schema/v3.13.0.json +0 -2377
  400. package/dist/schemas/project-schema/v3.14.0.json +0 -2385
  401. package/dist/schemas/project-schema/v3.15.0.json +0 -2365
  402. package/dist/schemas/project-schema/v3.16.0.json +0 -2373
  403. package/dist/schemas/project-schema/v3.17.0.json +0 -2378
  404. package/dist/schemas/project-schema/v3.17.1.json +0 -2380
  405. package/dist/schemas/project-schema/v3.18.0.json +0 -2356
  406. package/dist/schemas/project-schema/v3.18.1.json +0 -2357
  407. package/dist/schemas/project-schema/v3.18.2.json +0 -2357
  408. package/dist/schemas/project-schema/v3.19.0.json +0 -2369
  409. package/dist/schemas/project-schema/v3.2.0.json +0 -580
  410. package/dist/schemas/project-schema/v3.20.0.json +0 -2369
  411. package/dist/schemas/project-schema/v3.21.0.json +0 -2376
  412. package/dist/schemas/project-schema/v3.22.0.json +0 -2381
  413. package/dist/schemas/project-schema/v3.23.0.json +0 -2456
  414. package/dist/schemas/project-schema/v3.24.0.json +0 -2556
  415. package/dist/schemas/project-schema/v3.25.0.json +0 -2552
  416. package/dist/schemas/project-schema/v3.26.0.json +0 -2599
  417. package/dist/schemas/project-schema/v3.27.0.json +0 -2611
  418. package/dist/schemas/project-schema/v3.28.0.json +0 -2656
  419. package/dist/schemas/project-schema/v3.29.0.json +0 -2670
  420. package/dist/schemas/project-schema/v3.3.0.json +0 -581
  421. package/dist/schemas/project-schema/v3.30.0.json +0 -2656
  422. package/dist/schemas/project-schema/v3.31.0.json +0 -2714
  423. package/dist/schemas/project-schema/v3.32.0.json +0 -2708
  424. package/dist/schemas/project-schema/v3.33.0.json +0 -2715
  425. package/dist/schemas/project-schema/v3.34.0.json +0 -2715
  426. package/dist/schemas/project-schema/v3.35.0.json +0 -2748
  427. package/dist/schemas/project-schema/v3.36.0.json +0 -2756
  428. package/dist/schemas/project-schema/v3.37.0.json +0 -2821
  429. package/dist/schemas/project-schema/v3.38.0.json +0 -2819
  430. package/dist/schemas/project-schema/v3.39.0.json +0 -2827
  431. package/dist/schemas/project-schema/v3.4.0.json +0 -571
  432. package/dist/schemas/project-schema/v3.40.0.json +0 -2830
  433. package/dist/schemas/project-schema/v3.41.0.json +0 -2830
  434. package/dist/schemas/project-schema/v3.42.0.json +0 -2835
  435. package/dist/schemas/project-schema/v3.43.0.json +0 -2841
  436. package/dist/schemas/project-schema/v3.44.0.json +0 -3013
  437. package/dist/schemas/project-schema/v3.45.0.json +0 -3064
  438. package/dist/schemas/project-schema/v3.46.0.json +0 -3136
  439. package/dist/schemas/project-schema/v3.47.0.json +0 -3189
  440. package/dist/schemas/project-schema/v3.48.0.json +0 -3196
  441. package/dist/schemas/project-schema/v3.49.0.json +0 -3239
  442. package/dist/schemas/project-schema/v3.5.0.json +0 -571
  443. package/dist/schemas/project-schema/v3.5.1.json +0 -571
  444. package/dist/schemas/project-schema/v3.50.0.json +0 -3320
  445. package/dist/schemas/project-schema/v3.51.0.json +0 -3326
  446. package/dist/schemas/project-schema/v3.52.0.json +0 -3326
  447. package/dist/schemas/project-schema/v3.53.0.json +0 -3476
  448. package/dist/schemas/project-schema/v3.54.0.json +0 -3512
  449. package/dist/schemas/project-schema/v3.55.0.json +0 -3515
  450. package/dist/schemas/project-schema/v3.56.0.json +0 -3530
  451. package/dist/schemas/project-schema/v3.57.0.json +0 -4815
  452. package/dist/schemas/project-schema/v3.58.0.json +0 -4815
  453. package/dist/schemas/project-schema/v3.59.0.json +0 -4846
  454. package/dist/schemas/project-schema/v3.6.0.json +0 -587
  455. package/dist/schemas/project-schema/v3.7.0.json +0 -587
  456. package/dist/schemas/project-schema/v3.8.0.json +0 -604
  457. package/dist/schemas/project-schema/v3.9.0.json +0 -604
  458. package/dist/schemas/project-schema/v4.0.0.json +0 -2316
  459. package/dist/schemas/project-schema.json +0 -214
  460. package/dist/service-dependencies.d.ts +0 -13
  461. package/dist/service-dependencies.js +0 -165
  462. package/dist/services/services.d.ts +0 -31
  463. package/dist/services/services.js +0 -145
  464. package/dist/services/types.d.ts +0 -11
  465. package/dist/services/types.js +0 -1
  466. package/dist/services/util.d.ts +0 -16
  467. package/dist/services/util.js +0 -36
  468. package/dist/shape-paths.d.ts +0 -7
  469. package/dist/shape-paths.js +0 -28
  470. package/dist/taxonomies.d.ts +0 -15
  471. package/dist/taxonomies.js +0 -24
  472. package/dist/template-shapes/index.d.ts +0 -7
  473. package/dist/template-shapes/index.js +0 -33
  474. package/dist/template-shapes/names.d.ts +0 -10
  475. package/dist/template-shapes/names.js +0 -21
  476. package/dist/template-shapes/templates.d.ts +0 -32
  477. package/dist/template-shapes/templates.js +0 -316
  478. package/dist/template-shapes/types.d.ts +0 -15
  479. package/dist/template-shapes/types.js +0 -7
  480. package/dist/template-shapes/where.d.ts +0 -37
  481. package/dist/template-shapes/where.js +0 -400
  482. package/dist/types/index.d.ts +0 -3
  483. package/dist/types/index.js +0 -2
  484. package/dist/types/transforms.d.ts +0 -15
  485. package/dist/types/transforms.js +0 -1
  486. package/dist/types/types.d.ts +0 -200
  487. package/dist/types/types.js +0 -10
  488. package/dist/types/utils.d.ts +0 -112
  489. package/dist/types/utils.js +0 -269
  490. package/dist/unions.d.ts +0 -14
  491. package/dist/unions.js +0 -77
  492. package/dist/util/ai-tools.d.ts +0 -2
  493. package/dist/util/ai-tools.js +0 -14
  494. package/dist/util/api-indexing.d.ts +0 -9
  495. package/dist/util/api-indexing.js +0 -57
  496. package/dist/util/coerce-value.d.ts +0 -9
  497. package/dist/util/coerce-value.js +0 -32
  498. package/dist/util/detect-cycles.d.ts +0 -7
  499. package/dist/util/detect-cycles.js +0 -45
  500. package/dist/util/expressions.d.ts +0 -34
  501. package/dist/util/expressions.js +0 -350
  502. package/dist/util/find-shape-at-path.d.ts +0 -21
  503. package/dist/util/find-shape-at-path.js +0 -53
  504. package/dist/util/form-config.d.ts +0 -11
  505. package/dist/util/form-config.js +0 -62
  506. package/dist/util/get-conflicting-properties.d.ts +0 -6
  507. package/dist/util/get-conflicting-properties.js +0 -55
  508. package/dist/util/get-return-shape.d.ts +0 -4
  509. package/dist/util/get-return-shape.js +0 -30
  510. package/dist/util/has-arg.d.ts +0 -6
  511. package/dist/util/has-arg.js +0 -25
  512. package/dist/util/is-asset-property.d.ts +0 -3
  513. package/dist/util/is-asset-property.js +0 -11
  514. package/dist/util/mcp.d.ts +0 -8
  515. package/dist/util/mcp.js +0 -21
  516. package/dist/util/merge.d.ts +0 -15
  517. package/dist/util/merge.js +0 -254
  518. package/dist/util/patch-schema.d.ts +0 -8
  519. package/dist/util/patch-schema.js +0 -51
  520. package/dist/util/query-field-path.d.ts +0 -9
  521. package/dist/util/query-field-path.js +0 -23
  522. package/dist/util/shapes.d.ts +0 -5
  523. package/dist/util/shapes.js +0 -22
  524. package/dist/validate/ai.d.ts +0 -6
  525. package/dist/validate/ai.js +0 -183
  526. package/dist/validate/errors.d.ts +0 -3
  527. package/dist/validate/errors.js +0 -20
  528. package/dist/validate/types.d.ts +0 -1
  529. package/dist/validate/types.js +0 -1
  530. package/dist/validate/util.d.ts +0 -3
  531. package/dist/validate/util.js +0 -28
  532. package/dist/validate/validate.d.ts +0 -80
  533. package/dist/validate/validate.js +0 -1058
  534. package/dist/versions.d.ts +0 -4
  535. package/dist/versions.js +0 -4
  536. package/dist/workflows.d.ts +0 -14
  537. package/dist/workflows.js +0 -66
@@ -1,2619 +0,0 @@
1
- /**
2
- * This file was automatically generated by json-schema-to-typescript.
3
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
4
- * and run json-schema-to-typescript to regenerate this file.
5
- */
6
- /**
7
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
8
- * via the `definition` "args".
9
- */
10
- export type Args = string | ObjectSchema | ExtendsSchema;
11
- /**
12
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
13
- * via the `definition` "objectSchema".
14
- */
15
- export type ObjectSchema = PropertySchema & {
16
- type: 'object';
17
- properties: {
18
- [k: string]: PropertySchema;
19
- };
20
- };
21
- /**
22
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
23
- * via the `definition` "nonNegativeInteger".
24
- */
25
- export type NonNegativeInteger = number;
26
- /**
27
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
28
- * via the `definition` "nonNegativeIntegerDefault0".
29
- */
30
- export type NonNegativeIntegerDefault0 = NonNegativeInteger;
31
- /**
32
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
33
- * via the `definition` "stringArray".
34
- */
35
- export type StringArray = string[];
36
- /**
37
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
38
- * via the `definition` "simpleTypes".
39
- */
40
- export type SimpleTypes = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
41
- /**
42
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
43
- * via the `definition` "schemaArray".
44
- */
45
- export type SchemaArray = PropertySchema[];
46
- /**
47
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
48
- * via the `definition` "ref".
49
- */
50
- export type Ref = string;
51
- /**
52
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
53
- * via the `definition` "objectOrRefArray".
54
- */
55
- export type ObjectOrRefArray = (RefSchema | RefSchemaLegacy | ObjectSchema)[];
56
- /**
57
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
58
- * via the `definition` "fieldMapping".
59
- */
60
- export type FieldMapping = MappingString | MappingString[];
61
- /**
62
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
63
- * via the `definition` "mappingString".
64
- */
65
- export type MappingString = string;
66
- /**
67
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
68
- * via the `definition` "resolver".
69
- */
70
- export type Resolver = BasicResolver | ComposeResolver;
71
- /**
72
- * A single resolver, can be composed with the ComposeResolver.
73
- *
74
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
75
- * via the `definition` "basicResolver".
76
- */
77
- export type BasicResolver = UtilResolver | DelegateResolver | TakeshapeResolver | ShapedbResolver | ShapedbResolverShapeNameNotRequired | GraphqlResolver | RestResolver | AwsLambdaResolver | SalsifyResolver | SyndigoResolver | FunctionResolver | AIGenerateTextResolver | AIGeneratePropertyResolver | AIEmbeddingResolver | AIEmbeddingSearchResolver | AIParseFileResolver | ChunkResolver | AISendAgentMessageResolver | AIInspectAgentResolver | AICreateAgentSessionResolver | AIGetAgentMessageResolver | AIAbortAgentMessageResolver | AISendAgentFeedbackResolver;
78
- /**
79
- * Name of the resolver function.
80
- */
81
- export type UtilResolverName = 'util:noop' | 'util:wrap';
82
- /**
83
- * An object describing an operation to generate a parameter.
84
- *
85
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
86
- * via the `definition` "parameterOp".
87
- */
88
- export type ParameterOp = ParameterOpNested | ParameterOpValue | ParameterOpMapping | ParameterOpOp;
89
- /**
90
- * A tuple with a string directive name, and options to pass to the directive
91
- *
92
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
93
- * via the `definition` "directiveConfigItem".
94
- */
95
- export type DirectiveConfigItem = [DirectiveName, DirectiveOptions];
96
- export type DirectiveName = string;
97
- /**
98
- * An array of individual directive config items to process in order
99
- *
100
- * This interface was referenced by `DirectiveMappingMap`'s JSON-Schema definition
101
- * via the `patternProperty` "[0-9A-Za-z_-]+".
102
- *
103
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
104
- * via the `definition` "directiveConfig".
105
- */
106
- export type DirectiveConfig = DirectiveConfigItem[];
107
- /**
108
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
109
- * via the `definition` "parameterOpList".
110
- */
111
- export type ParameterOpList = ParameterOp[];
112
- /**
113
- * Maps a query's input args to the input expected by the service's endpoint.
114
- *
115
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
116
- * via the `definition` "argsMapping".
117
- */
118
- export type ArgsMapping = DirectiveMappingMap | DirectiveConfig;
119
- /**
120
- * Maps a service endpoint's response results to the expected shape of the query's response.
121
- *
122
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
123
- * via the `definition` "resultsMapping".
124
- */
125
- export type ResultsMapping = DirectiveMappingMap | DirectiveConfig;
126
- /**
127
- * Name of the resolver function.
128
- */
129
- export type DelegateResolverName = 'delegate';
130
- /**
131
- * Name of the resolver function.
132
- */
133
- export type TakeshapeResolverName = 'takeshape:get' | 'takeshape:getUser' | 'takeshape:search' | 'takeshape:vectorSearch' | 'takeshape:queryApiIndex' | 'takeshape:assetUrl' | 'takeshape:assetImage' | 'takeshape:assetImageMeta';
134
- /**
135
- * Name of the resolver function.
136
- */
137
- export type ShapedbResolverName = 'shapedb:get' | 'shapedb:create' | 'shapedb:update' | 'shapedb:delete' | 'shapedb:duplicate' | 'shapedb:find';
138
- /**
139
- * Name of the resolver function.
140
- */
141
- export type ShapedbResolverShapeNameNotRequiredName = 'shapedb:list' | 'shapedb:taxonomySuggest' | 'shapedb:getRelated';
142
- /**
143
- * Name of the resolver function.
144
- */
145
- export type GraphqlResolverName = 'graphql:query' | 'graphql:mutation' | 'shopify:bulkQuery';
146
- /**
147
- * Name of the resolver function.
148
- */
149
- export type RestResolverName = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
150
- /**
151
- * A tuple with a string key and a directive config to evaluate
152
- *
153
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
154
- * via the `definition` "directiveMappingArrayItem".
155
- */
156
- export type DirectiveMappingArrayItem = [string, DirectiveConfig];
157
- /**
158
- * An array of key / value or directive config tuples
159
- */
160
- export type SearchParamsMapping = DirectiveMappingArrayItem[];
161
- /**
162
- * Name of the resolver function.
163
- */
164
- export type AwsLambdaResolverName = 'awsLambda:invoke';
165
- /**
166
- * Name of the resolver function.
167
- */
168
- export type SalsifyResolverName = 'salsify:listChannelProducts';
169
- /**
170
- * Name of the resolver function.
171
- */
172
- export type SyndigoResolverName = 'syndigo:searchProducts';
173
- /**
174
- * Name of the resolver function.
175
- */
176
- export type FunctionResolverName = 'function:run';
177
- export type FunctionResolverJavascript = string;
178
- /**
179
- * Name of the resolver function.
180
- */
181
- export type AIResolverName = 'ai:generateText' | 'ai:chat';
182
- export type History = boolean;
183
- /**
184
- * Maximum number of tokens to generate.
185
- */
186
- export type MaximumTokens = number;
187
- /**
188
- * This is a number between 0 (almost no randomness) and 1 (very random). It is recommended to set either `temperature` or `topP`, but not both. Defaults to 0
189
- */
190
- export type Temperature = number;
191
- /**
192
- * Nucleus sampling. This is a number between 0 and 1. E.g. 0.1 would mean that only tokens with the top 10% probability mass are considered. It is recommended to set either `temperature` or `topP`, but not both.
193
- */
194
- export type TopP = number;
195
- /**
196
- * Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Recommended for advanced use cases only. You usually only need to use temperature.
197
- */
198
- export type TopK = number;
199
- /**
200
- * It affects the likelihood of the model to repeat information that is already in the prompt. The presence penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
201
- */
202
- export type PresencePenaltySetting = number;
203
- /**
204
- * It affects the likelihood of the model to repeatedly use the same words or phrases. The frequency penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
205
- */
206
- export type FrequencyPenaltySetting = number;
207
- /**
208
- * If set, the model will stop generating text when one of the stop sequences is generated.
209
- */
210
- export type StopSequences = string[];
211
- /**
212
- * The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
213
- */
214
- export type Seed = number;
215
- /**
216
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
217
- * via the `definition` "aiGuardrail".
218
- */
219
- export type AIGuardrail = AISimilarityGuardrail;
220
- /**
221
- * Name of the resolver function.
222
- */
223
- export type AIResolverName1 = 'ai:generateProperty';
224
- /**
225
- * Name of the resolver function.
226
- */
227
- export type AIResolverName2 = 'ai:createEmbedding';
228
- /**
229
- * Name of the resolver function.
230
- */
231
- export type AIResolverName3 = 'ai:embeddingSearch';
232
- /**
233
- * Name of the resolver function.
234
- */
235
- export type AIResolverName4 = 'ai:parseFile';
236
- /**
237
- * Name of the resolver function.
238
- */
239
- export type UtilResolverName1 = 'util:chunk';
240
- /**
241
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
242
- * via the `definition` "utilChunkResolverOptions".
243
- */
244
- export type UtilChunkResolverOptions = UtilChunkResolverOptionsCharacterCount | UtilChunkResolverOptionsSeparators | UtilChunkResolverOptionsMarkdown | UtilChunkResolverOptionsSemantic;
245
- /**
246
- * Name of the resolver function.
247
- */
248
- export type AIResolverName5 = 'ai:sendAgentMessage';
249
- /**
250
- * Name of the resolver function.
251
- */
252
- export type AIResolverName6 = 'ai:inspectAgent';
253
- /**
254
- * Name of the resolver function.
255
- */
256
- export type AIResolverName7 = 'ai:createAgentSession';
257
- /**
258
- * Name of the resolver function.
259
- */
260
- export type AIResolverName8 = 'ai:getAgentMessage';
261
- /**
262
- * Name of the resolver function.
263
- */
264
- export type AIResolverName9 = 'ai:abortAgentMessage';
265
- /**
266
- * Name of the resolver function.
267
- */
268
- export type AIResolverName10 = 'ai:sendAgentFeedback';
269
- /**
270
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
271
- * via the `definition` "dependencies".
272
- */
273
- export type Dependencies = string;
274
- /**
275
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
276
- * via the `definition` "extendsSchema".
277
- */
278
- export type ExtendsSchema = PropertySchema & {
279
- extends: ObjectOrRefArray;
280
- };
281
- /**
282
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
283
- * via the `definition` "returnShape".
284
- */
285
- export type ReturnShape = string | ReturnShapeArraySchema;
286
- /**
287
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
288
- * via the `definition` "returnShapeArraySchema".
289
- */
290
- export type ReturnShapeArraySchema = PropertySchema & {
291
- type: 'array';
292
- items: RefSchema | {
293
- type: 'boolean' | 'integer' | 'number' | 'string' | 'object';
294
- [k: string]: any;
295
- };
296
- };
297
- export type ModelType = 'single' | 'multiple' | 'taxonomy';
298
- /**
299
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
300
- * via the `definition` "paginationConfig".
301
- */
302
- export type PaginationConfig = PaginationCursorConfig | PaginationPageConfig | PaginationOffsetConfig;
303
- /**
304
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
305
- * via the `definition` "cacheTriggerConfig".
306
- */
307
- export type CacheTriggerConfig = CacheScheduleTriggerConfig | CacheWebhookTriggerConfig;
308
- /**
309
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
310
- * via the `definition` "shapeSchema".
311
- */
312
- export type ShapeSchema = ShapeSchemaAllOf | ShapeSchemaExtends | ShapeSchemaOneOf | ShapeSchemaEnum | ObjectSchema | ShapeSchemaAny;
313
- /**
314
- * Human-readable id for use in the UI
315
- */
316
- export type WorkflowName = string;
317
- /**
318
- * machine-readable slug
319
- */
320
- export type Name = string;
321
- /**
322
- * Human-readable id for use in the UI
323
- */
324
- export type Title = string;
325
- export type Description = string;
326
- /**
327
- * Hex color code
328
- */
329
- export type Color = string;
330
- /**
331
- * Value to indicate whether items in the state should be returned in list queries
332
- */
333
- export type Live = boolean;
334
- /**
335
- * machine-readable id
336
- */
337
- export type Key = string;
338
- export type Steps = WorkflowStep[];
339
- /**
340
- * The general type of this service, specifying how and where it will be utilized.
341
- *
342
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
343
- * via the `definition` "serviceType".
344
- */
345
- export type ServiceType = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
346
- /**
347
- * The name of a health check to run
348
- */
349
- export type CheckName = 'graphqlIntrospection' | 'ping' | 'none';
350
- /**
351
- * The endpoint to use when checking the service health.
352
- */
353
- export type Endpoint = string;
354
- /**
355
- * A custom method to use for the health check request.
356
- */
357
- export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
358
- /**
359
- * A custom body to send along with the ping request.
360
- */
361
- export type RequestBody = string;
362
- /**
363
- * A custom body to send along with the ping request.
364
- */
365
- export type RequestBodyFormat = 'string' | 'form' | 'json' | 'form-data';
366
- /**
367
- * The amount of time to wait when receiving a response from the health check, in seconds.
368
- */
369
- export type RequestTimeout = number;
370
- /**
371
- * The response status code that qualifies as healthy.
372
- */
373
- export type HealthyResponseStatusCode = number;
374
- /**
375
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
376
- * via the `definition` "serviceHealthCheckTrigger".
377
- */
378
- export type ServiceHealthCheckTrigger = 'manual' | 'schedule';
379
- /**
380
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
381
- * via the `definition` "agentApiInput".
382
- */
383
- export type AgentAPIInput = AgentAPIMutationInput;
384
- export type InteractionTimeoutMilliseconds = number;
385
- export type AgentStateSessionMemory = AgentStateSessionMemoryAssignment[];
386
- export type Variables = AgentVariable[];
387
- /**
388
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
389
- * via the `definition` "agentExecution".
390
- */
391
- export type AgentExecution = AgentExecutionGraphQL | AgentExecutionGenerate | AgentExecutionChat;
392
- /**
393
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
394
- * via the `definition` "agentAiStateInput".
395
- */
396
- export type AgentAIStateInput = AgentAIStateInputArgument | AgentAIStateInputTemplate;
397
- /**
398
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
399
- * via the `definition` "agentToolConfigArg".
400
- */
401
- export type AgentToolConfigArg = AgentControlled | VariableValue;
402
- /**
403
- * The argument name that will be exposed by the tool for the LLM to use.
404
- */
405
- export type ToolArgumentName = string;
406
- /**
407
- * Name of argument to pass value to. This prevents the LLM from setting the argument.
408
- */
409
- export type ToolArgumentName1 = string;
410
- /**
411
- * Name of variable to pull value from.
412
- */
413
- export type StateVariableName = string;
414
- export type History1 = boolean;
415
- /**
416
- * Maximum number of tokens to generate. Defaults to 1024
417
- */
418
- export type MaximumTokens1 = number;
419
- /**
420
- * This is a number between 0 (almost no randomness) and 1 (very random). It is recommended to set either `temperature` or `topP`, but not both. Defaults to 0
421
- */
422
- export type Temperature1 = number;
423
- /**
424
- * Nucleus sampling. This is a number between 0 and 1. E.g. 0.1 would mean that only tokens with the top 10% probability mass are considered. It is recommended to set either `temperature` or `topP`, but not both.
425
- */
426
- export type TopP1 = number;
427
- /**
428
- * Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Recommended for advanced use cases only. You usually only need to use temperature.
429
- */
430
- export type TopK1 = number;
431
- /**
432
- * It affects the likelihood of the model to repeat information that is already in the prompt. The presence penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
433
- */
434
- export type PresencePenaltySetting1 = number;
435
- /**
436
- * It affects the likelihood of the model to repeatedly use the same words or phrases. The frequency penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
437
- */
438
- export type FrequencyPenaltySetting1 = number;
439
- /**
440
- * If set, the model will stop generating text when one of the stop sequences is generated.
441
- */
442
- export type StopSequences1 = string[];
443
- /**
444
- * The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
445
- */
446
- export type Seed1 = number;
447
- /**
448
- * Maximal number of automatic roundtrips for tool calls.
449
- */
450
- export type MaxToolRoundtrips = number;
451
- /**
452
- * If true, structured outputs will be enabled on the model for non-text requests.
453
- */
454
- export type StructuredOutputs = boolean;
455
- /**
456
- * Enable OpenAI schema format. Must be enabled if `structuredOutputs` is enabled.
457
- */
458
- export type EnableOpenAISchemaFormat = boolean;
459
- export type MinimatchPattern = string;
460
- /**
461
- * Remove properties from the schema sent to the model with keys matching these minimatch glob patterns.
462
- *
463
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
464
- * via the `definition` "removePropertyKeyPatterns".
465
- */
466
- export type RemovePropertyKeyPatterns = MinimatchPattern[];
467
- /**
468
- * Remove Markdown formatting from the LLM response
469
- */
470
- export type StripMarkdown = boolean;
471
- /**
472
- * These steps are evaluated in order until a destination is found.
473
- *
474
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
475
- * via the `definition` "agentTransition".
476
- */
477
- export type AgentTransition = AgentTransitionImmediate | AgentTransitionSuspend;
478
- export type AgentStateSessionMemory1 = AgentStateSessionMemoryAssignment[];
479
- export type GuardID = string;
480
- export type Variables1 = AgentVariable[];
481
- /**
482
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
483
- * via the `definition` "historyStrategyTransform".
484
- */
485
- export type HistoryStrategyTransform = HistoryStrategyTransformNone | HistoryStrategyTransformReplace | HistoryStrategyTransformSummarize;
486
- /**
487
- * Enabling this will require a proof-of-work token to be included with each request. This will prevent abuse and spam.
488
- */
489
- export type EnableAgentAbuseProtection = boolean;
490
- /**
491
- * The human-readable name of the Guard.
492
- */
493
- export type Name1 = string;
494
- /**
495
- * A description of the Guard.
496
- */
497
- export type Description1 = string;
498
- /**
499
- * Guards will not run unless enabled.
500
- */
501
- export type Enabled = boolean;
502
- /**
503
- * The remote id of the Guardrail.
504
- */
505
- export type GuardrailIdentifier = string;
506
- /**
507
- * The remote version of the Guardrail.
508
- */
509
- export type GuardrailVersion = string;
510
- /**
511
- * A message to return when the input message is blocked by the Guard.
512
- */
513
- export type BlockedInputMessaging = string;
514
- /**
515
- * A message to return when the output message is blocked by the Guard.
516
- */
517
- export type BlockedOutputsMessaging = string;
518
- export type Example = string;
519
- /**
520
- * A topic to block.
521
- */
522
- export type Topic = {
523
- name: string;
524
- definition: string;
525
- /**
526
- * Examples of the topic that can hint the LLM.
527
- */
528
- examples?: Example[];
529
- type: 'DENY';
530
- }[];
531
- export type InputStrength = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
532
- export type OutputStrength = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
533
- /**
534
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
535
- * via the `definition` "guardrailModality".
536
- */
537
- export type GuardrailModality = 'TEXT' | 'IMAGE';
538
- /**
539
- * Whether to filter images or text
540
- */
541
- export type InputModalities = GuardrailModality[];
542
- /**
543
- * Whether to filter images or text
544
- */
545
- export type OutputModalities = GuardrailModality[];
546
- /**
547
- * Types of content to filter.
548
- */
549
- export type Filter = {
550
- type: 'HATE' | 'INSULTS' | 'MICONDUCT' | 'PROMPT_ATTACK' | 'SEXUAL' | 'VIOLENCE';
551
- inputStrength: InputStrength;
552
- outputStrength: OutputStrength;
553
- inputModalities?: InputModalities;
554
- outputModalities?: OutputModalities;
555
- }[];
556
- /**
557
- * Specific words to block.
558
- */
559
- export type WordList = {
560
- text: string;
561
- }[];
562
- /**
563
- * This is solely used for blocking profanity.
564
- */
565
- export type ManagedWordList = {
566
- type: 'PROFANITY';
567
- }[];
568
- /**
569
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
570
- * via the `definition` "guardrailSensitiveInformationAction".
571
- */
572
- export type GuardrailSensitiveInformationAction = 'ANONYMIZE' | 'BLOCK';
573
- /**
574
- * PII entity to infer from the text.
575
- */
576
- export type PIIEntity = {
577
- type: 'ADDRESS' | 'AGE' | 'AWS_ACCESS_KEY' | 'AWS_SECRET_KEY' | 'CA_HEALTH_NUMBER' | 'CA_SOCIAL_INSURANCE_NUMBER' | 'CREDIT_DEBIT_CARD_CVV' | 'CREDIT_DEBIT_CARD_EXPIRY' | 'CREDIT_DEBIT_CARD_NUMBER' | 'DRIVER_ID' | 'EMAIL' | 'INTERNATIONAL_BANK_ACCOUNT_NUMBER' | 'IP_ADDRESS' | 'LICENSE_PLATE' | 'MAC_ADDRESS' | 'NAME' | 'PASSWORD' | 'PHONE' | 'PIN' | 'SWIFT_CODE' | 'UK_NATIONAL_HEALTH_SERVICE_NUMBER' | 'UK_NATIONAL_INSURANCE_NUMBER' | 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER' | 'URL' | 'USERNAME' | 'US_BANK_ACCOUNT_NUMBER' | 'US_BANK_ROUTING_NUMBER' | 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER' | 'US_PASSPORT_NUMBER' | 'US_SOCIAL_SECURITY_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER';
578
- action: GuardrailSensitiveInformationAction;
579
- }[];
580
- /**
581
- * A regular expression to match sensitive information.
582
- */
583
- export type RegularExpression = {
584
- name: string;
585
- description?: string;
586
- pattern: string;
587
- action: GuardrailSensitiveInformationAction;
588
- }[];
589
- /**
590
- * The type of filter.
591
- */
592
- export type Type = 'GROUNDING' | 'RELEVANCE';
593
- /**
594
- * The threshold for the filter as a floating point value greater than 0.0 and less than 1.0.
595
- */
596
- export type Threshold = number;
597
- /**
598
- * Filter to evaluate grounding text.
599
- */
600
- export type Filter1 = {
601
- type: Type;
602
- threshold: Threshold;
603
- }[];
604
- /**
605
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
606
- * via the `definition` "toolArg".
607
- */
608
- export type ToolArg = AgentControlled;
609
- /**
610
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
611
- * via the `definition` "allOfSchema".
612
- */
613
- export type AllOfSchema = PropertySchema & {
614
- allOf: ObjectOrRefArray;
615
- };
616
- /**
617
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
618
- * via the `definition` "oneOfSchema".
619
- */
620
- export type OneOfSchema = PropertySchema & {
621
- oneOf: ObjectOrRefArray;
622
- };
623
- /**
624
- * Options to be passed to the serialization routine.
625
- *
626
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
627
- * via the `definition` "parameterSerializeOptions".
628
- *
629
- * This interface was referenced by `undefined`'s JSON-Schema definition
630
- * via the `patternProperty` "^[^\n\r]*$".
631
- */
632
- export type ParameterSerializeOptions = ParameterSerializeStyleOptions | ParameterSerializeContentOptions;
633
- /**
634
- * An array of key / value or directive config tuples
635
- *
636
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
637
- * via the `definition` "directiveMappingArray".
638
- */
639
- export type DirectiveMappingArray = DirectiveMappingArrayItem[];
640
- /**
641
- * A resolver which references a specific service
642
- *
643
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
644
- * via the `definition` "serviceResolver".
645
- */
646
- export type ServiceResolver = TakeshapeResolver | ShapedbResolverShapeNameNotRequired | ShapedbResolver | GraphqlResolver | RestResolver | AwsLambdaResolver;
647
- /**
648
- * An array of key / value or directive config tuples
649
- *
650
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
651
- * via the `definition` "searchParamsMapping".
652
- */
653
- export type SearchParamsMapping1 = DirectiveMappingArrayItem[];
654
- /**
655
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
656
- * via the `definition` "shapeWithObjectSchema".
657
- */
658
- export type ShapeWithObjectSchema = ShapeJSON & {
659
- schema: ObjectSchema;
660
- };
661
- /**
662
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
663
- * via the `definition` "serviceAuthentication".
664
- */
665
- export type ServiceAuthentication = OAuth2Authentication | OAuth2BearerAuthentication | BearerAuthentication | BasicAuthentication | SearchParamsAuthentication | AWSAuthentication | GoogleAuthentication | CustomAuthentication;
666
- /**
667
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
668
- * via the `definition` "anyServiceConfig".
669
- */
670
- export type AnyServiceConfig = ServiceConfigJSON | ServiceConfig;
671
- export interface ProjectSchemaJSON {
672
- $schema?: string;
673
- /**
674
- * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
675
- */
676
- apiVersion: string;
677
- /**
678
- * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
679
- */
680
- schemaVersion: '3.59.0';
681
- /**
682
- * The ID of the TakeShape project this schema belongs to.
683
- */
684
- projectId: string;
685
- /**
686
- * The ID of the TakeShape user who created the schema.
687
- */
688
- author?: string;
689
- deactivated?: number;
690
- /**
691
- * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
692
- */
693
- defaultLocale: string;
694
- locales: string[];
695
- queries: QueryMap;
696
- mutations: QueryMap;
697
- shapes: ShapeMap;
698
- forms?: FormMap;
699
- workflows: WorkflowMap;
700
- services?: ServiceMapJSON;
701
- agents?: AgentMap;
702
- guards?: GuardMap;
703
- mcp?: MCPServerConfiguration;
704
- }
705
- /**
706
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
707
- * via the `definition` "queryMap".
708
- */
709
- export interface QueryMap {
710
- [k: string]: QueryJSON;
711
- }
712
- /**
713
- * This interface was referenced by `QueryMap`'s JSON-Schema definition
714
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
715
- *
716
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
717
- * via the `definition` "query".
718
- */
719
- export interface QueryJSON {
720
- args?: Args;
721
- resolver: Resolver;
722
- shape: ReturnShape;
723
- /**
724
- * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
725
- */
726
- description?: string;
727
- }
728
- /**
729
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
730
- * via the `definition` "propertySchema".
731
- */
732
- export interface PropertySchema {
733
- $ref?: string;
734
- title?: string;
735
- description?: string;
736
- default?: any;
737
- readOnly?: boolean;
738
- multipleOf?: number;
739
- maximum?: number;
740
- exclusiveMaximum?: number;
741
- minimum?: number;
742
- exclusiveMinimum?: number;
743
- maxLength?: NonNegativeInteger;
744
- minLength?: NonNegativeIntegerDefault0;
745
- pattern?: string;
746
- additionalItems?: PropertySchema;
747
- items?: PropertySchema;
748
- maxItems?: NonNegativeInteger;
749
- minItems?: NonNegativeIntegerDefault0;
750
- uniqueItems?: boolean;
751
- contains?: PropertySchema;
752
- maxProperties?: NonNegativeInteger;
753
- minProperties?: NonNegativeIntegerDefault0;
754
- required?: StringArray;
755
- additionalProperties?: PropertySchema | false;
756
- definitions?: {
757
- [k: string]: PropertySchema;
758
- };
759
- properties?: {
760
- [k: string]: PropertySchema;
761
- };
762
- const?: any;
763
- enum?: any[];
764
- type?: SimpleTypes | SimpleTypes[];
765
- format?: string;
766
- contentMediaType?: string;
767
- contentEncoding?: string;
768
- allOf?: SchemaArray;
769
- discriminator?: {
770
- propertyName?: string;
771
- [k: string]: any;
772
- };
773
- oneOf?: SchemaArray;
774
- extends?: ObjectOrRefArray;
775
- '@backreference'?: BackReference;
776
- '@input'?: PropertySchema;
777
- '@output'?: PropertySchema;
778
- '@syncLocaleStructure'?: boolean;
779
- '@sensitive'?: boolean;
780
- '@draftjs'?: boolean;
781
- '@l10n'?: boolean;
782
- '@key'?: string;
783
- '@workflow'?: string;
784
- '@mapping'?: FieldMapping;
785
- '@tag'?: string;
786
- '@tags'?: string[];
787
- '@deprecationReason'?: string;
788
- '@args'?: Args;
789
- '@resolver'?: Resolver;
790
- '@dependencies'?: Dependencies;
791
- '@ref'?: Ref;
792
- '@derivedFrom'?: string;
793
- '@indexed'?: Indexed;
794
- '@graphql'?: GraphQLConfig;
795
- }
796
- /**
797
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
798
- * via the `definition` "refSchema".
799
- */
800
- export interface RefSchema {
801
- '@ref': Ref;
802
- [k: string]: any;
803
- }
804
- /**
805
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
806
- * via the `definition` "refSchemaLegacy".
807
- */
808
- export interface RefSchemaLegacy {
809
- $ref: Ref;
810
- [k: string]: any;
811
- }
812
- /**
813
- * A configuration object for a reverse reference in a relationship.
814
- *
815
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
816
- * via the `definition` "backreference".
817
- */
818
- export interface BackReference {
819
- enabled: boolean;
820
- name?: string;
821
- }
822
- /**
823
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
824
- * via the `definition` "utilResolver".
825
- */
826
- export interface UtilResolver {
827
- if?: string;
828
- id?: string;
829
- name: UtilResolverName;
830
- options?: UtilResolverOptions;
831
- /**
832
- * Optional value to return from the noop resolver.
833
- */
834
- value?: number | string | boolean | {
835
- [k: string]: any;
836
- } | any[] | null;
837
- args?: ParameterConfigForJson;
838
- results?: ParameterConfigForJson;
839
- argsMapping?: ArgsMapping;
840
- resultsMapping?: ResultsMapping;
841
- }
842
- export interface UtilResolverOptions {
843
- [k: string]: any;
844
- }
845
- /**
846
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
847
- * via the `definition` "parameterConfigForJson".
848
- */
849
- export interface ParameterConfigForJson {
850
- ops: ParameterOpList;
851
- }
852
- /**
853
- * An object describing an operation to generate a parameter, using a nested OpList.
854
- *
855
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
856
- * via the `definition` "parameterOpNested".
857
- */
858
- export interface ParameterOpNested {
859
- /**
860
- * A path to the parameter for this operation.
861
- */
862
- path: string;
863
- /**
864
- * A mode for this parameter's operation.
865
- */
866
- op?: 'set' | 'concat' | 'extend' | 'remove';
867
- ops: ParameterOpList;
868
- }
869
- /**
870
- * An object describing an operation to generate a parameter using a value.
871
- *
872
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
873
- * via the `definition` "parameterOpValue".
874
- */
875
- export interface ParameterOpValue {
876
- /**
877
- * A path to the parameter for this operation.
878
- */
879
- path: string;
880
- /**
881
- * A mode for this parameter's operation.
882
- */
883
- op?: 'set' | 'concat' | 'extend' | 'remove';
884
- /**
885
- * A value to set directly at this path.
886
- */
887
- value: number | string | boolean | {
888
- [k: string]: any;
889
- } | any[] | null;
890
- }
891
- /**
892
- * An object describing an operation to generate a parameter using a mapping.
893
- *
894
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
895
- * via the `definition` "parameterOpMapping".
896
- */
897
- export interface ParameterOpMapping {
898
- /**
899
- * A path to the parameter for this operation.
900
- */
901
- path: string;
902
- /**
903
- * A mode for this parameter's operation.
904
- */
905
- op?: 'set' | 'concat' | 'extend' | 'remove';
906
- /**
907
- * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
908
- */
909
- mapping: string | DirectiveConfig;
910
- }
911
- export interface DirectiveOptions {
912
- [k: string]: any;
913
- }
914
- /**
915
- * An object describing an operation to generate a parameter using a mapping.
916
- *
917
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
918
- * via the `definition` "parameterOpOp".
919
- */
920
- export interface ParameterOpOp {
921
- /**
922
- * A path to the parameter for this operation.
923
- */
924
- path: string;
925
- /**
926
- * A mode for this parameter's operation.
927
- */
928
- op: 'set' | 'concat' | 'extend' | 'remove';
929
- }
930
- /**
931
- * An map of object keys / key paths to directive configs
932
- *
933
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
934
- * via the `definition` "directiveMappingMap".
935
- */
936
- export interface DirectiveMappingMap {
937
- [k: string]: DirectiveConfig;
938
- }
939
- /**
940
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
941
- * via the `definition` "delegateResolver".
942
- */
943
- export interface DelegateResolver {
944
- if?: string;
945
- id?: string;
946
- name: DelegateResolverName;
947
- options?: DelegateResolverOptions;
948
- argsMapping?: ArgsMapping;
949
- resultsMapping?: ResultsMapping;
950
- /**
951
- * A ref to a query/mutation/property to delegate to.
952
- */
953
- to: string;
954
- args?: ParameterConfigForJson;
955
- results?: ParameterConfigForJson;
956
- }
957
- export interface DelegateResolverOptions {
958
- [k: string]: any;
959
- }
960
- /**
961
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
962
- * via the `definition` "takeshapeResolver".
963
- */
964
- export interface TakeshapeResolver {
965
- if?: string;
966
- id?: string;
967
- name: TakeshapeResolverName;
968
- /**
969
- * Internal service identifier.
970
- */
971
- service: 'takeshape';
972
- options?: TakeshapeResolverOptions;
973
- /**
974
- * An optional Shape name for the resolver.
975
- */
976
- shapeName?: string;
977
- args?: ParameterConfigForJson;
978
- results?: ParameterConfigForJson;
979
- argsMapping?: ArgsMapping;
980
- resultsMapping?: ResultsMapping;
981
- }
982
- export interface TakeshapeResolverOptions {
983
- [k: string]: any;
984
- }
985
- /**
986
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
987
- * via the `definition` "shapedbResolver".
988
- */
989
- export interface ShapedbResolver {
990
- if?: string;
991
- id?: string;
992
- name: ShapedbResolverName;
993
- /**
994
- * Internal service identifier.
995
- */
996
- service: 'shapedb';
997
- options?: ShapedbResolverOptions;
998
- argsMapping?: ArgsMapping;
999
- resultsMapping?: ResultsMapping;
1000
- /**
1001
- * A Shape name for the resolver to use.
1002
- */
1003
- shapeName: string;
1004
- args?: ParameterConfigForJson;
1005
- results?: ParameterConfigForJson;
1006
- }
1007
- export interface ShapedbResolverOptions {
1008
- [k: string]: any;
1009
- }
1010
- /**
1011
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1012
- * via the `definition` "shapedbResolverShapeNameNotRequired".
1013
- */
1014
- export interface ShapedbResolverShapeNameNotRequired {
1015
- if?: string;
1016
- id?: string;
1017
- name: ShapedbResolverShapeNameNotRequiredName;
1018
- /**
1019
- * Internal service identifier.
1020
- */
1021
- service: 'shapedb';
1022
- options?: ShapedbResolverShapeNameNotRequiredOptions;
1023
- /**
1024
- * An optional Shape name for the resolver.
1025
- */
1026
- shapeName?: string;
1027
- args?: ParameterConfigForJson;
1028
- results?: ParameterConfigForJson;
1029
- argsMapping?: ArgsMapping;
1030
- resultsMapping?: ResultsMapping;
1031
- }
1032
- export interface ShapedbResolverShapeNameNotRequiredOptions {
1033
- [k: string]: any;
1034
- }
1035
- /**
1036
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1037
- * via the `definition` "graphqlResolver".
1038
- */
1039
- export interface GraphqlResolver {
1040
- if?: string;
1041
- id?: string;
1042
- name: GraphqlResolverName;
1043
- /**
1044
- * Configuration for a service to use with this resolver.
1045
- */
1046
- service: string;
1047
- argsMapping?: ArgsMapping;
1048
- resultsMapping?: ResultsMapping;
1049
- options?: GraphqlResolverOptions;
1050
- /**
1051
- * A fieldname to use in queries.
1052
- */
1053
- fieldName: string;
1054
- headers?: ParameterConfigForHeaders;
1055
- searchParams?: ParameterConfigForSearchParams;
1056
- args?: ParameterConfigForJson;
1057
- results?: ParameterConfigForJson;
1058
- }
1059
- export interface GraphqlResolverOptions {
1060
- selectionSet?: string;
1061
- unboxParentSelectionSet?: boolean;
1062
- ignoreErrors?: boolean;
1063
- skipWhenMissingArgs?: boolean;
1064
- ttl?: number;
1065
- timeout?: number;
1066
- allowStream?: boolean;
1067
- retry?: number | {
1068
- [k: string]: any;
1069
- };
1070
- [k: string]: any;
1071
- }
1072
- /**
1073
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1074
- * via the `definition` "parameterConfigForHeaders".
1075
- */
1076
- export interface ParameterConfigForHeaders {
1077
- ops: ParameterOpList;
1078
- serialize?: ParameterSerializeConfigForHeaders;
1079
- }
1080
- /**
1081
- * Top-level paths to use headers serialization options for.
1082
- *
1083
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1084
- * via the `definition` "parameterSerializeConfigForHeaders".
1085
- */
1086
- export interface ParameterSerializeConfigForHeaders {
1087
- defaults?: ParameterSerializeStyleOptionsForHeaders | ParameterSerializeContentOptions;
1088
- paths?: {
1089
- /**
1090
- * This interface was referenced by `undefined`'s JSON-Schema definition
1091
- * via the `patternProperty` "^[^\n\r]*$".
1092
- */
1093
- [k: string]: ParameterSerializeStyleOptionsForHeaders | ParameterSerializeContentOptions;
1094
- };
1095
- }
1096
- /**
1097
- * Options to be passed to the serialization routine.
1098
- *
1099
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1100
- * via the `definition` "parameterSerializeStyleOptionsForHeaders".
1101
- */
1102
- export interface ParameterSerializeStyleOptionsForHeaders {
1103
- style: 'simple' | 'none';
1104
- explode?: boolean;
1105
- }
1106
- /**
1107
- * Options to be passed to the serialization routine.
1108
- *
1109
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1110
- * via the `definition` "parameterSerializeContentOptions".
1111
- */
1112
- export interface ParameterSerializeContentOptions {
1113
- contentType: string;
1114
- /**
1115
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1116
- */
1117
- allowReserved?: boolean;
1118
- skipEncoding?: boolean;
1119
- /**
1120
- * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
1121
- */
1122
- options?: {
1123
- [k: string]: any;
1124
- };
1125
- }
1126
- /**
1127
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1128
- * via the `definition` "parameterConfigForSearchParams".
1129
- */
1130
- export interface ParameterConfigForSearchParams {
1131
- ops: ParameterOpList;
1132
- serialize?: ParameterSerializeConfigForSearchParams;
1133
- }
1134
- /**
1135
- * Top-level paths to use search params serialization options for.
1136
- *
1137
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1138
- * via the `definition` "parameterSerializeConfigForSearchParams".
1139
- */
1140
- export interface ParameterSerializeConfigForSearchParams {
1141
- defaults?: ParameterSerializeStyleOptionsForSearchParams | ParameterSerializeContentOptions;
1142
- paths?: {
1143
- /**
1144
- * This interface was referenced by `undefined`'s JSON-Schema definition
1145
- * via the `patternProperty` "^[^\n\r]*$".
1146
- */
1147
- [k: string]: ParameterSerializeStyleOptionsForSearchParams | ParameterSerializeContentOptions;
1148
- };
1149
- }
1150
- /**
1151
- * Options to be passed to the serialization routine.
1152
- *
1153
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1154
- * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
1155
- */
1156
- export interface ParameterSerializeStyleOptionsForSearchParams {
1157
- style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
1158
- explode?: boolean;
1159
- allowEmptyValue?: boolean;
1160
- /**
1161
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1162
- */
1163
- allowReserved?: boolean;
1164
- skipEncoding?: boolean;
1165
- }
1166
- /**
1167
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1168
- * via the `definition` "restResolver".
1169
- */
1170
- export interface RestResolver {
1171
- if?: string;
1172
- id?: string;
1173
- name: RestResolverName;
1174
- /**
1175
- * Configuration for a service to use with this resolver.
1176
- */
1177
- service: string;
1178
- argsMapping?: ArgsMapping;
1179
- searchParamsMapping?: SearchParamsMapping;
1180
- resultsMapping?: ResultsMapping;
1181
- options?: RestResolverOptions;
1182
- body?: ParameterConfigForBody;
1183
- form?: ParameterConfigForSearchParams;
1184
- headers?: ParameterConfigForHeaders;
1185
- json?: ParameterConfigForJson;
1186
- /**
1187
- * Mapping and serialization configuration for the path, or a simple string.
1188
- */
1189
- path: ParameterConfigForPathParams | string;
1190
- searchParams?: ParameterConfigForSearchParams;
1191
- args?: ParameterConfigForJson;
1192
- results?: ParameterConfigForJson;
1193
- }
1194
- export interface RestResolverOptions {
1195
- trailingSlash?: boolean;
1196
- allowStream?: boolean;
1197
- ttl?: number;
1198
- timeout?: number;
1199
- retry?: number | {
1200
- [k: string]: any;
1201
- };
1202
- [k: string]: any;
1203
- }
1204
- /**
1205
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1206
- * via the `definition` "parameterConfigForBody".
1207
- */
1208
- export interface ParameterConfigForBody {
1209
- ops: ParameterOpList;
1210
- serialize?: ParameterSerializeConfigForBody;
1211
- }
1212
- /**
1213
- * Top-level paths to use serialization options for.
1214
- *
1215
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1216
- * via the `definition` "parameterSerializeConfigForBody".
1217
- */
1218
- export interface ParameterSerializeConfigForBody {
1219
- content?: ParameterSerializeContentOptions;
1220
- }
1221
- /**
1222
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1223
- * via the `definition` "parameterConfigForPathParams".
1224
- */
1225
- export interface ParameterConfigForPathParams {
1226
- ops: ParameterOpList;
1227
- serialize: ParameterSerializeConfigForPathParams;
1228
- }
1229
- /**
1230
- * Top-level paths to use path params serialization options for.
1231
- *
1232
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1233
- * via the `definition` "parameterSerializeConfigForPathParams".
1234
- */
1235
- export interface ParameterSerializeConfigForPathParams {
1236
- /**
1237
- * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
1238
- */
1239
- template: string;
1240
- defaults?: ParameterSerializeStyleOptionsForPathParams | ParameterSerializeContentOptions;
1241
- paths?: {
1242
- /**
1243
- * This interface was referenced by `undefined`'s JSON-Schema definition
1244
- * via the `patternProperty` "^[^\n\r]*$".
1245
- */
1246
- [k: string]: ParameterSerializeStyleOptionsForPathParams | ParameterSerializeContentOptions;
1247
- };
1248
- }
1249
- /**
1250
- * Options to be passed to the serialization routine.
1251
- *
1252
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1253
- * via the `definition` "parameterSerializeStyleOptionsForPathParams".
1254
- */
1255
- export interface ParameterSerializeStyleOptionsForPathParams {
1256
- style: 'simple' | 'label' | 'matrix' | 'none';
1257
- explode?: boolean;
1258
- allowEmptyValue?: boolean;
1259
- /**
1260
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1261
- */
1262
- allowReserved?: boolean;
1263
- skipEncoding?: boolean;
1264
- }
1265
- /**
1266
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1267
- * via the `definition` "awsLambdaResolver".
1268
- */
1269
- export interface AwsLambdaResolver {
1270
- if?: string;
1271
- id?: string;
1272
- name: AwsLambdaResolverName;
1273
- /**
1274
- * Configuration for a service to use with this resolver.
1275
- */
1276
- service: string;
1277
- options?: AwsLambdaResolverOptions;
1278
- payload?: ParameterConfigForJson;
1279
- /**
1280
- * Mapping configuration for the FunctionName.
1281
- */
1282
- functionName: string | ParameterConfigForAwsLambda;
1283
- clientContext?: ParameterConfigForJson;
1284
- args?: ParameterConfigForJson;
1285
- results?: ParameterConfigForJson;
1286
- argsMapping?: ArgsMapping;
1287
- searchParamsMapping?: SearchParamsMapping;
1288
- resultsMapping?: ResultsMapping;
1289
- }
1290
- export interface AwsLambdaResolverOptions {
1291
- [k: string]: any;
1292
- }
1293
- /**
1294
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1295
- * via the `definition` "parameterConfigForAwsLambda".
1296
- */
1297
- export interface ParameterConfigForAwsLambda {
1298
- ops: ParameterOpList;
1299
- serialize: ParameterSerializeConfigForPathParams;
1300
- }
1301
- /**
1302
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1303
- * via the `definition` "salsifyResolver".
1304
- */
1305
- export interface SalsifyResolver {
1306
- if?: string;
1307
- id?: string;
1308
- name: SalsifyResolverName;
1309
- /**
1310
- * Configuration for a service to use with this resolver.
1311
- */
1312
- service: string;
1313
- options?: SalsifyResolverOptions;
1314
- args?: ParameterConfigForJson;
1315
- results?: ParameterConfigForJson;
1316
- argsMapping?: ArgsMapping;
1317
- resultsMapping?: ResultsMapping;
1318
- }
1319
- export interface SalsifyResolverOptions {
1320
- [k: string]: any;
1321
- }
1322
- /**
1323
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1324
- * via the `definition` "syndigoResolver".
1325
- */
1326
- export interface SyndigoResolver {
1327
- if?: string;
1328
- id?: string;
1329
- name: SyndigoResolverName;
1330
- /**
1331
- * Configuration for a service to use with this resolver.
1332
- */
1333
- service: string;
1334
- options?: SyndigoResolverOptions;
1335
- args?: ParameterConfigForJson;
1336
- results?: ParameterConfigForJson;
1337
- argsMapping?: ArgsMapping;
1338
- resultsMapping?: ResultsMapping;
1339
- }
1340
- export interface SyndigoResolverOptions {
1341
- [k: string]: any;
1342
- }
1343
- /**
1344
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1345
- * via the `definition` "functionResolver".
1346
- */
1347
- export interface FunctionResolver {
1348
- if?: string;
1349
- id?: string;
1350
- name: FunctionResolverName;
1351
- options?: FunctionResolverOptions;
1352
- args?: ParameterConfigForJson;
1353
- results?: ParameterConfigForJson;
1354
- argsMapping?: ArgsMapping;
1355
- resultsMapping?: ResultsMapping;
1356
- javascript?: FunctionResolverJavascript;
1357
- }
1358
- export interface FunctionResolverOptions {
1359
- [k: string]: any;
1360
- }
1361
- /**
1362
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1363
- * via the `definition` "aiGenerateTextResolver".
1364
- */
1365
- export interface AIGenerateTextResolver {
1366
- if?: string;
1367
- id?: string;
1368
- name: AIResolverName;
1369
- /**
1370
- * Configuration for a service to use with this resolver.
1371
- */
1372
- service: string;
1373
- options?: AIGenerateTextResolverOptions;
1374
- systemPrompt: string;
1375
- inputTemplate?: string;
1376
- model: string;
1377
- tools?: (string | AIToolConfig)[];
1378
- guardrails?: AIGuardrail[];
1379
- context?: ParameterConfigForJson;
1380
- results?: ParameterConfigForJson;
1381
- }
1382
- /**
1383
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1384
- * via the `definition` "aiGenerateTextResolverOptions".
1385
- */
1386
- export interface AIGenerateTextResolverOptions {
1387
- history?: History;
1388
- maxTokens?: MaximumTokens;
1389
- temperature?: Temperature;
1390
- topP?: TopP;
1391
- topK?: TopK;
1392
- presencePenalty?: PresencePenaltySetting;
1393
- frequencyPenalty?: FrequencyPenaltySetting;
1394
- stopSequences?: StopSequences;
1395
- seed?: Seed;
1396
- /**
1397
- * Maximum number of retries. Set to 0 to disable retries. Defaults to 2
1398
- */
1399
- maxRetries?: number;
1400
- /**
1401
- * The tool choice strategy. Default: 'auto'
1402
- */
1403
- toolChoice?: (('auto' | 'none' | 'required') | string) & string;
1404
- /**
1405
- * Maximal number of automatic roundtrips for tool calls.
1406
- */
1407
- maxToolRoundtrips?: number;
1408
- [k: string]: any;
1409
- }
1410
- /**
1411
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1412
- * via the `definition` "aiToolConfig".
1413
- */
1414
- export interface AIToolConfig {
1415
- ref: string;
1416
- selectionSet?: string;
1417
- }
1418
- /**
1419
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1420
- * via the `definition` "aiSimilarityGuardrail".
1421
- */
1422
- export interface AISimilarityGuardrail {
1423
- name: 'similarity';
1424
- shape: string;
1425
- defaultResponse: string;
1426
- threshold?: number;
1427
- }
1428
- /**
1429
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1430
- * via the `definition` "aiGeneratePropertyResolver".
1431
- */
1432
- export interface AIGeneratePropertyResolver {
1433
- id?: string;
1434
- name: AIResolverName1;
1435
- /**
1436
- * Configuration for a service to use with this resolver.
1437
- */
1438
- service: string;
1439
- model: string;
1440
- systemPrompt?: string;
1441
- }
1442
- /**
1443
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1444
- * via the `definition` "aiEmbeddingResolver".
1445
- */
1446
- export interface AIEmbeddingResolver {
1447
- if?: string;
1448
- id?: string;
1449
- name: AIResolverName2;
1450
- /**
1451
- * Configuration for a service to use with this resolver.
1452
- */
1453
- service: string;
1454
- options?: AIEmbeddingResolverOptions;
1455
- model: string;
1456
- args?: ParameterConfigForJson;
1457
- results?: ParameterConfigForJson;
1458
- }
1459
- /**
1460
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1461
- * via the `definition` "aiEmbeddingResolverOptions".
1462
- */
1463
- export interface AIEmbeddingResolverOptions {
1464
- useDependencies?: boolean;
1465
- [k: string]: any;
1466
- }
1467
- /**
1468
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1469
- * via the `definition` "aiEmbeddingSearchResolver".
1470
- */
1471
- export interface AIEmbeddingSearchResolver {
1472
- if?: string;
1473
- id?: string;
1474
- name: AIResolverName3;
1475
- /**
1476
- * A vector property ref to use for the query.
1477
- */
1478
- vectorProperty: string;
1479
- args?: ParameterConfigForJson;
1480
- results?: ParameterConfigForJson;
1481
- }
1482
- /**
1483
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1484
- * via the `definition` "aiParseFileResolver".
1485
- */
1486
- export interface AIParseFileResolver {
1487
- if?: string;
1488
- id?: string;
1489
- name: AIResolverName4;
1490
- /**
1491
- * Configuration for a service to use with this resolver.
1492
- */
1493
- service: string;
1494
- options?: AIEmbeddingResolverOptions;
1495
- args?: ParameterConfigForJson;
1496
- results?: ParameterConfigForJson;
1497
- }
1498
- /**
1499
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1500
- * via the `definition` "utilChunkResolver".
1501
- */
1502
- export interface ChunkResolver {
1503
- if?: string;
1504
- id?: string;
1505
- name: UtilResolverName1;
1506
- options: UtilChunkResolverOptions;
1507
- args?: ParameterConfigForJson;
1508
- results?: ParameterConfigForJson;
1509
- }
1510
- /**
1511
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1512
- * via the `definition` "utilChunkResolverOptionsCharacterCount".
1513
- */
1514
- export interface UtilChunkResolverOptionsCharacterCount {
1515
- type: 'characterCount';
1516
- characterCount: number;
1517
- }
1518
- /**
1519
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1520
- * via the `definition` "utilChunkResolverOptionsSeparators".
1521
- */
1522
- export interface UtilChunkResolverOptionsSeparators {
1523
- type: 'separators';
1524
- separators: string[];
1525
- }
1526
- /**
1527
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1528
- * via the `definition` "utilChunkResolverOptionsMarkdown".
1529
- */
1530
- export interface UtilChunkResolverOptionsMarkdown {
1531
- type: 'markdown';
1532
- /**
1533
- * New chunks will be created at headers for this level or lower. Default 2.
1534
- */
1535
- headerLevel?: number;
1536
- /**
1537
- * A new chunk will be started when this number of characters is reached, regardless of markup.
1538
- */
1539
- maxCharacters?: number;
1540
- }
1541
- /**
1542
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1543
- * via the `definition` "utilChunkResolverOptionsSemantic".
1544
- */
1545
- export interface UtilChunkResolverOptionsSemantic {
1546
- type: 'semantic';
1547
- serviceId: string;
1548
- modelId: string;
1549
- /**
1550
- * Similarity below which two embeddings are considered different.
1551
- */
1552
- similarityThreshold?: number;
1553
- /**
1554
- * Advanced. How many sentences to advance when grouping sentences to create embeddings. Default 1.
1555
- */
1556
- stride?: number;
1557
- /**
1558
- * Advanced. How many sentences are grouped together to create embeddings. Default 3.
1559
- */
1560
- sentenceCount?: number;
1561
- /**
1562
- * The maximum number of characters in a chunk.
1563
- */
1564
- maxCharacters?: number;
1565
- /**
1566
- * The maximum number of tokens in a chunk.
1567
- */
1568
- maxTokens?: number;
1569
- }
1570
- /**
1571
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1572
- * via the `definition` "aiRunAgentResolver".
1573
- */
1574
- export interface AISendAgentMessageResolver {
1575
- id?: string;
1576
- name: AIResolverName5;
1577
- agentName: string;
1578
- inputName: string;
1579
- }
1580
- /**
1581
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1582
- * via the `definition` "aiInspectAgentResolver".
1583
- */
1584
- export interface AIInspectAgentResolver {
1585
- id?: string;
1586
- name: AIResolverName6;
1587
- agentName: string;
1588
- }
1589
- /**
1590
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1591
- * via the `definition` "aiCreateAgentSessionResolver".
1592
- */
1593
- export interface AICreateAgentSessionResolver {
1594
- id?: string;
1595
- name: AIResolverName7;
1596
- agentName: string;
1597
- }
1598
- /**
1599
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1600
- * via the `definition` "aiGetAgentMessageResolver".
1601
- */
1602
- export interface AIGetAgentMessageResolver {
1603
- id?: string;
1604
- name: AIResolverName8;
1605
- agentName: string;
1606
- }
1607
- /**
1608
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1609
- * via the `definition` "aiAbortAgentMessageResolver".
1610
- */
1611
- export interface AIAbortAgentMessageResolver {
1612
- id?: string;
1613
- name: AIResolverName9;
1614
- agentName: string;
1615
- }
1616
- /**
1617
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1618
- * via the `definition` "aiSendAgentFeedbackResolver".
1619
- */
1620
- export interface AISendAgentFeedbackResolver {
1621
- id?: string;
1622
- name: AIResolverName10;
1623
- agentName: string;
1624
- }
1625
- /**
1626
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1627
- * via the `definition` "composeResolver".
1628
- */
1629
- export interface ComposeResolver {
1630
- compose: BasicResolver[];
1631
- resultsMapping?: DirectiveMappingMap | DirectiveConfig;
1632
- results?: ParameterConfigForJson;
1633
- }
1634
- /**
1635
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1636
- * via the `definition` "indexed".
1637
- */
1638
- export interface Indexed {
1639
- nested?: boolean;
1640
- }
1641
- /**
1642
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1643
- * via the `definition` "graphql".
1644
- */
1645
- export interface GraphQLConfig {
1646
- json?: boolean;
1647
- }
1648
- /**
1649
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1650
- * via the `definition` "shapeMap".
1651
- */
1652
- export interface ShapeMap {
1653
- [k: string]: ShapeJSON;
1654
- }
1655
- /**
1656
- * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
1657
- *
1658
- * This interface was referenced by `ShapeMap`'s JSON-Schema definition
1659
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
1660
- *
1661
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1662
- * via the `definition` "shape".
1663
- */
1664
- export interface ShapeJSON {
1665
- /**
1666
- * The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations
1667
- */
1668
- name: string;
1669
- /**
1670
- * The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used database as a stable "table name" and changing it will result in orphaning that data.
1671
- */
1672
- id: string;
1673
- /**
1674
- * The human-readable name for a Shape for use in a UI.
1675
- */
1676
- title: string;
1677
- description?: string;
1678
- type?: 'interface' | 'input' | 'output';
1679
- interfaces?: string[];
1680
- /**
1681
- * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
1682
- */
1683
- model?: {
1684
- type: ModelType;
1685
- };
1686
- workflow?: string;
1687
- loaders?: ShapeLoaders;
1688
- joins?: ShapeJoins;
1689
- cache?: ShapeCacheConfig;
1690
- schema: ShapeSchema;
1691
- }
1692
- /**
1693
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1694
- * via the `definition` "shapeLoaders".
1695
- */
1696
- export interface ShapeLoaders {
1697
- list: StoredListQueryLoaderConfig | StoredListQueryLoaderConfig[];
1698
- get?: GetQueryLoaderConfig;
1699
- }
1700
- /**
1701
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1702
- * via the `definition` "storedListQueryLoaderConfig".
1703
- */
1704
- export interface StoredListQueryLoaderConfig {
1705
- query: string;
1706
- args?: {
1707
- [k: string]: any;
1708
- } | {
1709
- [k: string]: any;
1710
- }[];
1711
- pagination?: PaginationConfig;
1712
- }
1713
- /**
1714
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1715
- * via the `definition` "paginationCursorConfig".
1716
- */
1717
- export interface PaginationCursorConfig {
1718
- type: 'cursor';
1719
- cursorArg: string;
1720
- cursorPath: string;
1721
- pageSize?: number;
1722
- pageSizeArg: string;
1723
- hasMorePath: string;
1724
- itemsPath: string;
1725
- }
1726
- /**
1727
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1728
- * via the `definition` "paginationPageConfig".
1729
- */
1730
- export interface PaginationPageConfig {
1731
- type: 'page';
1732
- pageArg: string;
1733
- pageSize?: number;
1734
- pageSizeArg?: string;
1735
- itemsPath: string;
1736
- pageTotalPath: string;
1737
- }
1738
- /**
1739
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1740
- * via the `definition` "paginationOffsetConfig".
1741
- */
1742
- export interface PaginationOffsetConfig {
1743
- type: 'offset';
1744
- offsetArg: string;
1745
- pageSize?: number;
1746
- pageSizeArg?: string;
1747
- itemsPath: string;
1748
- itemTotalPath: string;
1749
- }
1750
- /**
1751
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1752
- * via the `definition` "getQueryLoaderConfig".
1753
- */
1754
- export interface GetQueryLoaderConfig {
1755
- query: string;
1756
- args?: {
1757
- [k: string]: any;
1758
- };
1759
- idArg?: string;
1760
- }
1761
- /**
1762
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1763
- * via the `definition` "shapeJoins".
1764
- */
1765
- export interface ShapeJoins {
1766
- [k: string]: ShapeJoin;
1767
- }
1768
- /**
1769
- * This interface was referenced by `ShapeJoins`'s JSON-Schema definition
1770
- * via the `patternProperty` "[:0-9A-Za-z_-]+".
1771
- *
1772
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1773
- * via the `definition` "shapeJoin".
1774
- */
1775
- export interface ShapeJoin {
1776
- resolver: DelegateResolver | ShapedbResolver;
1777
- dependencies?: string;
1778
- }
1779
- /**
1780
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1781
- * via the `definition` "shapeCacheConfig".
1782
- */
1783
- export interface ShapeCacheConfig {
1784
- enabled: boolean;
1785
- idField?: string;
1786
- searchSummaryField?: string;
1787
- fragment?: CachedFragmentConfig;
1788
- triggers?: CacheTriggerConfig[];
1789
- /**
1790
- * Number of seconds this Shape should be cached. Default 0.
1791
- */
1792
- maxAge?: number;
1793
- /**
1794
- * Requests after maxAge will send a request to origin to revalidate while serving stale content for this duration in the meantime.
1795
- */
1796
- staleWhileRevalidate?: number;
1797
- }
1798
- /**
1799
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1800
- * via the `definition` "cachedFragmentConfig".
1801
- */
1802
- export interface CachedFragmentConfig {
1803
- ignoreFields?: string[];
1804
- maxDepth?: number;
1805
- selectionSet?: string;
1806
- includeDeprecated?: boolean;
1807
- }
1808
- /**
1809
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1810
- * via the `definition` "cacheScheduleTriggerConfig".
1811
- */
1812
- export interface CacheScheduleTriggerConfig {
1813
- type: 'schedule';
1814
- loader: 'get' | 'list';
1815
- interval: number;
1816
- }
1817
- /**
1818
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1819
- * via the `definition` "cacheWebhookTriggerConfig".
1820
- */
1821
- export interface CacheWebhookTriggerConfig {
1822
- type: 'webhook';
1823
- loader: 'get' | 'list';
1824
- service: string;
1825
- events: string[];
1826
- }
1827
- /**
1828
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1829
- * via the `definition` "shapeSchemaAllOf".
1830
- */
1831
- export interface ShapeSchemaAllOf {
1832
- allOf: ObjectOrRefArray;
1833
- }
1834
- /**
1835
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1836
- * via the `definition` "shapeSchemaExtends".
1837
- */
1838
- export interface ShapeSchemaExtends {
1839
- extends: ObjectOrRefArray;
1840
- }
1841
- /**
1842
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1843
- * via the `definition` "shapeSchemaOneOf".
1844
- */
1845
- export interface ShapeSchemaOneOf {
1846
- title?: string;
1847
- description?: string;
1848
- discriminator?: {
1849
- propertyName: string;
1850
- [k: string]: any;
1851
- };
1852
- oneOf: ObjectOrRefArray;
1853
- }
1854
- /**
1855
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1856
- * via the `definition` "shapeSchemaEnum".
1857
- */
1858
- export interface ShapeSchemaEnum {
1859
- enum: any[];
1860
- }
1861
- /**
1862
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1863
- * via the `definition` "shapeSchemaAny".
1864
- */
1865
- export interface ShapeSchemaAny {
1866
- }
1867
- /**
1868
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1869
- * via the `definition` "formMap".
1870
- */
1871
- export interface FormMap {
1872
- [k: string]: FormsConfig;
1873
- }
1874
- /**
1875
- * This interface was referenced by `FormMap`'s JSON-Schema definition
1876
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1877
- *
1878
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1879
- * via the `definition` "formsConfig".
1880
- */
1881
- export interface FormsConfig {
1882
- default: FormConfig;
1883
- [k: string]: FormConfig;
1884
- }
1885
- /**
1886
- * This interface was referenced by `FormsConfig`'s JSON-Schema definition
1887
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1888
- *
1889
- * This interface was referenced by `undefined`'s JSON-Schema definition
1890
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1891
- *
1892
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1893
- * via the `definition` "formConfig".
1894
- */
1895
- export interface FormConfig {
1896
- [k: string]: any;
1897
- }
1898
- /**
1899
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1900
- * via the `definition` "workflowMap".
1901
- */
1902
- export interface WorkflowMap {
1903
- [k: string]: Workflow;
1904
- }
1905
- /**
1906
- * This interface was referenced by `WorkflowMap`'s JSON-Schema definition
1907
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1908
- *
1909
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1910
- * via the `definition` "workflow".
1911
- */
1912
- export interface Workflow {
1913
- /**
1914
- * machine-readable id
1915
- */
1916
- name: string;
1917
- title: WorkflowName;
1918
- steps: Steps;
1919
- [k: string]: any;
1920
- }
1921
- /**
1922
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1923
- * via the `definition` "workflowStep".
1924
- */
1925
- export interface WorkflowStep {
1926
- name: Name;
1927
- title: Title;
1928
- description?: Description;
1929
- color: Color;
1930
- live: Live;
1931
- key: Key;
1932
- }
1933
- /**
1934
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1935
- * via the `definition` "storedServiceMap".
1936
- */
1937
- export interface ServiceMapJSON {
1938
- [k: string]: ServiceConfigJSON;
1939
- }
1940
- /**
1941
- * This interface was referenced by `ServiceMapJSON`'s JSON-Schema definition
1942
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1943
- *
1944
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1945
- * via the `definition` "storedServiceConfig".
1946
- */
1947
- export interface ServiceConfigJSON {
1948
- /**
1949
- * Machine-readable identifier, should typically be the same as the property name on the services object.
1950
- */
1951
- id: string;
1952
- /**
1953
- * Human-readable name for this service.
1954
- */
1955
- title: string;
1956
- /**
1957
- * The service provider id.
1958
- */
1959
- provider: string;
1960
- /**
1961
- * A namespace to use for the imported types tied to this service.
1962
- */
1963
- namespace?: string;
1964
- serviceType: ServiceType;
1965
- authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
1966
- authentication?: string;
1967
- healthCheck?: ServiceHealthCheck;
1968
- webhookId?: string;
1969
- /**
1970
- * Configuration options passed to and handled by the provider.
1971
- */
1972
- options?: {
1973
- [k: string]: any;
1974
- };
1975
- }
1976
- /**
1977
- * Configuration for ping health checks.
1978
- *
1979
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1980
- * via the `definition` "serviceHealthCheck".
1981
- */
1982
- export interface ServiceHealthCheck {
1983
- checkName: CheckName;
1984
- endpoint?: Endpoint;
1985
- requestMethod?: RequestMethod;
1986
- requestHeaders?: RequestHeaders;
1987
- requestSearchParams?: RequestSearchParams;
1988
- requestBody?: RequestBody;
1989
- requestBodyFormat?: RequestBodyFormat;
1990
- requestTimeout?: RequestTimeout;
1991
- healthyResponseStatusCode?: HealthyResponseStatusCode;
1992
- triggers?: ServiceHealthCheckTrigger[];
1993
- }
1994
- /**
1995
- * Any custom headers to set with the health check request.
1996
- */
1997
- export interface RequestHeaders {
1998
- [k: string]: any;
1999
- }
2000
- /**
2001
- * Any custom search params to set with the health check request.
2002
- */
2003
- export interface RequestSearchParams {
2004
- [k: string]: any;
2005
- }
2006
- /**
2007
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2008
- * via the `definition` "agentMap".
2009
- */
2010
- export interface AgentMap {
2011
- [k: string]: AgentJSON;
2012
- }
2013
- /**
2014
- * An Agent is a configuration for an AI service such as a chat bot or a search engine.
2015
- *
2016
- * This interface was referenced by `AgentMap`'s JSON-Schema definition
2017
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
2018
- *
2019
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2020
- * via the `definition` "agent".
2021
- */
2022
- export interface AgentJSON {
2023
- description?: string;
2024
- systemPrompt?: string;
2025
- api: AgentAPI;
2026
- memory?: AgentMemory;
2027
- start: AgentStart;
2028
- states: AgentStates;
2029
- guards?: AgentGuard[];
2030
- historyStrategies?: HistoryStrategyMap;
2031
- protection?: AgentProtection;
2032
- }
2033
- /**
2034
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2035
- * via the `definition` "agentApi".
2036
- */
2037
- export interface AgentAPI {
2038
- inputs: AgentAPIInput[];
2039
- }
2040
- /**
2041
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2042
- * via the `definition` "agentApiMutationInput".
2043
- */
2044
- export interface AgentAPIMutationInput {
2045
- type: 'mutation';
2046
- name: string;
2047
- args: string;
2048
- interactionTimeout?: InteractionTimeoutMilliseconds;
2049
- }
2050
- /**
2051
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2052
- * via the `definition` "agentMemory".
2053
- */
2054
- export interface AgentMemory {
2055
- sessionMemory: AgentSessionMemory;
2056
- }
2057
- /**
2058
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2059
- * via the `definition` "agentSessionMemory".
2060
- */
2061
- export interface AgentSessionMemory {
2062
- shape?: string;
2063
- }
2064
- /**
2065
- * Configuration for the start of an agent's execution
2066
- *
2067
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2068
- * via the `definition` "agentStart".
2069
- */
2070
- export interface AgentStart {
2071
- transitions: AgentTransitionSuspend[];
2072
- }
2073
- /**
2074
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2075
- * via the `definition` "agentTransitionSuspend".
2076
- */
2077
- export interface AgentTransitionSuspend {
2078
- type: 'suspend';
2079
- destination: string;
2080
- input: string;
2081
- condition?: string;
2082
- limit?: number;
2083
- sessionMemory?: AgentStateSessionMemory;
2084
- historyStrategy?: string;
2085
- }
2086
- /**
2087
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2088
- * via the `definition` "agentStateSessionMemoryAssignment".
2089
- */
2090
- export interface AgentStateSessionMemoryAssignment {
2091
- memoryPath?: string;
2092
- expression: string;
2093
- }
2094
- /**
2095
- * States that are traversed during the execution of an agent.
2096
- *
2097
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2098
- * via the `definition` "agentStateMap".
2099
- */
2100
- export interface AgentStates {
2101
- [k: string]: AgentState;
2102
- }
2103
- /**
2104
- * One step of an agent's execution.
2105
- *
2106
- * This interface was referenced by `AgentStates`'s JSON-Schema definition
2107
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
2108
- *
2109
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2110
- * via the `definition` "agentState".
2111
- */
2112
- export interface AgentState {
2113
- name: string;
2114
- variables?: Variables;
2115
- execution: AgentExecution;
2116
- transitions?: AgentTransition[];
2117
- }
2118
- /**
2119
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2120
- * via the `definition` "agentVariable".
2121
- */
2122
- export interface AgentVariable {
2123
- name: string;
2124
- /**
2125
- * These are evaluated in order until a value is found.
2126
- */
2127
- steps: AgentVariableStep[];
2128
- }
2129
- /**
2130
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2131
- * via the `definition` "agentVariableStep".
2132
- */
2133
- export interface AgentVariableStep {
2134
- condition?: string;
2135
- expression: string;
2136
- }
2137
- /**
2138
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2139
- * via the `definition` "agentExecutionGraphql".
2140
- */
2141
- export interface AgentExecutionGraphQL {
2142
- type: 'graphql';
2143
- query: string;
2144
- path?: string;
2145
- }
2146
- /**
2147
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2148
- * via the `definition` "agentExecutionGenerate".
2149
- */
2150
- export interface AgentExecutionGenerate {
2151
- type: 'generate';
2152
- service: string;
2153
- model: string;
2154
- systemPrompt?: string;
2155
- input: AgentAIStateInput;
2156
- outputShape?: string;
2157
- tools?: AgentToolConfig[];
2158
- options?: AgentGenerateOptions;
2159
- }
2160
- /**
2161
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2162
- * via the `definition` "agentAiStateInputArg".
2163
- */
2164
- export interface AgentAIStateInputArgument {
2165
- type: 'arg';
2166
- }
2167
- /**
2168
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2169
- * via the `definition` "agentAiStateInputTemplate".
2170
- */
2171
- export interface AgentAIStateInputTemplate {
2172
- type: 'template';
2173
- inputTemplate: string;
2174
- }
2175
- /**
2176
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2177
- * via the `definition` "agentToolConfig".
2178
- */
2179
- export interface AgentToolConfig {
2180
- name: string;
2181
- ref: string;
2182
- description?: string;
2183
- args?: AgentToolConfigArg[];
2184
- selectionSet?: string;
2185
- }
2186
- /**
2187
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2188
- * via the `definition` "agentToolConfigArgAgent".
2189
- */
2190
- export interface AgentControlled {
2191
- type: 'agent';
2192
- argName: ToolArgumentName;
2193
- }
2194
- /**
2195
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2196
- * via the `definition` "agentToolConfigArgVariable".
2197
- */
2198
- export interface VariableValue {
2199
- type: 'variable';
2200
- argName: ToolArgumentName1;
2201
- variableName: StateVariableName;
2202
- }
2203
- /**
2204
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2205
- * via the `definition` "agentGenerateOptions".
2206
- */
2207
- export interface AgentGenerateOptions {
2208
- history?: History1;
2209
- maxTokens?: MaximumTokens1;
2210
- temperature?: Temperature1;
2211
- topP?: TopP1;
2212
- topK?: TopK1;
2213
- presencePenalty?: PresencePenaltySetting1;
2214
- frequencyPenalty?: FrequencyPenaltySetting1;
2215
- stopSequences?: StopSequences1;
2216
- seed?: Seed1;
2217
- /**
2218
- * Maximum number of retries. Set to 0 to disable retries. Defaults to 2
2219
- */
2220
- maxRetries?: number;
2221
- /**
2222
- * The tool choice strategy. Default: 'auto'
2223
- */
2224
- toolChoice?: (('auto' | 'none' | 'required') | string) & string;
2225
- maxToolRoundtrips?: MaxToolRoundtrips;
2226
- structuredOutputs?: StructuredOutputs;
2227
- enableOpenAIFormat?: EnableOpenAISchemaFormat;
2228
- removePropertyKeyPatterns?: RemovePropertyKeyPatterns;
2229
- stripMarkdown?: StripMarkdown;
2230
- }
2231
- /**
2232
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2233
- * via the `definition` "agentExecutionChat".
2234
- */
2235
- export interface AgentExecutionChat {
2236
- type: 'chat';
2237
- service: string;
2238
- model: string;
2239
- systemPrompt?: string;
2240
- input: AgentAIStateInput;
2241
- artifact?: string;
2242
- tools?: AgentToolConfig[];
2243
- options?: AgentGenerateOptions;
2244
- }
2245
- /**
2246
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2247
- * via the `definition` "agentTransitionImmediate".
2248
- */
2249
- export interface AgentTransitionImmediate {
2250
- type: 'immediate';
2251
- destination: string;
2252
- condition?: string;
2253
- limit?: number;
2254
- sessionMemory?: AgentStateSessionMemory1;
2255
- historyStrategy?: string;
2256
- }
2257
- /**
2258
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2259
- * via the `definition` "agentGuard".
2260
- */
2261
- export interface AgentGuard {
2262
- guardId: GuardID;
2263
- }
2264
- /**
2265
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2266
- * via the `definition` "historyStrategyMap".
2267
- */
2268
- export interface HistoryStrategyMap {
2269
- [k: string]: HistoryStrategy;
2270
- }
2271
- /**
2272
- * This interface was referenced by `HistoryStrategyMap`'s JSON-Schema definition
2273
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
2274
- *
2275
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2276
- * via the `definition` "historyStrategy".
2277
- */
2278
- export interface HistoryStrategy {
2279
- name: string;
2280
- variables?: Variables1;
2281
- filter?: HistoryStrategyFilter;
2282
- transform: HistoryStrategyTransform;
2283
- }
2284
- /**
2285
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2286
- * via the `definition` "historyStrategyFilter".
2287
- */
2288
- export interface HistoryStrategyFilter {
2289
- toolCalls?: 'retain' | 'clear';
2290
- }
2291
- /**
2292
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2293
- * via the `definition` "historyStrategyTransformNone".
2294
- */
2295
- export interface HistoryStrategyTransformNone {
2296
- type: 'none';
2297
- }
2298
- /**
2299
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2300
- * via the `definition` "historyStrategyTransformReplace".
2301
- */
2302
- export interface HistoryStrategyTransformReplace {
2303
- type: 'replace';
2304
- template: string;
2305
- }
2306
- /**
2307
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2308
- * via the `definition` "historyStrategyTransformSummarize".
2309
- */
2310
- export interface HistoryStrategyTransformSummarize {
2311
- type: 'generate';
2312
- service: string;
2313
- model: string;
2314
- systemPrompt: string;
2315
- tools?: AgentToolConfig[];
2316
- options?: AgentGenerateOptions;
2317
- }
2318
- /**
2319
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2320
- * via the `definition` "agentProtection".
2321
- */
2322
- export interface AgentProtection {
2323
- enabled: EnableAgentAbuseProtection;
2324
- }
2325
- /**
2326
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2327
- * via the `definition` "guardMap".
2328
- */
2329
- export interface GuardMap {
2330
- [k: string]: GuardJSON;
2331
- }
2332
- /**
2333
- * A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.
2334
- *
2335
- * This interface was referenced by `GuardMap`'s JSON-Schema definition
2336
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
2337
- *
2338
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2339
- * via the `definition` "guard".
2340
- */
2341
- export interface GuardJSON {
2342
- name: Name1;
2343
- description?: Description1;
2344
- enabled?: Enabled;
2345
- guardrailIdentifier?: GuardrailIdentifier;
2346
- guardrailVersion?: GuardrailVersion;
2347
- blockedInputMessaging?: BlockedInputMessaging;
2348
- blockedOutputsMessaging?: BlockedOutputsMessaging;
2349
- topicPolicyConfig?: TopicPolicy;
2350
- contentPolicyConfig?: ContentPolicy;
2351
- wordPolicyConfig?: WordPolicy;
2352
- sensitiveInformationPolicyConfig?: SensitiveInformationPolicy;
2353
- contextualGroundingPolicyConfig?: ContextualGroundingPolicy;
2354
- }
2355
- /**
2356
- * Topics to identify and block.
2357
- */
2358
- export interface TopicPolicy {
2359
- topicsConfig: Topic;
2360
- }
2361
- /**
2362
- * Types of content to filter and strength configuration.
2363
- */
2364
- export interface ContentPolicy {
2365
- filtersConfig: Filter;
2366
- }
2367
- /**
2368
- * Specific words to identify and block.
2369
- */
2370
- export interface WordPolicy {
2371
- wordsConfig?: WordList;
2372
- managedWordListsConfig?: ManagedWordList;
2373
- }
2374
- /**
2375
- * Filter out and block or obscure sensitive information. Matching text will be handled per the policy.
2376
- */
2377
- export interface SensitiveInformationPolicy {
2378
- piiEntitiesConfig?: PIIEntity;
2379
- regexesConfig?: RegularExpression;
2380
- }
2381
- /**
2382
- * Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.
2383
- */
2384
- export interface ContextualGroundingPolicy {
2385
- filtersConfig: Filter1;
2386
- }
2387
- /**
2388
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2389
- * via the `definition` "mcpConfig".
2390
- */
2391
- export interface MCPServerConfiguration {
2392
- tools?: ToolMap;
2393
- }
2394
- /**
2395
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2396
- * via the `definition` "toolMap".
2397
- */
2398
- export interface ToolMap {
2399
- [k: string]: ToolJSON;
2400
- }
2401
- /**
2402
- * This interface was referenced by `ToolMap`'s JSON-Schema definition
2403
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
2404
- *
2405
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2406
- * via the `definition` "tool".
2407
- */
2408
- export interface ToolJSON {
2409
- name: string;
2410
- ref: string;
2411
- description?: string;
2412
- args?: ToolArg[];
2413
- selectionSet?: string;
2414
- }
2415
- /**
2416
- * All possible options for the more specific ParameterSerializeStyleOptions types.
2417
- *
2418
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2419
- * via the `definition` "parameterSerializeStyleOptions".
2420
- */
2421
- export interface ParameterSerializeStyleOptions {
2422
- style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
2423
- explode?: boolean;
2424
- allowEmptyValue?: boolean;
2425
- /**
2426
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
2427
- */
2428
- allowReserved?: boolean;
2429
- skipEncoding?: boolean;
2430
- }
2431
- /**
2432
- * All possible options for the more specific ParameterSerializeConfig types.
2433
- *
2434
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2435
- * via the `definition` "parameterSerializeConfig".
2436
- */
2437
- export interface ParameterSerializeConfig {
2438
- content?: ParameterSerializeContentOptions;
2439
- defaults?: ParameterSerializeOptions;
2440
- paths?: {
2441
- [k: string]: ParameterSerializeOptions;
2442
- };
2443
- }
2444
- /**
2445
- * All possible options for the more specific ParameterConfig types.
2446
- *
2447
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2448
- * via the `definition` "parameterConfig".
2449
- */
2450
- export interface ParameterConfig {
2451
- ops: ParameterOpList;
2452
- serialize?: ParameterSerializeConfig;
2453
- }
2454
- /**
2455
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2456
- * via the `definition` "aiParseFileResolverOptions".
2457
- */
2458
- export interface AIParseFileResolverOptions {
2459
- [k: string]: any;
2460
- }
2461
- /**
2462
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2463
- * via the `definition` "listQueryLoaderConfig".
2464
- */
2465
- export interface ListQueryLoaderConfig {
2466
- query: string;
2467
- args?: {
2468
- [k: string]: any;
2469
- };
2470
- pagination?: PaginationConfig;
2471
- }
2472
- /**
2473
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2474
- * via the `definition` "formScalarConfig".
2475
- */
2476
- export interface FormScalarConfig {
2477
- widget: string;
2478
- }
2479
- /**
2480
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2481
- * via the `definition` "formObjectConfig".
2482
- */
2483
- export interface FormObjectConfig {
2484
- widget?: string;
2485
- order?: string[];
2486
- properties?: {
2487
- [k: string]: FormConfig;
2488
- };
2489
- }
2490
- /**
2491
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2492
- * via the `definition` "formArrayConfig".
2493
- */
2494
- export interface FormArrayConfig {
2495
- widget: string;
2496
- items: FormConfig;
2497
- }
2498
- /**
2499
- * For use with a custom auth handler on a service provider.
2500
- *
2501
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2502
- * via the `definition` "customAuthentication".
2503
- */
2504
- export interface CustomAuthentication {
2505
- type: 'custom';
2506
- [k: string]: any;
2507
- }
2508
- /**
2509
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2510
- * via the `definition` "searchParamsAuthentication".
2511
- */
2512
- export interface SearchParamsAuthentication {
2513
- type: 'searchParams';
2514
- params: {
2515
- name: string;
2516
- value: string;
2517
- }[];
2518
- }
2519
- /**
2520
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2521
- * via the `definition` "bearerAuthentication".
2522
- */
2523
- export interface BearerAuthentication {
2524
- type: 'bearer';
2525
- token: string;
2526
- prefix?: string;
2527
- header?: string;
2528
- }
2529
- /**
2530
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2531
- * via the `definition` "oauth2BearerAuthentication".
2532
- */
2533
- export interface OAuth2BearerAuthentication {
2534
- type: 'oauth2Bearer';
2535
- token: string;
2536
- prefix?: string;
2537
- header?: string;
2538
- scope?: string;
2539
- expiresAt?: string;
2540
- }
2541
- /**
2542
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2543
- * via the `definition` "basicAuthentication".
2544
- */
2545
- export interface BasicAuthentication {
2546
- type: 'basic';
2547
- username: string;
2548
- password: string;
2549
- useIso8859?: boolean;
2550
- }
2551
- /**
2552
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2553
- * via the `definition` "oauth2Authentication".
2554
- */
2555
- export interface OAuth2Authentication {
2556
- type: 'oauth2';
2557
- grantType: 'authorizationCode' | 'clientCredentials';
2558
- authorizationUrl?: string;
2559
- accessTokenUrl?: string;
2560
- clientId: string;
2561
- clientSecret?: string;
2562
- scope?: string;
2563
- usePkce?: boolean;
2564
- redirectUrl?: string;
2565
- headerPrefix?: string;
2566
- audience?: string;
2567
- resource?: string;
2568
- }
2569
- /**
2570
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2571
- * via the `definition` "awsAuthentication".
2572
- */
2573
- export interface AWSAuthentication {
2574
- type: 'aws';
2575
- awsAccessKeyId: string;
2576
- awsSecretAccessKey: string;
2577
- }
2578
- /**
2579
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2580
- * via the `definition` "googleAuthentication".
2581
- */
2582
- export interface GoogleAuthentication {
2583
- type: 'google';
2584
- clientEmail: string;
2585
- privateKey: string;
2586
- }
2587
- /**
2588
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2589
- * via the `definition` "serviceConfig".
2590
- */
2591
- export interface ServiceConfig {
2592
- /**
2593
- * Machine-readable identifier, should typically be the same as the property name on the services object.
2594
- */
2595
- id: string;
2596
- /**
2597
- * Human-readable name for this service.
2598
- */
2599
- title: string;
2600
- /**
2601
- * The service provider id.
2602
- */
2603
- provider: string;
2604
- /**
2605
- * A namespace to use for the imported types tied to this service.
2606
- */
2607
- namespace?: string;
2608
- serviceType: ServiceType;
2609
- authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
2610
- authentication?: ServiceAuthentication;
2611
- healthCheck?: ServiceHealthCheck;
2612
- webhookId?: string;
2613
- /**
2614
- * Configuration options passed to and handled by the provider.
2615
- */
2616
- options?: {
2617
- [k: string]: any;
2618
- };
2619
- }