@takeshape/schema 11.87.0 → 11.88.4

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 (92) hide show
  1. package/dist/builtin-schema.js +29 -68
  2. package/dist/create-input-schema.js +13 -5
  3. package/dist/index.d.ts +1 -0
  4. package/dist/index.js +1 -0
  5. package/dist/migration/index.d.ts +1 -0
  6. package/dist/migration/index.js +3 -1
  7. package/dist/migration/to/v3.55.0.d.ts +4 -0
  8. package/dist/migration/to/v3.55.0.js +10 -0
  9. package/dist/models/query.d.ts +2 -2
  10. package/dist/models/query.js +3 -3
  11. package/dist/models/runtime-schema.d.ts +8 -8
  12. package/dist/models/runtime-schema.js +36 -17
  13. package/dist/models/shape.d.ts +2 -2
  14. package/dist/models/shape.js +3 -3
  15. package/dist/models/types.d.ts +1 -1
  16. package/dist/project-schema/index.d.ts +4 -1
  17. package/dist/project-schema/index.js +2 -1
  18. package/dist/project-schema/latest.d.ts +2 -2
  19. package/dist/project-schema/migrate.js +4 -1
  20. package/dist/project-schema/v3.55.0.d.ts +2344 -0
  21. package/dist/project-schema/v3.55.0.js +7 -0
  22. package/dist/refs.d.ts +2 -1
  23. package/dist/refs.js +12 -6
  24. package/dist/resolvers/takeshape/assets/asset-image-meta.d.ts +77 -0
  25. package/dist/resolvers/takeshape/assets/asset-image-meta.js +95 -0
  26. package/dist/resolvers/takeshape/assets/asset-image-params.d.ts +899 -0
  27. package/dist/resolvers/takeshape/assets/asset-image-params.js +723 -0
  28. package/dist/resolvers/takeshape/assets/asset-image.d.ts +15 -0
  29. package/dist/resolvers/takeshape/assets/asset-image.js +12 -0
  30. package/dist/resolvers/takeshape/assets/asset.d.ts +123 -0
  31. package/dist/resolvers/takeshape/assets/asset.js +105 -0
  32. package/dist/resolvers/takeshape/assets/constants.d.ts +11 -0
  33. package/dist/resolvers/takeshape/assets/constants.js +11 -0
  34. package/dist/runtime-schema.js +2 -1
  35. package/dist/schema-util.js +9 -2
  36. package/dist/schemas/index.d.ts +2 -2
  37. package/dist/schemas/index.js +4 -2
  38. package/dist/schemas/project-schema/latest.json +6 -3
  39. package/dist/schemas/project-schema/v3.55.0.json +3515 -0
  40. package/dist/schemas/project-schema.json +3 -0
  41. package/examples/latest/agent-schema.json +1 -1
  42. package/examples/latest/all-fields-shapes-inline.json +1 -1
  43. package/examples/latest/all-fields-shapes.json +1 -1
  44. package/examples/latest/betzino.json +1 -1
  45. package/examples/latest/blog-schema.json +1 -1
  46. package/examples/latest/brewery-schema.json +1 -1
  47. package/examples/latest/clear-cache-schema.json +1 -1
  48. package/examples/latest/complex-project-schema.json +1 -1
  49. package/examples/latest/complex-schema.json +1 -1
  50. package/examples/latest/edit-schema.json +1 -1
  51. package/examples/latest/fabric-ecommerce.json +1 -1
  52. package/examples/latest/frank-and-fred-schema.json +1 -1
  53. package/examples/latest/klirr-schema.json +1 -1
  54. package/examples/latest/layers/rick-and-morty-layer.json +1 -1
  55. package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
  56. package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
  57. package/examples/latest/layers/wordpress-2024-01.json +1 -1
  58. package/examples/latest/massive-schema.json +1 -1
  59. package/examples/latest/mill-components-schema.json +1 -1
  60. package/examples/latest/nested-shape-arrays.json +1 -1
  61. package/examples/latest/one-earth.json +1 -1
  62. package/examples/latest/pet-oneof-array.json +1 -1
  63. package/examples/latest/post-schema.json +1 -1
  64. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  65. package/examples/latest/rag-example.json +1 -1
  66. package/examples/latest/real-world-schema.json +1 -1
  67. package/examples/latest/recursive-repeater-schema.json +1 -1
  68. package/examples/latest/recursive-schema.json +1 -1
  69. package/examples/latest/rick-and-morty-ast.json +1 -1
  70. package/examples/latest/rick-and-morty-graphql.json +1 -1
  71. package/examples/latest/rick-and-morty-rest.json +1 -1
  72. package/examples/latest/rick-and-morty-user-schema.json +1 -1
  73. package/examples/latest/rick-and-morty-with-indexing.json +1 -1
  74. package/examples/latest/schema-where-filter.json +1 -1
  75. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  76. package/examples/latest/schema-with-rick-and-morty.json +1 -1
  77. package/examples/latest/shape-books-v3_2_0.json +1 -1
  78. package/examples/latest/shape-books.json +1 -1
  79. package/examples/latest/shape-editor-schema-edited.json +1 -1
  80. package/examples/latest/shape-editor-schema-initial.json +1 -1
  81. package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
  82. package/examples/latest/shopify-lookbook.json +1 -1
  83. package/examples/latest/shopify-product-2022-07.json +1 -1
  84. package/examples/latest/shopify-product-2023-04.json +1 -1
  85. package/examples/latest/shopify-store-with-widget.json +1 -1
  86. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  87. package/examples/latest/stripe-starter-resolved.json +1 -1
  88. package/examples/latest/user-schema-no-required.json +1 -1
  89. package/examples/latest/user-schema-with-defaults.json +1 -1
  90. package/examples/latest/valvoline-ai-demo.json +1 -1
  91. package/examples/latest/vector-search-schema.json +1 -1
  92. package/package.json +5 -5
@@ -0,0 +1,2344 @@
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 `ProjectSchemaJSONV3_55_0`'s JSON-Schema
8
+ * via the `definition` "args".
9
+ */
10
+ export type ArgsV3_55_0 = string | ObjectSchemaV3_55_0;
11
+ /**
12
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
13
+ * via the `definition` "objectSchema".
14
+ */
15
+ export type ObjectSchemaV3_55_0 = PropertySchemaV3_55_0 & {
16
+ type: 'object';
17
+ properties: {
18
+ [k: string]: PropertySchemaV3_55_0;
19
+ };
20
+ };
21
+ /**
22
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
23
+ * via the `definition` "nonNegativeInteger".
24
+ */
25
+ export type NonNegativeIntegerV3_55_0 = number;
26
+ /**
27
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
28
+ * via the `definition` "nonNegativeIntegerDefault0".
29
+ */
30
+ export type NonNegativeIntegerDefault0V3_55_0 = NonNegativeIntegerV3_55_0;
31
+ /**
32
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
33
+ * via the `definition` "stringArray".
34
+ */
35
+ export type StringArrayV3_55_0 = string[];
36
+ /**
37
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
38
+ * via the `definition` "simpleTypes".
39
+ */
40
+ export type SimpleTypesV3_55_0 = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
41
+ /**
42
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
43
+ * via the `definition` "schemaArray".
44
+ */
45
+ export type SchemaArrayV3_55_0 = PropertySchemaV3_55_0[];
46
+ /**
47
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
48
+ * via the `definition` "ref".
49
+ */
50
+ export type RefV3_55_0 = string;
51
+ /**
52
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
53
+ * via the `definition` "objectOrRefArray".
54
+ */
55
+ export type ObjectOrRefArrayV3_55_0 = (RefSchemaV3_55_0 | RefSchemaLegacyV3_55_0 | ObjectSchemaV3_55_0)[];
56
+ /**
57
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
58
+ * via the `definition` "fieldMapping".
59
+ */
60
+ export type FieldMappingV3_55_0 = MappingStringV3_55_0 | MappingStringV3_55_0[];
61
+ /**
62
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
63
+ * via the `definition` "mappingString".
64
+ */
65
+ export type MappingStringV3_55_0 = string;
66
+ /**
67
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
68
+ * via the `definition` "resolver".
69
+ */
70
+ export type ResolverV3_55_0 = BasicResolverV3_55_0 | ComposeResolverV3_55_0;
71
+ /**
72
+ * A single resolver, can be composed with the ComposeResolver.
73
+ *
74
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
75
+ * via the `definition` "basicResolver".
76
+ */
77
+ export type BasicResolverV3_55_0 = UtilResolverV3_55_0 | DelegateResolverV3_55_0 | TakeshapeResolverV3_55_0 | ShapedbResolverV3_55_0 | ShapedbResolverShapeNameNotRequiredV3_55_0 | GraphqlResolverV3_55_0 | RestResolverV3_55_0 | AwsLambdaResolverV3_55_0 | SalsifyResolverV3_55_0 | SyndigoResolverV3_55_0 | FunctionResolverV3_55_0 | AIGenerateTextResolverV3_55_0 | AIGeneratePropertyResolverV3_55_0 | AIEmbeddingResolverV3_55_0 | AIEmbeddingSearchResolverV3_55_0 | AIParseFileResolverV3_55_0 | ChunkResolverV3_55_0 | AIRunAgentResolverV3_55_0 | AIInspectAgentResolverV3_55_0;
78
+ /**
79
+ * Name of the resolver function.
80
+ */
81
+ export type UtilResolverNameV3_55_0 = 'util:noop' | 'util:wrap';
82
+ /**
83
+ * An object describing an operation to generate a parameter.
84
+ *
85
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
86
+ * via the `definition` "parameterOp".
87
+ */
88
+ export type ParameterOpV3_55_0 = ParameterOpNestedV3_55_0 | ParameterOpValueV3_55_0 | ParameterOpMappingV3_55_0 | ParameterOpOpV3_55_0;
89
+ /**
90
+ * A tuple with a string directive name, and options to pass to the directive
91
+ *
92
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
93
+ * via the `definition` "directiveConfigItem".
94
+ */
95
+ export type DirectiveConfigItemV3_55_0 = [DirectiveNameV3_55_0, DirectiveOptionsV3_55_0];
96
+ export type DirectiveNameV3_55_0 = string;
97
+ /**
98
+ * An array of individual directive config items to process in order
99
+ *
100
+ * This interface was referenced by `DirectiveMappingMapV3_55_0`'s JSON-Schema definition
101
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
102
+ *
103
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
104
+ * via the `definition` "directiveConfig".
105
+ */
106
+ export type DirectiveConfigV3_55_0 = DirectiveConfigItemV3_55_0[];
107
+ /**
108
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
109
+ * via the `definition` "parameterOpList".
110
+ */
111
+ export type ParameterOpListV3_55_0 = ParameterOpV3_55_0[];
112
+ /**
113
+ * Maps a query's input args to the input expected by the service's endpoint.
114
+ *
115
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
116
+ * via the `definition` "argsMapping".
117
+ */
118
+ export type ArgsMappingV3_55_0 = DirectiveMappingMapV3_55_0 | DirectiveConfigV3_55_0;
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 `ProjectSchemaJSONV3_55_0`'s JSON-Schema
123
+ * via the `definition` "resultsMapping".
124
+ */
125
+ export type ResultsMappingV3_55_0 = DirectiveMappingMapV3_55_0 | DirectiveConfigV3_55_0;
126
+ /**
127
+ * Name of the resolver function.
128
+ */
129
+ export type DelegateResolverNameV3_55_0 = 'delegate';
130
+ /**
131
+ * Name of the resolver function.
132
+ */
133
+ export type TakeshapeResolverNameV3_55_0 = '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 ShapedbResolverNameV3_55_0 = 'shapedb:get' | 'shapedb:create' | 'shapedb:update' | 'shapedb:delete' | 'shapedb:duplicate' | 'shapedb:find';
138
+ /**
139
+ * Name of the resolver function.
140
+ */
141
+ export type ShapedbResolverShapeNameNotRequiredNameV3_55_0 = 'shapedb:list' | 'shapedb:taxonomySuggest' | 'shapedb:getRelated';
142
+ /**
143
+ * Name of the resolver function.
144
+ */
145
+ export type GraphqlResolverNameV3_55_0 = 'graphql:query' | 'graphql:mutation' | 'shopify:bulkQuery';
146
+ /**
147
+ * Name of the resolver function.
148
+ */
149
+ export type RestResolverNameV3_55_0 = '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 `ProjectSchemaJSONV3_55_0`'s JSON-Schema
154
+ * via the `definition` "directiveMappingArrayItem".
155
+ */
156
+ export type DirectiveMappingArrayItemV3_55_0 = [string, DirectiveConfigV3_55_0];
157
+ /**
158
+ * An array of key / value or directive config tuples
159
+ */
160
+ export type SearchParamsMappingV3_55_0 = DirectiveMappingArrayItemV3_55_0[];
161
+ /**
162
+ * Name of the resolver function.
163
+ */
164
+ export type AwsLambdaResolverNameV3_55_0 = 'awsLambda:invoke';
165
+ /**
166
+ * Name of the resolver function.
167
+ */
168
+ export type SalsifyResolverNameV3_55_0 = 'salsify:listChannelProducts';
169
+ /**
170
+ * Name of the resolver function.
171
+ */
172
+ export type SyndigoResolverNameV3_55_0 = 'syndigo:searchProducts';
173
+ /**
174
+ * Name of the resolver function.
175
+ */
176
+ export type FunctionResolverNameV3_55_0 = 'function:run';
177
+ export type FunctionResolverJavascriptV3_55_0 = string;
178
+ /**
179
+ * Name of the resolver function.
180
+ */
181
+ export type AIResolverNameV3_55_0 = 'ai:generateText' | 'ai:chat';
182
+ export type HistoryV3_55_0 = boolean;
183
+ /**
184
+ * Maximum number of tokens to generate.
185
+ */
186
+ export type MaximumTokensV3_55_0 = 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 TemperatureV3_55_0 = 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 TopPV3_55_0 = 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 TopKV3_55_0 = 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 PresencePenaltySettingV3_55_0 = 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 FrequencyPenaltySettingV3_55_0 = number;
207
+ /**
208
+ * If set, the model will stop generating text when one of the stop sequences is generated.
209
+ */
210
+ export type StopSequencesV3_55_0 = 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 SeedV3_55_0 = number;
215
+ /**
216
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
217
+ * via the `definition` "aiGuardrail".
218
+ */
219
+ export type AIGuardrailV3_55_0 = AISimilarityGuardrailV3_55_0;
220
+ /**
221
+ * Name of the resolver function.
222
+ */
223
+ export type AIResolverNameV3_55_01 = 'ai:generateProperty';
224
+ /**
225
+ * Name of the resolver function.
226
+ */
227
+ export type AIResolverNameV3_55_02 = 'ai:createEmbedding';
228
+ /**
229
+ * Name of the resolver function.
230
+ */
231
+ export type AIResolverNameV3_55_03 = 'ai:embeddingSearch';
232
+ /**
233
+ * Name of the resolver function.
234
+ */
235
+ export type AIResolverNameV3_55_04 = 'ai:parseFile';
236
+ /**
237
+ * Name of the resolver function.
238
+ */
239
+ export type UtilResolverNameV3_55_01 = 'util:chunk';
240
+ /**
241
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
242
+ * via the `definition` "utilChunkResolverOptions".
243
+ */
244
+ export type UtilChunkResolverOptionsV3_55_0 = UtilChunkResolverOptionsCharacterCountV3_55_0 | UtilChunkResolverOptionsSeparatorsV3_55_0 | UtilChunkResolverOptionsMarkdownV3_55_0 | UtilChunkResolverOptionsSemanticV3_55_0;
245
+ /**
246
+ * Name of the resolver function.
247
+ */
248
+ export type AIResolverNameV3_55_05 = 'ai:runAgent';
249
+ /**
250
+ * Name of the resolver function.
251
+ */
252
+ export type AIResolverNameV3_55_06 = 'ai:inspectAgentSession';
253
+ /**
254
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
255
+ * via the `definition` "dependencies".
256
+ */
257
+ export type DependenciesV3_55_0 = string;
258
+ /**
259
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
260
+ * via the `definition` "returnShape".
261
+ */
262
+ export type ReturnShapeV3_55_0 = string | ReturnShapeArraySchemaV3_55_0;
263
+ /**
264
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
265
+ * via the `definition` "returnShapeArraySchema".
266
+ */
267
+ export type ReturnShapeArraySchemaV3_55_0 = PropertySchemaV3_55_0 & {
268
+ type: 'array';
269
+ items: RefSchemaV3_55_0 | {
270
+ type: 'boolean' | 'integer' | 'number' | 'string' | 'object';
271
+ [k: string]: any;
272
+ };
273
+ };
274
+ export type ModelTypeV3_55_0 = 'single' | 'multiple' | 'taxonomy';
275
+ /**
276
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
277
+ * via the `definition` "paginationConfig".
278
+ */
279
+ export type PaginationConfigV3_55_0 = PaginationCursorConfigV3_55_0 | PaginationPageConfigV3_55_0 | PaginationOffsetConfigV3_55_0;
280
+ /**
281
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
282
+ * via the `definition` "cacheTriggerConfig".
283
+ */
284
+ export type CacheTriggerConfigV3_55_0 = CacheScheduleTriggerConfigV3_55_0 | CacheWebhookTriggerConfigV3_55_0;
285
+ /**
286
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
287
+ * via the `definition` "shapeSchema".
288
+ */
289
+ export type ShapeSchemaV3_55_0 = ShapeSchemaAllOfV3_55_0 | ShapeSchemaExtendsV3_55_0 | ShapeSchemaOneOfV3_55_0 | ShapeSchemaEnumV3_55_0 | ObjectSchemaV3_55_0 | ShapeSchemaAnyV3_55_0;
290
+ export type AgentAPIV3_55_0 = AgentAPIChatV3_55_0 | AgentAPIGenerateV3_55_0;
291
+ export type InteractionTimeoutMillisecondsV3_55_0 = number;
292
+ export type InteractionTimeoutMillisecondsV3_55_01 = number;
293
+ export type VariablesV3_55_0 = AgentVariableV3_55_0[];
294
+ export type AgentExecutionV3_55_0 = AgentExecutionGraphQLV3_55_0 | AgentExecutionGenerateV3_55_0 | AgentExecutionChatV3_55_0;
295
+ export type AgentAIStateInputV3_55_0 = AgentAIStateInputArgumentV3_55_0 | AgentAIStateInputTemplateV3_55_0;
296
+ export type AgentToolConfigArgV3_55_0 = AgentControlledV3_55_0 | VariableValueV3_55_0;
297
+ /**
298
+ * The argument name that will be exposed by the tool for the LLM to use.
299
+ */
300
+ export type ToolArgumentNameV3_55_0 = string;
301
+ /**
302
+ * Name of argument to pass value to. This prevents the LLM from setting the argument.
303
+ */
304
+ export type ToolArgumentNameV3_55_01 = string;
305
+ /**
306
+ * Name of variable to pull value from.
307
+ */
308
+ export type StateVariableNameV3_55_0 = string;
309
+ export type HistoryV3_55_01 = boolean;
310
+ /**
311
+ * Maximum number of tokens to generate. Defaults to 1024
312
+ */
313
+ export type MaximumTokensV3_55_01 = number;
314
+ /**
315
+ * 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
316
+ */
317
+ export type TemperatureV3_55_01 = number;
318
+ /**
319
+ * 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.
320
+ */
321
+ export type TopPV3_55_01 = number;
322
+ /**
323
+ * 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.
324
+ */
325
+ export type TopKV3_55_01 = number;
326
+ /**
327
+ * 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.
328
+ */
329
+ export type PresencePenaltySettingV3_55_01 = number;
330
+ /**
331
+ * 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.
332
+ */
333
+ export type FrequencyPenaltySettingV3_55_01 = number;
334
+ /**
335
+ * If set, the model will stop generating text when one of the stop sequences is generated.
336
+ */
337
+ export type StopSequencesV3_55_01 = string[];
338
+ /**
339
+ * The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
340
+ */
341
+ export type SeedV3_55_01 = number;
342
+ /**
343
+ * Maximal number of automatic roundtrips for tool calls.
344
+ */
345
+ export type MaxToolRoundtripsV3_55_0 = number;
346
+ /**
347
+ * If true, structured outputs will be enabled on the model for non-text requests.
348
+ */
349
+ export type StructuredOutputsV3_55_0 = boolean;
350
+ /**
351
+ * Enable OpenAI schema format. Must be enabled if `structuredOutputs` is enabled.
352
+ */
353
+ export type EnableOpenAISchemaFormatV3_55_0 = boolean;
354
+ export type MinimatchPatternV3_55_0 = string;
355
+ /**
356
+ * Remove properties from the schema sent to the model with keys matching these minimatch glob patterns.
357
+ */
358
+ export type RemovePropertyKeyPatternsV3_55_0 = MinimatchPatternV3_55_0[];
359
+ /**
360
+ * Remove Markdown formatting from the LLM response
361
+ */
362
+ export type StripMarkdownV3_55_0 = boolean;
363
+ export type AgentChatHistoryConfigV3_55_0 = AgentChatHistoryRetainV3_55_0 | AgentChatHistorySummarizeV3_55_0 | AgentChatHistoryClearV3_55_0;
364
+ export type AgentStateSessionMemoryLocationV3_55_0 = AgentStateSessionMemoryLocationContentV3_55_0 | AgentStateSessionMemoryLocationArtifactV3_55_0 | AgentStateSessionMemoryLocationStaticValueV3_55_0;
365
+ export type AgentStateSessionMemoryV3_55_0 = AgentStateSessionMemoryLocationV3_55_0[];
366
+ export type GuardIDV3_55_0 = string;
367
+ /**
368
+ * The human-readable name of the Guard.
369
+ */
370
+ export type NameV3_55_0 = string;
371
+ /**
372
+ * A description of the Guard.
373
+ */
374
+ export type DescriptionV3_55_0 = string;
375
+ /**
376
+ * The remote id of the Guardrail.
377
+ */
378
+ export type GuardrailIdentifierV3_55_0 = string;
379
+ /**
380
+ * The remote version of the Guardrail.
381
+ */
382
+ export type GuardrailVersionV3_55_0 = string;
383
+ /**
384
+ * A message to return when the input message is blocked by the Guard.
385
+ */
386
+ export type BlockedInputMessagingV3_55_0 = string;
387
+ /**
388
+ * A message to return when the output message is blocked by the Guard.
389
+ */
390
+ export type BlockedOutputsMessagingV3_55_0 = string;
391
+ export type ExampleV3_55_0 = string;
392
+ /**
393
+ * A topic to block.
394
+ */
395
+ export type TopicV3_55_0 = {
396
+ name: string;
397
+ definition: string;
398
+ /**
399
+ * Examples of the topic that can hint the LLM.
400
+ */
401
+ examples?: ExampleV3_55_0[];
402
+ type: 'DENY';
403
+ }[];
404
+ export type InputStrengthV3_55_0 = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
405
+ export type OutputStrengthV3_55_0 = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
406
+ export type GuardrailModalityV3_55_0 = 'TEXT' | 'IMAGE';
407
+ /**
408
+ * Whether to filter images or text
409
+ */
410
+ export type InputModalitiesV3_55_0 = GuardrailModalityV3_55_0[];
411
+ /**
412
+ * Whether to filter images or text
413
+ */
414
+ export type OutputModalitiesV3_55_0 = GuardrailModalityV3_55_0[];
415
+ /**
416
+ * Types of content to filter.
417
+ */
418
+ export type FilterV3_55_0 = {
419
+ type: 'HATE' | 'INSULTS' | 'MICONDUCT' | 'PROMPT_ATTACK' | 'SEXUAL' | 'VIOLENCE';
420
+ inputStrength: InputStrengthV3_55_0;
421
+ outputStrength: OutputStrengthV3_55_0;
422
+ inputModalities?: InputModalitiesV3_55_0;
423
+ outputModalities?: OutputModalitiesV3_55_0;
424
+ }[];
425
+ /**
426
+ * Specific words to block.
427
+ */
428
+ export type WordListV3_55_0 = {
429
+ text: string;
430
+ }[];
431
+ /**
432
+ * This is solely used for blocking profanity.
433
+ */
434
+ export type ManagedWordListV3_55_0 = {
435
+ type: 'PROFANITY';
436
+ }[];
437
+ export type GuardrailSensitiveInformationActionV3_55_0 = 'ANONYMIZE' | 'BLOCK';
438
+ /**
439
+ * PII entity to infer from the text.
440
+ */
441
+ export type PIIEntityV3_55_0 = {
442
+ 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';
443
+ action: GuardrailSensitiveInformationActionV3_55_0;
444
+ }[];
445
+ /**
446
+ * A regular expression to match sensitive information.
447
+ */
448
+ export type RegularExpressionV3_55_0 = {
449
+ name: string;
450
+ description?: string;
451
+ pattern: string;
452
+ action: GuardrailSensitiveInformationActionV3_55_0;
453
+ }[];
454
+ /**
455
+ * The type of filter.
456
+ */
457
+ export type TypeV3_55_0 = 'GROUNDING' | 'RELEVANCE';
458
+ /**
459
+ * The threshold for the filter as a floating point value greater than 0.0 and less than 1.0.
460
+ */
461
+ export type ThresholdV3_55_0 = number;
462
+ /**
463
+ * Filter to evaluate grounding text.
464
+ */
465
+ export type FilterV3_55_01 = {
466
+ type: TypeV3_55_0;
467
+ threshold: ThresholdV3_55_0;
468
+ }[];
469
+ export type ToolArgV3_55_0 = AgentControlledV3_55_0;
470
+ /**
471
+ * Human-readable id for use in the UI
472
+ */
473
+ export type WorkflowNameV3_55_0 = string;
474
+ /**
475
+ * machine-readable slug
476
+ */
477
+ export type NameV3_55_01 = string;
478
+ /**
479
+ * Human-readable id for use in the UI
480
+ */
481
+ export type TitleV3_55_0 = string;
482
+ export type DescriptionV3_55_01 = string;
483
+ /**
484
+ * Hex color code
485
+ */
486
+ export type ColorV3_55_0 = string;
487
+ /**
488
+ * Value to indicate whether items in the state should be returned in list queries
489
+ */
490
+ export type LiveV3_55_0 = boolean;
491
+ /**
492
+ * machine-readable id
493
+ */
494
+ export type KeyV3_55_0 = string;
495
+ export type StepsV3_55_0 = WorkflowStepV3_55_0[];
496
+ /**
497
+ * The general type of this service, specifying how and where it will be utilized.
498
+ *
499
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
500
+ * via the `definition` "serviceType".
501
+ */
502
+ export type ServiceTypeV3_55_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
503
+ /**
504
+ * The name of a health check to run
505
+ */
506
+ export type CheckNameV3_55_0 = 'graphqlIntrospection' | 'ping' | 'none';
507
+ /**
508
+ * The endpoint to use when checking the service health.
509
+ */
510
+ export type EndpointV3_55_0 = string;
511
+ /**
512
+ * A custom method to use for the health check request.
513
+ */
514
+ export type RequestMethodV3_55_0 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
515
+ /**
516
+ * A custom body to send along with the ping request.
517
+ */
518
+ export type RequestBodyV3_55_0 = string;
519
+ /**
520
+ * A custom body to send along with the ping request.
521
+ */
522
+ export type RequestBodyFormatV3_55_0 = 'string' | 'form' | 'json' | 'form-data';
523
+ /**
524
+ * The amount of time to wait when receiving a response from the health check, in seconds.
525
+ */
526
+ export type RequestTimeoutV3_55_0 = number;
527
+ /**
528
+ * The response status code that qualifies as healthy.
529
+ */
530
+ export type HealthyResponseStatusCodeV3_55_0 = number;
531
+ /**
532
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
533
+ * via the `definition` "serviceHealthCheckTrigger".
534
+ */
535
+ export type ServiceHealthCheckTriggerV3_55_0 = 'manual' | 'schedule';
536
+ /**
537
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
538
+ * via the `definition` "allOfSchema".
539
+ */
540
+ export type AllOfSchemaV3_55_0 = PropertySchemaV3_55_0 & {
541
+ allOf: ObjectOrRefArrayV3_55_0;
542
+ };
543
+ /**
544
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
545
+ * via the `definition` "extendsSchema".
546
+ */
547
+ export type ExtendsSchemaV3_55_0 = PropertySchemaV3_55_0 & {
548
+ extends: ObjectOrRefArrayV3_55_0;
549
+ };
550
+ /**
551
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
552
+ * via the `definition` "oneOfSchema".
553
+ */
554
+ export type OneOfSchemaV3_55_0 = PropertySchemaV3_55_0 & {
555
+ oneOf: ObjectOrRefArrayV3_55_0;
556
+ };
557
+ /**
558
+ * Options to be passed to the serialization routine.
559
+ *
560
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
561
+ * via the `definition` "parameterSerializeOptions".
562
+ *
563
+ * This interface was referenced by `undefined`'s JSON-Schema definition
564
+ * via the `patternProperty` "^[^\n\r]*$".
565
+ */
566
+ export type ParameterSerializeOptionsV3_55_0 = ParameterSerializeStyleOptionsV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
567
+ /**
568
+ * An array of key / value or directive config tuples
569
+ *
570
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
571
+ * via the `definition` "directiveMappingArray".
572
+ */
573
+ export type DirectiveMappingArrayV3_55_0 = DirectiveMappingArrayItemV3_55_0[];
574
+ /**
575
+ * A resolver which references a specific service
576
+ *
577
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
578
+ * via the `definition` "serviceResolver".
579
+ */
580
+ export type ServiceResolverV3_55_0 = TakeshapeResolverV3_55_0 | ShapedbResolverShapeNameNotRequiredV3_55_0 | ShapedbResolverV3_55_0 | GraphqlResolverV3_55_0 | RestResolverV3_55_0 | AwsLambdaResolverV3_55_0;
581
+ /**
582
+ * An array of key / value or directive config tuples
583
+ *
584
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
585
+ * via the `definition` "searchParamsMapping".
586
+ */
587
+ export type SearchParamsMappingV3_55_01 = DirectiveMappingArrayItemV3_55_0[];
588
+ /**
589
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
590
+ * via the `definition` "shapeWithObjectSchema".
591
+ */
592
+ export type ShapeWithObjectSchemaV3_55_0 = ShapeJSONV3_55_0 & {
593
+ schema: ObjectSchemaV3_55_0;
594
+ };
595
+ /**
596
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
597
+ * via the `definition` "serviceAuthentication".
598
+ */
599
+ export type ServiceAuthenticationV3_55_0 = OAuth2AuthenticationV3_55_0 | OAuth2BearerAuthenticationV3_55_0 | BearerAuthenticationV3_55_0 | BasicAuthenticationV3_55_0 | SearchParamsAuthenticationV3_55_0 | AWSAuthenticationV3_55_0 | GoogleAuthenticationV3_55_0 | CustomAuthenticationV3_55_0;
600
+ /**
601
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
602
+ * via the `definition` "anyServiceConfig".
603
+ */
604
+ export type AnyServiceConfigV3_55_0 = ServiceConfigJSONV3_55_0 | ServiceConfigV3_55_0;
605
+ export interface ProjectSchemaJSONV3_55_0 {
606
+ $schema?: string;
607
+ /**
608
+ * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
609
+ */
610
+ apiVersion: string;
611
+ /**
612
+ * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
613
+ */
614
+ schemaVersion: '3.55.0';
615
+ /**
616
+ * The ID of the TakeShape project this schema belongs to.
617
+ */
618
+ projectId: string;
619
+ /**
620
+ * The ID of the TakeShape user who created the schema.
621
+ */
622
+ author?: string;
623
+ deactivated?: number;
624
+ /**
625
+ * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
626
+ */
627
+ defaultLocale: string;
628
+ locales: string[];
629
+ queries: QueryMapV3_55_0;
630
+ mutations: QueryMapV3_55_0;
631
+ shapes: ShapeMapV3_55_0;
632
+ 'ai-experimental'?: AIExperimentalV3_55_0;
633
+ forms?: FormMapV3_55_0;
634
+ workflows: WorkflowMapV3_55_0;
635
+ services?: ServiceMapJSONV3_55_0;
636
+ }
637
+ /**
638
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
639
+ * via the `definition` "queryMap".
640
+ */
641
+ export interface QueryMapV3_55_0 {
642
+ [k: string]: QueryJSONV3_55_0;
643
+ }
644
+ /**
645
+ * This interface was referenced by `QueryMapV3_55_0`'s JSON-Schema definition
646
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
647
+ *
648
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
649
+ * via the `definition` "query".
650
+ */
651
+ export interface QueryJSONV3_55_0 {
652
+ args?: ArgsV3_55_0;
653
+ resolver: ResolverV3_55_0;
654
+ shape: ReturnShapeV3_55_0;
655
+ /**
656
+ * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
657
+ */
658
+ description?: string;
659
+ }
660
+ /**
661
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
662
+ * via the `definition` "propertySchema".
663
+ */
664
+ export interface PropertySchemaV3_55_0 {
665
+ $ref?: string;
666
+ title?: string;
667
+ description?: string;
668
+ default?: any;
669
+ readOnly?: boolean;
670
+ multipleOf?: number;
671
+ maximum?: number;
672
+ exclusiveMaximum?: number;
673
+ minimum?: number;
674
+ exclusiveMinimum?: number;
675
+ maxLength?: NonNegativeIntegerV3_55_0;
676
+ minLength?: NonNegativeIntegerDefault0V3_55_0;
677
+ pattern?: string;
678
+ additionalItems?: PropertySchemaV3_55_0;
679
+ items?: PropertySchemaV3_55_0;
680
+ maxItems?: NonNegativeIntegerV3_55_0;
681
+ minItems?: NonNegativeIntegerDefault0V3_55_0;
682
+ uniqueItems?: boolean;
683
+ contains?: PropertySchemaV3_55_0;
684
+ maxProperties?: NonNegativeIntegerV3_55_0;
685
+ minProperties?: NonNegativeIntegerDefault0V3_55_0;
686
+ required?: StringArrayV3_55_0;
687
+ additionalProperties?: PropertySchemaV3_55_0 | false;
688
+ definitions?: {
689
+ [k: string]: PropertySchemaV3_55_0;
690
+ };
691
+ properties?: {
692
+ [k: string]: PropertySchemaV3_55_0;
693
+ };
694
+ const?: any;
695
+ enum?: any[];
696
+ type?: SimpleTypesV3_55_0 | SimpleTypesV3_55_0[];
697
+ format?: string;
698
+ contentMediaType?: string;
699
+ contentEncoding?: string;
700
+ allOf?: SchemaArrayV3_55_0;
701
+ discriminator?: {
702
+ propertyName?: string;
703
+ [k: string]: any;
704
+ };
705
+ oneOf?: SchemaArrayV3_55_0;
706
+ extends?: ObjectOrRefArrayV3_55_0;
707
+ '@backreference'?: BackReferenceV3_55_0;
708
+ '@input'?: PropertySchemaV3_55_0;
709
+ '@output'?: PropertySchemaV3_55_0;
710
+ '@syncLocaleStructure'?: boolean;
711
+ '@sensitive'?: boolean;
712
+ '@draftjs'?: boolean;
713
+ '@l10n'?: boolean;
714
+ '@key'?: string;
715
+ '@workflow'?: string;
716
+ '@mapping'?: FieldMappingV3_55_0;
717
+ '@tag'?: string;
718
+ '@tags'?: string[];
719
+ '@deprecationReason'?: string;
720
+ '@args'?: ArgsV3_55_0;
721
+ '@resolver'?: ResolverV3_55_0;
722
+ '@dependencies'?: DependenciesV3_55_0;
723
+ '@ref'?: RefV3_55_0;
724
+ '@derivedFrom'?: string;
725
+ '@indexed'?: IndexedV3_55_0;
726
+ '@graphql'?: GraphQLConfigV3_55_0;
727
+ }
728
+ /**
729
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
730
+ * via the `definition` "refSchema".
731
+ */
732
+ export interface RefSchemaV3_55_0 {
733
+ '@ref': RefV3_55_0;
734
+ [k: string]: any;
735
+ }
736
+ /**
737
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
738
+ * via the `definition` "refSchemaLegacy".
739
+ */
740
+ export interface RefSchemaLegacyV3_55_0 {
741
+ $ref: RefV3_55_0;
742
+ [k: string]: any;
743
+ }
744
+ /**
745
+ * A configuration object for a reverse reference in a relationship.
746
+ *
747
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
748
+ * via the `definition` "backreference".
749
+ */
750
+ export interface BackReferenceV3_55_0 {
751
+ enabled: boolean;
752
+ name?: string;
753
+ }
754
+ /**
755
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
756
+ * via the `definition` "utilResolver".
757
+ */
758
+ export interface UtilResolverV3_55_0 {
759
+ if?: string;
760
+ id?: string;
761
+ name: UtilResolverNameV3_55_0;
762
+ options?: UtilResolverOptionsV3_55_0;
763
+ /**
764
+ * Optional value to return from the noop resolver.
765
+ */
766
+ value?: number | string | boolean | {
767
+ [k: string]: any;
768
+ } | any[] | null;
769
+ args?: ParameterConfigForJsonV3_55_0;
770
+ results?: ParameterConfigForJsonV3_55_0;
771
+ argsMapping?: ArgsMappingV3_55_0;
772
+ resultsMapping?: ResultsMappingV3_55_0;
773
+ }
774
+ export interface UtilResolverOptionsV3_55_0 {
775
+ [k: string]: any;
776
+ }
777
+ /**
778
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
779
+ * via the `definition` "parameterConfigForJson".
780
+ */
781
+ export interface ParameterConfigForJsonV3_55_0 {
782
+ ops: ParameterOpListV3_55_0;
783
+ }
784
+ /**
785
+ * An object describing an operation to generate a parameter, using a nested OpList.
786
+ *
787
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
788
+ * via the `definition` "parameterOpNested".
789
+ */
790
+ export interface ParameterOpNestedV3_55_0 {
791
+ /**
792
+ * A path to the parameter for this operation.
793
+ */
794
+ path: string;
795
+ /**
796
+ * A mode for this parameter's operation.
797
+ */
798
+ op?: 'set' | 'concat' | 'extend' | 'remove';
799
+ ops: ParameterOpListV3_55_0;
800
+ }
801
+ /**
802
+ * An object describing an operation to generate a parameter using a value.
803
+ *
804
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
805
+ * via the `definition` "parameterOpValue".
806
+ */
807
+ export interface ParameterOpValueV3_55_0 {
808
+ /**
809
+ * A path to the parameter for this operation.
810
+ */
811
+ path: string;
812
+ /**
813
+ * A mode for this parameter's operation.
814
+ */
815
+ op?: 'set' | 'concat' | 'extend' | 'remove';
816
+ /**
817
+ * A value to set directly at this path.
818
+ */
819
+ value: number | string | boolean | {
820
+ [k: string]: any;
821
+ } | any[] | null;
822
+ }
823
+ /**
824
+ * An object describing an operation to generate a parameter using a mapping.
825
+ *
826
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
827
+ * via the `definition` "parameterOpMapping".
828
+ */
829
+ export interface ParameterOpMappingV3_55_0 {
830
+ /**
831
+ * A path to the parameter for this operation.
832
+ */
833
+ path: string;
834
+ /**
835
+ * A mode for this parameter's operation.
836
+ */
837
+ op?: 'set' | 'concat' | 'extend' | 'remove';
838
+ /**
839
+ * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
840
+ */
841
+ mapping: string | DirectiveConfigV3_55_0;
842
+ }
843
+ export interface DirectiveOptionsV3_55_0 {
844
+ [k: string]: any;
845
+ }
846
+ /**
847
+ * An object describing an operation to generate a parameter using a mapping.
848
+ *
849
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
850
+ * via the `definition` "parameterOpOp".
851
+ */
852
+ export interface ParameterOpOpV3_55_0 {
853
+ /**
854
+ * A path to the parameter for this operation.
855
+ */
856
+ path: string;
857
+ /**
858
+ * A mode for this parameter's operation.
859
+ */
860
+ op: 'set' | 'concat' | 'extend' | 'remove';
861
+ }
862
+ /**
863
+ * An map of object keys / key paths to directive configs
864
+ *
865
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
866
+ * via the `definition` "directiveMappingMap".
867
+ */
868
+ export interface DirectiveMappingMapV3_55_0 {
869
+ [k: string]: DirectiveConfigV3_55_0;
870
+ }
871
+ /**
872
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
873
+ * via the `definition` "delegateResolver".
874
+ */
875
+ export interface DelegateResolverV3_55_0 {
876
+ if?: string;
877
+ id?: string;
878
+ name: DelegateResolverNameV3_55_0;
879
+ options?: DelegateResolverOptionsV3_55_0;
880
+ argsMapping?: ArgsMappingV3_55_0;
881
+ resultsMapping?: ResultsMappingV3_55_0;
882
+ /**
883
+ * A ref to a query/mutation/property to delegate to.
884
+ */
885
+ to: string;
886
+ args?: ParameterConfigForJsonV3_55_0;
887
+ results?: ParameterConfigForJsonV3_55_0;
888
+ }
889
+ export interface DelegateResolverOptionsV3_55_0 {
890
+ [k: string]: any;
891
+ }
892
+ /**
893
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
894
+ * via the `definition` "takeshapeResolver".
895
+ */
896
+ export interface TakeshapeResolverV3_55_0 {
897
+ if?: string;
898
+ id?: string;
899
+ name: TakeshapeResolverNameV3_55_0;
900
+ /**
901
+ * Internal service identifier.
902
+ */
903
+ service: 'takeshape';
904
+ options?: TakeshapeResolverOptionsV3_55_0;
905
+ /**
906
+ * An optional Shape name for the resolver.
907
+ */
908
+ shapeName?: string;
909
+ args?: ParameterConfigForJsonV3_55_0;
910
+ results?: ParameterConfigForJsonV3_55_0;
911
+ argsMapping?: ArgsMappingV3_55_0;
912
+ resultsMapping?: ResultsMappingV3_55_0;
913
+ }
914
+ export interface TakeshapeResolverOptionsV3_55_0 {
915
+ [k: string]: any;
916
+ }
917
+ /**
918
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
919
+ * via the `definition` "shapedbResolver".
920
+ */
921
+ export interface ShapedbResolverV3_55_0 {
922
+ if?: string;
923
+ id?: string;
924
+ name: ShapedbResolverNameV3_55_0;
925
+ /**
926
+ * Internal service identifier.
927
+ */
928
+ service: 'shapedb';
929
+ options?: ShapedbResolverOptionsV3_55_0;
930
+ argsMapping?: ArgsMappingV3_55_0;
931
+ resultsMapping?: ResultsMappingV3_55_0;
932
+ /**
933
+ * A Shape name for the resolver to use.
934
+ */
935
+ shapeName: string;
936
+ args?: ParameterConfigForJsonV3_55_0;
937
+ results?: ParameterConfigForJsonV3_55_0;
938
+ }
939
+ export interface ShapedbResolverOptionsV3_55_0 {
940
+ [k: string]: any;
941
+ }
942
+ /**
943
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
944
+ * via the `definition` "shapedbResolverShapeNameNotRequired".
945
+ */
946
+ export interface ShapedbResolverShapeNameNotRequiredV3_55_0 {
947
+ if?: string;
948
+ id?: string;
949
+ name: ShapedbResolverShapeNameNotRequiredNameV3_55_0;
950
+ /**
951
+ * Internal service identifier.
952
+ */
953
+ service: 'shapedb';
954
+ options?: ShapedbResolverShapeNameNotRequiredOptionsV3_55_0;
955
+ /**
956
+ * An optional Shape name for the resolver.
957
+ */
958
+ shapeName?: string;
959
+ args?: ParameterConfigForJsonV3_55_0;
960
+ results?: ParameterConfigForJsonV3_55_0;
961
+ argsMapping?: ArgsMappingV3_55_0;
962
+ resultsMapping?: ResultsMappingV3_55_0;
963
+ }
964
+ export interface ShapedbResolverShapeNameNotRequiredOptionsV3_55_0 {
965
+ [k: string]: any;
966
+ }
967
+ /**
968
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
969
+ * via the `definition` "graphqlResolver".
970
+ */
971
+ export interface GraphqlResolverV3_55_0 {
972
+ if?: string;
973
+ id?: string;
974
+ name: GraphqlResolverNameV3_55_0;
975
+ /**
976
+ * Configuration for a service to use with this resolver.
977
+ */
978
+ service: string;
979
+ argsMapping?: ArgsMappingV3_55_0;
980
+ resultsMapping?: ResultsMappingV3_55_0;
981
+ options?: GraphqlResolverOptionsV3_55_0;
982
+ /**
983
+ * A fieldname to use in queries.
984
+ */
985
+ fieldName: string;
986
+ headers?: ParameterConfigForHeadersV3_55_0;
987
+ searchParams?: ParameterConfigForSearchParamsV3_55_0;
988
+ args?: ParameterConfigForJsonV3_55_0;
989
+ results?: ParameterConfigForJsonV3_55_0;
990
+ }
991
+ export interface GraphqlResolverOptionsV3_55_0 {
992
+ selectionSet?: string;
993
+ unboxParentSelectionSet?: boolean;
994
+ ignoreErrors?: boolean;
995
+ skipWhenMissingArgs?: boolean;
996
+ ttl?: number;
997
+ timeout?: number;
998
+ allowStream?: boolean;
999
+ retry?: number | {
1000
+ [k: string]: any;
1001
+ };
1002
+ [k: string]: any;
1003
+ }
1004
+ /**
1005
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1006
+ * via the `definition` "parameterConfigForHeaders".
1007
+ */
1008
+ export interface ParameterConfigForHeadersV3_55_0 {
1009
+ ops: ParameterOpListV3_55_0;
1010
+ serialize?: ParameterSerializeConfigForHeadersV3_55_0;
1011
+ }
1012
+ /**
1013
+ * Top-level paths to use headers serialization options for.
1014
+ *
1015
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1016
+ * via the `definition` "parameterSerializeConfigForHeaders".
1017
+ */
1018
+ export interface ParameterSerializeConfigForHeadersV3_55_0 {
1019
+ defaults?: ParameterSerializeStyleOptionsForHeadersV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
1020
+ paths?: {
1021
+ /**
1022
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1023
+ * via the `patternProperty` "^[^\n\r]*$".
1024
+ */
1025
+ [k: string]: ParameterSerializeStyleOptionsForHeadersV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
1026
+ };
1027
+ }
1028
+ /**
1029
+ * Options to be passed to the serialization routine.
1030
+ *
1031
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1032
+ * via the `definition` "parameterSerializeStyleOptionsForHeaders".
1033
+ */
1034
+ export interface ParameterSerializeStyleOptionsForHeadersV3_55_0 {
1035
+ style: 'simple' | 'none';
1036
+ explode?: boolean;
1037
+ }
1038
+ /**
1039
+ * Options to be passed to the serialization routine.
1040
+ *
1041
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1042
+ * via the `definition` "parameterSerializeContentOptions".
1043
+ */
1044
+ export interface ParameterSerializeContentOptionsV3_55_0 {
1045
+ contentType: string;
1046
+ /**
1047
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1048
+ */
1049
+ allowReserved?: boolean;
1050
+ skipEncoding?: boolean;
1051
+ /**
1052
+ * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
1053
+ */
1054
+ options?: {
1055
+ [k: string]: any;
1056
+ };
1057
+ }
1058
+ /**
1059
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1060
+ * via the `definition` "parameterConfigForSearchParams".
1061
+ */
1062
+ export interface ParameterConfigForSearchParamsV3_55_0 {
1063
+ ops: ParameterOpListV3_55_0;
1064
+ serialize?: ParameterSerializeConfigForSearchParamsV3_55_0;
1065
+ }
1066
+ /**
1067
+ * Top-level paths to use search params serialization options for.
1068
+ *
1069
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1070
+ * via the `definition` "parameterSerializeConfigForSearchParams".
1071
+ */
1072
+ export interface ParameterSerializeConfigForSearchParamsV3_55_0 {
1073
+ defaults?: ParameterSerializeStyleOptionsForSearchParamsV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
1074
+ paths?: {
1075
+ /**
1076
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1077
+ * via the `patternProperty` "^[^\n\r]*$".
1078
+ */
1079
+ [k: string]: ParameterSerializeStyleOptionsForSearchParamsV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
1080
+ };
1081
+ }
1082
+ /**
1083
+ * Options to be passed to the serialization routine.
1084
+ *
1085
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1086
+ * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
1087
+ */
1088
+ export interface ParameterSerializeStyleOptionsForSearchParamsV3_55_0 {
1089
+ style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
1090
+ explode?: boolean;
1091
+ allowEmptyValue?: boolean;
1092
+ /**
1093
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1094
+ */
1095
+ allowReserved?: boolean;
1096
+ skipEncoding?: boolean;
1097
+ }
1098
+ /**
1099
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1100
+ * via the `definition` "restResolver".
1101
+ */
1102
+ export interface RestResolverV3_55_0 {
1103
+ if?: string;
1104
+ id?: string;
1105
+ name: RestResolverNameV3_55_0;
1106
+ /**
1107
+ * Configuration for a service to use with this resolver.
1108
+ */
1109
+ service: string;
1110
+ argsMapping?: ArgsMappingV3_55_0;
1111
+ searchParamsMapping?: SearchParamsMappingV3_55_0;
1112
+ resultsMapping?: ResultsMappingV3_55_0;
1113
+ options?: RestResolverOptionsV3_55_0;
1114
+ body?: ParameterConfigForBodyV3_55_0;
1115
+ form?: ParameterConfigForSearchParamsV3_55_0;
1116
+ headers?: ParameterConfigForHeadersV3_55_0;
1117
+ json?: ParameterConfigForJsonV3_55_0;
1118
+ /**
1119
+ * Mapping and serialization configuration for the path, or a simple string.
1120
+ */
1121
+ path: ParameterConfigForPathParamsV3_55_0 | string;
1122
+ searchParams?: ParameterConfigForSearchParamsV3_55_0;
1123
+ args?: ParameterConfigForJsonV3_55_0;
1124
+ results?: ParameterConfigForJsonV3_55_0;
1125
+ }
1126
+ export interface RestResolverOptionsV3_55_0 {
1127
+ trailingSlash?: boolean;
1128
+ allowStream?: boolean;
1129
+ ttl?: number;
1130
+ timeout?: number;
1131
+ retry?: number | {
1132
+ [k: string]: any;
1133
+ };
1134
+ [k: string]: any;
1135
+ }
1136
+ /**
1137
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1138
+ * via the `definition` "parameterConfigForBody".
1139
+ */
1140
+ export interface ParameterConfigForBodyV3_55_0 {
1141
+ ops: ParameterOpListV3_55_0;
1142
+ serialize?: ParameterSerializeConfigForBodyV3_55_0;
1143
+ }
1144
+ /**
1145
+ * Top-level paths to use serialization options for.
1146
+ *
1147
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1148
+ * via the `definition` "parameterSerializeConfigForBody".
1149
+ */
1150
+ export interface ParameterSerializeConfigForBodyV3_55_0 {
1151
+ content?: ParameterSerializeContentOptionsV3_55_0;
1152
+ }
1153
+ /**
1154
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1155
+ * via the `definition` "parameterConfigForPathParams".
1156
+ */
1157
+ export interface ParameterConfigForPathParamsV3_55_0 {
1158
+ ops: ParameterOpListV3_55_0;
1159
+ serialize: ParameterSerializeConfigForPathParamsV3_55_0;
1160
+ }
1161
+ /**
1162
+ * Top-level paths to use path params serialization options for.
1163
+ *
1164
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1165
+ * via the `definition` "parameterSerializeConfigForPathParams".
1166
+ */
1167
+ export interface ParameterSerializeConfigForPathParamsV3_55_0 {
1168
+ /**
1169
+ * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
1170
+ */
1171
+ template: string;
1172
+ defaults?: ParameterSerializeStyleOptionsForPathParamsV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
1173
+ paths?: {
1174
+ /**
1175
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1176
+ * via the `patternProperty` "^[^\n\r]*$".
1177
+ */
1178
+ [k: string]: ParameterSerializeStyleOptionsForPathParamsV3_55_0 | ParameterSerializeContentOptionsV3_55_0;
1179
+ };
1180
+ }
1181
+ /**
1182
+ * Options to be passed to the serialization routine.
1183
+ *
1184
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1185
+ * via the `definition` "parameterSerializeStyleOptionsForPathParams".
1186
+ */
1187
+ export interface ParameterSerializeStyleOptionsForPathParamsV3_55_0 {
1188
+ style: 'simple' | 'label' | 'matrix' | 'none';
1189
+ explode?: boolean;
1190
+ allowEmptyValue?: boolean;
1191
+ /**
1192
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1193
+ */
1194
+ allowReserved?: boolean;
1195
+ skipEncoding?: boolean;
1196
+ }
1197
+ /**
1198
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1199
+ * via the `definition` "awsLambdaResolver".
1200
+ */
1201
+ export interface AwsLambdaResolverV3_55_0 {
1202
+ if?: string;
1203
+ id?: string;
1204
+ name: AwsLambdaResolverNameV3_55_0;
1205
+ /**
1206
+ * Configuration for a service to use with this resolver.
1207
+ */
1208
+ service: string;
1209
+ options?: AwsLambdaResolverOptionsV3_55_0;
1210
+ payload?: ParameterConfigForJsonV3_55_0;
1211
+ /**
1212
+ * Mapping configuration for the FunctionName.
1213
+ */
1214
+ functionName: string | ParameterConfigForAwsLambdaV3_55_0;
1215
+ clientContext?: ParameterConfigForJsonV3_55_0;
1216
+ args?: ParameterConfigForJsonV3_55_0;
1217
+ results?: ParameterConfigForJsonV3_55_0;
1218
+ argsMapping?: ArgsMappingV3_55_0;
1219
+ searchParamsMapping?: SearchParamsMappingV3_55_0;
1220
+ resultsMapping?: ResultsMappingV3_55_0;
1221
+ }
1222
+ export interface AwsLambdaResolverOptionsV3_55_0 {
1223
+ [k: string]: any;
1224
+ }
1225
+ /**
1226
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1227
+ * via the `definition` "parameterConfigForAwsLambda".
1228
+ */
1229
+ export interface ParameterConfigForAwsLambdaV3_55_0 {
1230
+ ops: ParameterOpListV3_55_0;
1231
+ serialize: ParameterSerializeConfigForPathParamsV3_55_0;
1232
+ }
1233
+ /**
1234
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1235
+ * via the `definition` "salsifyResolver".
1236
+ */
1237
+ export interface SalsifyResolverV3_55_0 {
1238
+ if?: string;
1239
+ id?: string;
1240
+ name: SalsifyResolverNameV3_55_0;
1241
+ /**
1242
+ * Configuration for a service to use with this resolver.
1243
+ */
1244
+ service: string;
1245
+ options?: SalsifyResolverOptionsV3_55_0;
1246
+ args?: ParameterConfigForJsonV3_55_0;
1247
+ results?: ParameterConfigForJsonV3_55_0;
1248
+ argsMapping?: ArgsMappingV3_55_0;
1249
+ resultsMapping?: ResultsMappingV3_55_0;
1250
+ }
1251
+ export interface SalsifyResolverOptionsV3_55_0 {
1252
+ [k: string]: any;
1253
+ }
1254
+ /**
1255
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1256
+ * via the `definition` "syndigoResolver".
1257
+ */
1258
+ export interface SyndigoResolverV3_55_0 {
1259
+ if?: string;
1260
+ id?: string;
1261
+ name: SyndigoResolverNameV3_55_0;
1262
+ /**
1263
+ * Configuration for a service to use with this resolver.
1264
+ */
1265
+ service: string;
1266
+ options?: SyndigoResolverOptionsV3_55_0;
1267
+ args?: ParameterConfigForJsonV3_55_0;
1268
+ results?: ParameterConfigForJsonV3_55_0;
1269
+ argsMapping?: ArgsMappingV3_55_0;
1270
+ resultsMapping?: ResultsMappingV3_55_0;
1271
+ }
1272
+ export interface SyndigoResolverOptionsV3_55_0 {
1273
+ [k: string]: any;
1274
+ }
1275
+ /**
1276
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1277
+ * via the `definition` "functionResolver".
1278
+ */
1279
+ export interface FunctionResolverV3_55_0 {
1280
+ if?: string;
1281
+ id?: string;
1282
+ name: FunctionResolverNameV3_55_0;
1283
+ options?: FunctionResolverOptionsV3_55_0;
1284
+ args?: ParameterConfigForJsonV3_55_0;
1285
+ results?: ParameterConfigForJsonV3_55_0;
1286
+ argsMapping?: ArgsMappingV3_55_0;
1287
+ resultsMapping?: ResultsMappingV3_55_0;
1288
+ javascript?: FunctionResolverJavascriptV3_55_0;
1289
+ }
1290
+ export interface FunctionResolverOptionsV3_55_0 {
1291
+ [k: string]: any;
1292
+ }
1293
+ /**
1294
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1295
+ * via the `definition` "aiGenerateTextResolver".
1296
+ */
1297
+ export interface AIGenerateTextResolverV3_55_0 {
1298
+ if?: string;
1299
+ id?: string;
1300
+ name: AIResolverNameV3_55_0;
1301
+ /**
1302
+ * Configuration for a service to use with this resolver.
1303
+ */
1304
+ service: string;
1305
+ options?: AIGenerateTextResolverOptionsV3_55_0;
1306
+ systemPrompt: string;
1307
+ inputTemplate?: string;
1308
+ model: string;
1309
+ tools?: (string | AIToolConfigV3_55_0)[];
1310
+ guardrails?: AIGuardrailV3_55_0[];
1311
+ context?: ParameterConfigForJsonV3_55_0;
1312
+ results?: ParameterConfigForJsonV3_55_0;
1313
+ }
1314
+ /**
1315
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1316
+ * via the `definition` "aiGenerateTextResolverOptions".
1317
+ */
1318
+ export interface AIGenerateTextResolverOptionsV3_55_0 {
1319
+ history?: HistoryV3_55_0;
1320
+ maxTokens?: MaximumTokensV3_55_0;
1321
+ temperature?: TemperatureV3_55_0;
1322
+ topP?: TopPV3_55_0;
1323
+ topK?: TopKV3_55_0;
1324
+ presencePenalty?: PresencePenaltySettingV3_55_0;
1325
+ frequencyPenalty?: FrequencyPenaltySettingV3_55_0;
1326
+ stopSequences?: StopSequencesV3_55_0;
1327
+ seed?: SeedV3_55_0;
1328
+ /**
1329
+ * Maximum number of retries. Set to 0 to disable retries. Defaults to 2
1330
+ */
1331
+ maxRetries?: number;
1332
+ /**
1333
+ * The tool choice strategy. Default: 'auto'
1334
+ */
1335
+ toolChoice?: (('auto' | 'none' | 'required') | string) & string;
1336
+ /**
1337
+ * Maximal number of automatic roundtrips for tool calls.
1338
+ */
1339
+ maxToolRoundtrips?: number;
1340
+ [k: string]: any;
1341
+ }
1342
+ /**
1343
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1344
+ * via the `definition` "aiToolConfig".
1345
+ */
1346
+ export interface AIToolConfigV3_55_0 {
1347
+ ref: string;
1348
+ selectionSet?: string;
1349
+ }
1350
+ /**
1351
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1352
+ * via the `definition` "aiSimilarityGuardrail".
1353
+ */
1354
+ export interface AISimilarityGuardrailV3_55_0 {
1355
+ name: 'similarity';
1356
+ shape: string;
1357
+ defaultResponse: string;
1358
+ threshold?: number;
1359
+ }
1360
+ /**
1361
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1362
+ * via the `definition` "aiGeneratePropertyResolver".
1363
+ */
1364
+ export interface AIGeneratePropertyResolverV3_55_0 {
1365
+ id?: string;
1366
+ name: AIResolverNameV3_55_01;
1367
+ /**
1368
+ * Configuration for a service to use with this resolver.
1369
+ */
1370
+ service: string;
1371
+ model: string;
1372
+ systemPrompt?: string;
1373
+ }
1374
+ /**
1375
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1376
+ * via the `definition` "aiEmbeddingResolver".
1377
+ */
1378
+ export interface AIEmbeddingResolverV3_55_0 {
1379
+ if?: string;
1380
+ id?: string;
1381
+ name: AIResolverNameV3_55_02;
1382
+ /**
1383
+ * Configuration for a service to use with this resolver.
1384
+ */
1385
+ service: string;
1386
+ options?: AIEmbeddingResolverOptionsV3_55_0;
1387
+ model: string;
1388
+ args?: ParameterConfigForJsonV3_55_0;
1389
+ results?: ParameterConfigForJsonV3_55_0;
1390
+ }
1391
+ /**
1392
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1393
+ * via the `definition` "aiEmbeddingResolverOptions".
1394
+ */
1395
+ export interface AIEmbeddingResolverOptionsV3_55_0 {
1396
+ useDependencies?: boolean;
1397
+ [k: string]: any;
1398
+ }
1399
+ /**
1400
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1401
+ * via the `definition` "aiEmbeddingSearchResolver".
1402
+ */
1403
+ export interface AIEmbeddingSearchResolverV3_55_0 {
1404
+ if?: string;
1405
+ id?: string;
1406
+ name: AIResolverNameV3_55_03;
1407
+ /**
1408
+ * A vector property ref to use for the query.
1409
+ */
1410
+ vectorProperty: string;
1411
+ args?: ParameterConfigForJsonV3_55_0;
1412
+ results?: ParameterConfigForJsonV3_55_0;
1413
+ }
1414
+ /**
1415
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1416
+ * via the `definition` "aiParseFileResolver".
1417
+ */
1418
+ export interface AIParseFileResolverV3_55_0 {
1419
+ if?: string;
1420
+ id?: string;
1421
+ name: AIResolverNameV3_55_04;
1422
+ /**
1423
+ * Configuration for a service to use with this resolver.
1424
+ */
1425
+ service: string;
1426
+ options?: AIEmbeddingResolverOptionsV3_55_0;
1427
+ args?: ParameterConfigForJsonV3_55_0;
1428
+ results?: ParameterConfigForJsonV3_55_0;
1429
+ }
1430
+ /**
1431
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1432
+ * via the `definition` "utilChunkResolver".
1433
+ */
1434
+ export interface ChunkResolverV3_55_0 {
1435
+ if?: string;
1436
+ id?: string;
1437
+ name: UtilResolverNameV3_55_01;
1438
+ options: UtilChunkResolverOptionsV3_55_0;
1439
+ args?: ParameterConfigForJsonV3_55_0;
1440
+ results?: ParameterConfigForJsonV3_55_0;
1441
+ }
1442
+ /**
1443
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1444
+ * via the `definition` "utilChunkResolverOptionsCharacterCount".
1445
+ */
1446
+ export interface UtilChunkResolverOptionsCharacterCountV3_55_0 {
1447
+ type: 'characterCount';
1448
+ characterCount: number;
1449
+ }
1450
+ /**
1451
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1452
+ * via the `definition` "utilChunkResolverOptionsSeparators".
1453
+ */
1454
+ export interface UtilChunkResolverOptionsSeparatorsV3_55_0 {
1455
+ type: 'separators';
1456
+ separators: string[];
1457
+ }
1458
+ /**
1459
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1460
+ * via the `definition` "utilChunkResolverOptionsMarkdown".
1461
+ */
1462
+ export interface UtilChunkResolverOptionsMarkdownV3_55_0 {
1463
+ type: 'markdown';
1464
+ /**
1465
+ * New chunks will be created at headers for this level or lower. Default 2.
1466
+ */
1467
+ headerLevel?: number;
1468
+ /**
1469
+ * A new chunk will be started when this number of characters is reached, regardless of markup.
1470
+ */
1471
+ maxCharacters?: number;
1472
+ }
1473
+ /**
1474
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1475
+ * via the `definition` "utilChunkResolverOptionsSemantic".
1476
+ */
1477
+ export interface UtilChunkResolverOptionsSemanticV3_55_0 {
1478
+ type: 'semantic';
1479
+ serviceId: string;
1480
+ modelId: string;
1481
+ /**
1482
+ * Similarity below which two embeddings are considered different.
1483
+ */
1484
+ similarityThreshold?: number;
1485
+ /**
1486
+ * Advanced. How many sentences to advance when grouping sentences to create embeddings. Default 1.
1487
+ */
1488
+ stride?: number;
1489
+ /**
1490
+ * Advanced. How many sentences are grouped together to create embeddings. Default 3.
1491
+ */
1492
+ sentenceCount?: number;
1493
+ /**
1494
+ * The maximum number of characters in a chunk.
1495
+ */
1496
+ maxCharacters?: number;
1497
+ /**
1498
+ * The maximum number of tokens in a chunk.
1499
+ */
1500
+ maxTokens?: number;
1501
+ }
1502
+ export interface AIRunAgentResolverV3_55_0 {
1503
+ id?: string;
1504
+ name: AIResolverNameV3_55_05;
1505
+ agentName: string;
1506
+ }
1507
+ export interface AIInspectAgentResolverV3_55_0 {
1508
+ id?: string;
1509
+ name: AIResolverNameV3_55_06;
1510
+ agentName: string;
1511
+ }
1512
+ /**
1513
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1514
+ * via the `definition` "composeResolver".
1515
+ */
1516
+ export interface ComposeResolverV3_55_0 {
1517
+ compose: BasicResolverV3_55_0[];
1518
+ resultsMapping?: DirectiveMappingMapV3_55_0 | DirectiveConfigV3_55_0;
1519
+ results?: ParameterConfigForJsonV3_55_0;
1520
+ }
1521
+ /**
1522
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1523
+ * via the `definition` "indexed".
1524
+ */
1525
+ export interface IndexedV3_55_0 {
1526
+ nested?: boolean;
1527
+ }
1528
+ /**
1529
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1530
+ * via the `definition` "graphql".
1531
+ */
1532
+ export interface GraphQLConfigV3_55_0 {
1533
+ json?: boolean;
1534
+ }
1535
+ /**
1536
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1537
+ * via the `definition` "shapeMap".
1538
+ */
1539
+ export interface ShapeMapV3_55_0 {
1540
+ [k: string]: ShapeJSONV3_55_0;
1541
+ }
1542
+ /**
1543
+ * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
1544
+ *
1545
+ * This interface was referenced by `ShapeMapV3_55_0`'s JSON-Schema definition
1546
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
1547
+ *
1548
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1549
+ * via the `definition` "shape".
1550
+ */
1551
+ export interface ShapeJSONV3_55_0 {
1552
+ /**
1553
+ * 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
1554
+ */
1555
+ name: string;
1556
+ /**
1557
+ * 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.
1558
+ */
1559
+ id: string;
1560
+ /**
1561
+ * The human-readable name for a Shape for use in a UI.
1562
+ */
1563
+ title: string;
1564
+ description?: string;
1565
+ type?: 'interface' | 'input' | 'output';
1566
+ interfaces?: string[];
1567
+ /**
1568
+ * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
1569
+ */
1570
+ model?: {
1571
+ type: ModelTypeV3_55_0;
1572
+ };
1573
+ workflow?: string;
1574
+ loaders?: ShapeLoadersV3_55_0;
1575
+ joins?: ShapeJoinsV3_55_0;
1576
+ cache?: ShapeCacheConfigV3_55_0;
1577
+ schema: ShapeSchemaV3_55_0;
1578
+ }
1579
+ /**
1580
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1581
+ * via the `definition` "shapeLoaders".
1582
+ */
1583
+ export interface ShapeLoadersV3_55_0 {
1584
+ list: StoredListQueryLoaderConfigV3_55_0 | StoredListQueryLoaderConfigV3_55_0[];
1585
+ get?: GetQueryLoaderConfigV3_55_0;
1586
+ }
1587
+ /**
1588
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1589
+ * via the `definition` "storedListQueryLoaderConfig".
1590
+ */
1591
+ export interface StoredListQueryLoaderConfigV3_55_0 {
1592
+ query: string;
1593
+ args?: {
1594
+ [k: string]: any;
1595
+ } | {
1596
+ [k: string]: any;
1597
+ }[];
1598
+ pagination?: PaginationConfigV3_55_0;
1599
+ }
1600
+ /**
1601
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1602
+ * via the `definition` "paginationCursorConfig".
1603
+ */
1604
+ export interface PaginationCursorConfigV3_55_0 {
1605
+ type: 'cursor';
1606
+ cursorArg: string;
1607
+ cursorPath: string;
1608
+ pageSize?: number;
1609
+ pageSizeArg: string;
1610
+ hasMorePath: string;
1611
+ itemsPath: string;
1612
+ }
1613
+ /**
1614
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1615
+ * via the `definition` "paginationPageConfig".
1616
+ */
1617
+ export interface PaginationPageConfigV3_55_0 {
1618
+ type: 'page';
1619
+ pageArg: string;
1620
+ pageSize?: number;
1621
+ pageSizeArg?: string;
1622
+ itemsPath: string;
1623
+ pageTotalPath: string;
1624
+ }
1625
+ /**
1626
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1627
+ * via the `definition` "paginationOffsetConfig".
1628
+ */
1629
+ export interface PaginationOffsetConfigV3_55_0 {
1630
+ type: 'offset';
1631
+ offsetArg: string;
1632
+ pageSize?: number;
1633
+ pageSizeArg?: string;
1634
+ itemsPath: string;
1635
+ itemTotalPath: string;
1636
+ }
1637
+ /**
1638
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1639
+ * via the `definition` "getQueryLoaderConfig".
1640
+ */
1641
+ export interface GetQueryLoaderConfigV3_55_0 {
1642
+ query: string;
1643
+ args?: {
1644
+ [k: string]: any;
1645
+ };
1646
+ idArg?: string;
1647
+ }
1648
+ /**
1649
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1650
+ * via the `definition` "shapeJoins".
1651
+ */
1652
+ export interface ShapeJoinsV3_55_0 {
1653
+ [k: string]: ShapeJoinV3_55_0;
1654
+ }
1655
+ /**
1656
+ * This interface was referenced by `ShapeJoinsV3_55_0`'s JSON-Schema definition
1657
+ * via the `patternProperty` "[:0-9A-Za-z_-]+".
1658
+ *
1659
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1660
+ * via the `definition` "shapeJoin".
1661
+ */
1662
+ export interface ShapeJoinV3_55_0 {
1663
+ resolver: DelegateResolverV3_55_0 | ShapedbResolverV3_55_0;
1664
+ dependencies?: string;
1665
+ }
1666
+ /**
1667
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1668
+ * via the `definition` "shapeCacheConfig".
1669
+ */
1670
+ export interface ShapeCacheConfigV3_55_0 {
1671
+ enabled: boolean;
1672
+ idField?: string;
1673
+ searchSummaryField?: string;
1674
+ fragment?: CachedFragmentConfigV3_55_0;
1675
+ triggers?: CacheTriggerConfigV3_55_0[];
1676
+ /**
1677
+ * Number of seconds this Shape should be cached. Default 0.
1678
+ */
1679
+ maxAge?: number;
1680
+ }
1681
+ /**
1682
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1683
+ * via the `definition` "cachedFragmentConfig".
1684
+ */
1685
+ export interface CachedFragmentConfigV3_55_0 {
1686
+ ignoreFields?: string[];
1687
+ maxDepth?: number;
1688
+ selectionSet?: string;
1689
+ includeDeprecated?: boolean;
1690
+ }
1691
+ /**
1692
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1693
+ * via the `definition` "cacheScheduleTriggerConfig".
1694
+ */
1695
+ export interface CacheScheduleTriggerConfigV3_55_0 {
1696
+ type: 'schedule';
1697
+ loader: 'get' | 'list';
1698
+ interval: number;
1699
+ }
1700
+ /**
1701
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1702
+ * via the `definition` "cacheWebhookTriggerConfig".
1703
+ */
1704
+ export interface CacheWebhookTriggerConfigV3_55_0 {
1705
+ type: 'webhook';
1706
+ loader: 'get' | 'list';
1707
+ service: string;
1708
+ events: string[];
1709
+ }
1710
+ /**
1711
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1712
+ * via the `definition` "shapeSchemaAllOf".
1713
+ */
1714
+ export interface ShapeSchemaAllOfV3_55_0 {
1715
+ allOf: ObjectOrRefArrayV3_55_0;
1716
+ }
1717
+ /**
1718
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1719
+ * via the `definition` "shapeSchemaExtends".
1720
+ */
1721
+ export interface ShapeSchemaExtendsV3_55_0 {
1722
+ extends: ObjectOrRefArrayV3_55_0;
1723
+ }
1724
+ /**
1725
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1726
+ * via the `definition` "shapeSchemaOneOf".
1727
+ */
1728
+ export interface ShapeSchemaOneOfV3_55_0 {
1729
+ oneOf: ObjectOrRefArrayV3_55_0;
1730
+ }
1731
+ /**
1732
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1733
+ * via the `definition` "shapeSchemaEnum".
1734
+ */
1735
+ export interface ShapeSchemaEnumV3_55_0 {
1736
+ enum: any[];
1737
+ }
1738
+ /**
1739
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
1740
+ * via the `definition` "shapeSchemaAny".
1741
+ */
1742
+ export interface ShapeSchemaAnyV3_55_0 {
1743
+ }
1744
+ export interface AIExperimentalV3_55_0 {
1745
+ agents?: AgentMapV3_55_0;
1746
+ guards?: GuardMapV3_55_0;
1747
+ tools?: ToolMapV3_55_0;
1748
+ }
1749
+ export interface AgentMapV3_55_0 {
1750
+ [k: string]: AgentJSONV3_55_0;
1751
+ }
1752
+ /**
1753
+ * An Agent is a configuration for an AI service such as a chat bot or a search engine.
1754
+ *
1755
+ * This interface was referenced by `AgentMapV3_55_0`'s JSON-Schema definition
1756
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
1757
+ */
1758
+ export interface AgentJSONV3_55_0 {
1759
+ description?: string;
1760
+ systemPrompt?: string;
1761
+ api: AgentAPIV3_55_0;
1762
+ memory?: AgentMemoryV3_55_0;
1763
+ start: AgentStartV3_55_0;
1764
+ states: AgentStatesV3_55_0;
1765
+ guards?: AgentGuardV3_55_0[];
1766
+ }
1767
+ export interface AgentAPIChatV3_55_0 {
1768
+ type: 'chat';
1769
+ interactionTimeout?: InteractionTimeoutMillisecondsV3_55_0;
1770
+ arguments?: AgentAPIArgumentV3_55_0[];
1771
+ }
1772
+ export interface AgentAPIArgumentV3_55_0 {
1773
+ argName: string;
1774
+ argDescription?: string;
1775
+ argType: 'boolean' | 'integer' | 'number' | 'string' | 'sessionId';
1776
+ required?: boolean;
1777
+ }
1778
+ export interface AgentAPIGenerateV3_55_0 {
1779
+ type: 'generate';
1780
+ interactionTimeout?: InteractionTimeoutMillisecondsV3_55_01;
1781
+ arguments?: AgentAPIArgumentV3_55_0[];
1782
+ }
1783
+ export interface AgentMemoryV3_55_0 {
1784
+ sessionMemory: AgentSessionMemoryV3_55_0;
1785
+ }
1786
+ export interface AgentSessionMemoryV3_55_0 {
1787
+ shape?: string;
1788
+ }
1789
+ /**
1790
+ * Configuration for the start of an agent's execution
1791
+ */
1792
+ export interface AgentStartV3_55_0 {
1793
+ transition: AgentTransitionStepV3_55_0[];
1794
+ }
1795
+ /**
1796
+ * These steps are evaluated in order until a destination is found.
1797
+ */
1798
+ export interface AgentTransitionStepV3_55_0 {
1799
+ destination: string;
1800
+ suspend?: boolean;
1801
+ condition?: string;
1802
+ limit?: number;
1803
+ }
1804
+ /**
1805
+ * States that are traversed during the execution of an agent.
1806
+ */
1807
+ export interface AgentStatesV3_55_0 {
1808
+ [k: string]: AgentStateV3_55_0;
1809
+ }
1810
+ /**
1811
+ * One step of an agent's execution.
1812
+ *
1813
+ * This interface was referenced by `AgentStatesV3_55_0`'s JSON-Schema definition
1814
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
1815
+ */
1816
+ export interface AgentStateV3_55_0 {
1817
+ name: string;
1818
+ variables?: VariablesV3_55_0;
1819
+ execution: AgentExecutionV3_55_0;
1820
+ sessionMemory?: AgentStateSessionMemoryV3_55_0;
1821
+ transition?: AgentTransitionStepV3_55_0[];
1822
+ }
1823
+ export interface AgentVariableV3_55_0 {
1824
+ name: string;
1825
+ /**
1826
+ * These are evaluated in order until a value is found.
1827
+ */
1828
+ steps: AgentVariableStepV3_55_0[];
1829
+ }
1830
+ export interface AgentVariableStepV3_55_0 {
1831
+ condition?: string;
1832
+ expression: string;
1833
+ }
1834
+ export interface AgentExecutionGraphQLV3_55_0 {
1835
+ type: 'graphql';
1836
+ query: string;
1837
+ path?: string;
1838
+ }
1839
+ export interface AgentExecutionGenerateV3_55_0 {
1840
+ type: 'generate';
1841
+ service: string;
1842
+ model: string;
1843
+ systemPrompt?: string;
1844
+ input: AgentAIStateInputV3_55_0;
1845
+ outputShape?: string;
1846
+ tools?: AgentToolConfigV3_55_0[];
1847
+ options?: AgentGenerateOptionsV3_55_0;
1848
+ }
1849
+ export interface AgentAIStateInputArgumentV3_55_0 {
1850
+ type: 'arg';
1851
+ }
1852
+ export interface AgentAIStateInputTemplateV3_55_0 {
1853
+ type: 'template';
1854
+ inputTemplate: string;
1855
+ }
1856
+ export interface AgentToolConfigV3_55_0 {
1857
+ ref: string;
1858
+ description?: string;
1859
+ args?: AgentToolConfigArgV3_55_0[];
1860
+ selectionSet?: string;
1861
+ }
1862
+ export interface AgentControlledV3_55_0 {
1863
+ type: 'agent';
1864
+ argName: ToolArgumentNameV3_55_0;
1865
+ }
1866
+ export interface VariableValueV3_55_0 {
1867
+ type: 'variable';
1868
+ argName: ToolArgumentNameV3_55_01;
1869
+ variableName: StateVariableNameV3_55_0;
1870
+ }
1871
+ export interface AgentGenerateOptionsV3_55_0 {
1872
+ history?: HistoryV3_55_01;
1873
+ maxTokens?: MaximumTokensV3_55_01;
1874
+ temperature?: TemperatureV3_55_01;
1875
+ topP?: TopPV3_55_01;
1876
+ topK?: TopKV3_55_01;
1877
+ presencePenalty?: PresencePenaltySettingV3_55_01;
1878
+ frequencyPenalty?: FrequencyPenaltySettingV3_55_01;
1879
+ stopSequences?: StopSequencesV3_55_01;
1880
+ seed?: SeedV3_55_01;
1881
+ /**
1882
+ * Maximum number of retries. Set to 0 to disable retries. Defaults to 2
1883
+ */
1884
+ maxRetries?: number;
1885
+ /**
1886
+ * The tool choice strategy. Default: 'auto'
1887
+ */
1888
+ toolChoice?: (('auto' | 'none' | 'required') | string) & string;
1889
+ maxToolRoundtrips?: MaxToolRoundtripsV3_55_0;
1890
+ structuredOutputs?: StructuredOutputsV3_55_0;
1891
+ enableOpenAIFormat?: EnableOpenAISchemaFormatV3_55_0;
1892
+ removePropertyKeyPatterns?: RemovePropertyKeyPatternsV3_55_0;
1893
+ stripMarkdown?: StripMarkdownV3_55_0;
1894
+ }
1895
+ export interface AgentExecutionChatV3_55_0 {
1896
+ type: 'chat';
1897
+ service: string;
1898
+ model: string;
1899
+ systemPrompt?: string;
1900
+ input: AgentAIStateInputV3_55_0;
1901
+ artifact?: string;
1902
+ tools?: AgentToolConfigV3_55_0[];
1903
+ history?: AgentChatHistoryConfigV3_55_0;
1904
+ options?: AgentGenerateOptionsV3_55_0;
1905
+ }
1906
+ export interface AgentChatHistoryRetainV3_55_0 {
1907
+ type: 'retain';
1908
+ }
1909
+ export interface AgentChatHistorySummarizeV3_55_0 {
1910
+ type: 'summarize';
1911
+ toolCalls: 'retain' | 'clear';
1912
+ }
1913
+ export interface AgentChatHistoryClearV3_55_0 {
1914
+ type: 'clear';
1915
+ }
1916
+ export interface AgentStateSessionMemoryLocationContentV3_55_0 {
1917
+ type: 'content';
1918
+ memoryPath?: string;
1919
+ path?: string;
1920
+ }
1921
+ export interface AgentStateSessionMemoryLocationArtifactV3_55_0 {
1922
+ type: 'artifactValue';
1923
+ memoryPath?: string;
1924
+ artifactPath?: string;
1925
+ }
1926
+ export interface AgentStateSessionMemoryLocationStaticValueV3_55_0 {
1927
+ type: 'staticValue';
1928
+ memoryPath?: string;
1929
+ value?: string;
1930
+ }
1931
+ export interface AgentGuardV3_55_0 {
1932
+ guardId: GuardIDV3_55_0;
1933
+ }
1934
+ export interface GuardMapV3_55_0 {
1935
+ [k: string]: GuardJSONV3_55_0;
1936
+ }
1937
+ /**
1938
+ * A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.
1939
+ *
1940
+ * This interface was referenced by `GuardMapV3_55_0`'s JSON-Schema definition
1941
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
1942
+ */
1943
+ export interface GuardJSONV3_55_0 {
1944
+ name: NameV3_55_0;
1945
+ description?: DescriptionV3_55_0;
1946
+ guardrailIdentifier?: GuardrailIdentifierV3_55_0;
1947
+ guardrailVersion?: GuardrailVersionV3_55_0;
1948
+ blockedInputMessaging?: BlockedInputMessagingV3_55_0;
1949
+ blockedOutputsMessaging?: BlockedOutputsMessagingV3_55_0;
1950
+ topicPolicyConfig?: TopicPolicyV3_55_0;
1951
+ contentPolicyConfig?: ContentPolicyV3_55_0;
1952
+ wordPolicyConfig?: WordPolicyV3_55_0;
1953
+ sensitiveInformationPolicyConfig?: SensitiveInformationPolicyV3_55_0;
1954
+ contextualGroundingPolicyConfig?: ContextualGroundingPolicyV3_55_0;
1955
+ }
1956
+ /**
1957
+ * Topics to identify and block.
1958
+ */
1959
+ export interface TopicPolicyV3_55_0 {
1960
+ topicsConfig: TopicV3_55_0;
1961
+ }
1962
+ /**
1963
+ * Types of content to filter and strength configuration.
1964
+ */
1965
+ export interface ContentPolicyV3_55_0 {
1966
+ filtersConfig: FilterV3_55_0;
1967
+ }
1968
+ /**
1969
+ * Specific words to identify and block.
1970
+ */
1971
+ export interface WordPolicyV3_55_0 {
1972
+ wordsConfig?: WordListV3_55_0;
1973
+ managedWordListsConfig?: ManagedWordListV3_55_0;
1974
+ }
1975
+ /**
1976
+ * Filter out and block or obscure sensitive information. Matching text will be handled per the policy.
1977
+ */
1978
+ export interface SensitiveInformationPolicyV3_55_0 {
1979
+ piiEntitiesConfig?: PIIEntityV3_55_0;
1980
+ regexesConfig?: RegularExpressionV3_55_0;
1981
+ }
1982
+ /**
1983
+ * Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.
1984
+ */
1985
+ export interface ContextualGroundingPolicyV3_55_0 {
1986
+ filtersConfig: FilterV3_55_01;
1987
+ }
1988
+ export interface ToolMapV3_55_0 {
1989
+ [k: string]: ToolJSONV3_55_0;
1990
+ }
1991
+ /**
1992
+ * This interface was referenced by `ToolMapV3_55_0`'s JSON-Schema definition
1993
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
1994
+ */
1995
+ export interface ToolJSONV3_55_0 {
1996
+ ref: string;
1997
+ description?: string;
1998
+ args?: ToolArgV3_55_0[];
1999
+ selectionSet?: string;
2000
+ }
2001
+ /**
2002
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2003
+ * via the `definition` "formMap".
2004
+ */
2005
+ export interface FormMapV3_55_0 {
2006
+ [k: string]: FormsConfigV3_55_0;
2007
+ }
2008
+ /**
2009
+ * This interface was referenced by `FormMapV3_55_0`'s JSON-Schema definition
2010
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
2011
+ *
2012
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2013
+ * via the `definition` "formsConfig".
2014
+ */
2015
+ export interface FormsConfigV3_55_0 {
2016
+ default: FormConfigV3_55_0;
2017
+ [k: string]: FormConfigV3_55_0;
2018
+ }
2019
+ /**
2020
+ * This interface was referenced by `FormsConfigV3_55_0`'s JSON-Schema definition
2021
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
2022
+ *
2023
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2024
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
2025
+ *
2026
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2027
+ * via the `definition` "formConfig".
2028
+ */
2029
+ export interface FormConfigV3_55_0 {
2030
+ [k: string]: any;
2031
+ }
2032
+ /**
2033
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2034
+ * via the `definition` "workflowMap".
2035
+ */
2036
+ export interface WorkflowMapV3_55_0 {
2037
+ [k: string]: WorkflowV3_55_0;
2038
+ }
2039
+ /**
2040
+ * This interface was referenced by `WorkflowMapV3_55_0`'s JSON-Schema definition
2041
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
2042
+ *
2043
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2044
+ * via the `definition` "workflow".
2045
+ */
2046
+ export interface WorkflowV3_55_0 {
2047
+ /**
2048
+ * machine-readable id
2049
+ */
2050
+ name: string;
2051
+ title: WorkflowNameV3_55_0;
2052
+ steps: StepsV3_55_0;
2053
+ [k: string]: any;
2054
+ }
2055
+ /**
2056
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2057
+ * via the `definition` "workflowStep".
2058
+ */
2059
+ export interface WorkflowStepV3_55_0 {
2060
+ name: NameV3_55_01;
2061
+ title: TitleV3_55_0;
2062
+ description?: DescriptionV3_55_01;
2063
+ color: ColorV3_55_0;
2064
+ live: LiveV3_55_0;
2065
+ key: KeyV3_55_0;
2066
+ }
2067
+ /**
2068
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2069
+ * via the `definition` "storedServiceMap".
2070
+ */
2071
+ export interface ServiceMapJSONV3_55_0 {
2072
+ [k: string]: ServiceConfigJSONV3_55_0;
2073
+ }
2074
+ /**
2075
+ * This interface was referenced by `ServiceMapJSONV3_55_0`'s JSON-Schema definition
2076
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
2077
+ *
2078
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2079
+ * via the `definition` "storedServiceConfig".
2080
+ */
2081
+ export interface ServiceConfigJSONV3_55_0 {
2082
+ /**
2083
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
2084
+ */
2085
+ id: string;
2086
+ /**
2087
+ * Human-readable name for this service.
2088
+ */
2089
+ title: string;
2090
+ /**
2091
+ * The service provider id.
2092
+ */
2093
+ provider: string;
2094
+ /**
2095
+ * A namespace to use for the imported types tied to this service.
2096
+ */
2097
+ namespace?: string;
2098
+ serviceType: ServiceTypeV3_55_0;
2099
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
2100
+ authentication?: string;
2101
+ healthCheck?: ServiceHealthCheckV3_55_0;
2102
+ webhookId?: string;
2103
+ /**
2104
+ * Configuration options passed to and handled by the provider.
2105
+ */
2106
+ options?: {
2107
+ [k: string]: any;
2108
+ };
2109
+ }
2110
+ /**
2111
+ * Configuration for ping health checks.
2112
+ *
2113
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2114
+ * via the `definition` "serviceHealthCheck".
2115
+ */
2116
+ export interface ServiceHealthCheckV3_55_0 {
2117
+ checkName: CheckNameV3_55_0;
2118
+ endpoint?: EndpointV3_55_0;
2119
+ requestMethod?: RequestMethodV3_55_0;
2120
+ requestHeaders?: RequestHeadersV3_55_0;
2121
+ requestSearchParams?: RequestSearchParamsV3_55_0;
2122
+ requestBody?: RequestBodyV3_55_0;
2123
+ requestBodyFormat?: RequestBodyFormatV3_55_0;
2124
+ requestTimeout?: RequestTimeoutV3_55_0;
2125
+ healthyResponseStatusCode?: HealthyResponseStatusCodeV3_55_0;
2126
+ triggers?: ServiceHealthCheckTriggerV3_55_0[];
2127
+ }
2128
+ /**
2129
+ * Any custom headers to set with the health check request.
2130
+ */
2131
+ export interface RequestHeadersV3_55_0 {
2132
+ [k: string]: any;
2133
+ }
2134
+ /**
2135
+ * Any custom search params to set with the health check request.
2136
+ */
2137
+ export interface RequestSearchParamsV3_55_0 {
2138
+ [k: string]: any;
2139
+ }
2140
+ /**
2141
+ * All possible options for the more specific ParameterSerializeStyleOptions types.
2142
+ *
2143
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2144
+ * via the `definition` "parameterSerializeStyleOptions".
2145
+ */
2146
+ export interface ParameterSerializeStyleOptionsV3_55_0 {
2147
+ style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
2148
+ explode?: boolean;
2149
+ allowEmptyValue?: boolean;
2150
+ /**
2151
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
2152
+ */
2153
+ allowReserved?: boolean;
2154
+ skipEncoding?: boolean;
2155
+ }
2156
+ /**
2157
+ * All possible options for the more specific ParameterSerializeConfig types.
2158
+ *
2159
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2160
+ * via the `definition` "parameterSerializeConfig".
2161
+ */
2162
+ export interface ParameterSerializeConfigV3_55_0 {
2163
+ content?: ParameterSerializeContentOptionsV3_55_0;
2164
+ defaults?: ParameterSerializeOptionsV3_55_0;
2165
+ paths?: {
2166
+ [k: string]: ParameterSerializeOptionsV3_55_0;
2167
+ };
2168
+ }
2169
+ /**
2170
+ * All possible options for the more specific ParameterConfig types.
2171
+ *
2172
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2173
+ * via the `definition` "parameterConfig".
2174
+ */
2175
+ export interface ParameterConfigV3_55_0 {
2176
+ ops: ParameterOpListV3_55_0;
2177
+ serialize?: ParameterSerializeConfigV3_55_0;
2178
+ }
2179
+ /**
2180
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2181
+ * via the `definition` "aiParseFileResolverOptions".
2182
+ */
2183
+ export interface AIParseFileResolverOptionsV3_55_0 {
2184
+ [k: string]: any;
2185
+ }
2186
+ /**
2187
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2188
+ * via the `definition` "listQueryLoaderConfig".
2189
+ */
2190
+ export interface ListQueryLoaderConfigV3_55_0 {
2191
+ query: string;
2192
+ args?: {
2193
+ [k: string]: any;
2194
+ };
2195
+ pagination?: PaginationConfigV3_55_0;
2196
+ }
2197
+ /**
2198
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2199
+ * via the `definition` "formScalarConfig".
2200
+ */
2201
+ export interface FormScalarConfigV3_55_0 {
2202
+ widget: string;
2203
+ }
2204
+ /**
2205
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2206
+ * via the `definition` "formObjectConfig".
2207
+ */
2208
+ export interface FormObjectConfigV3_55_0 {
2209
+ widget?: string;
2210
+ order?: string[];
2211
+ properties?: {
2212
+ [k: string]: FormConfigV3_55_0;
2213
+ };
2214
+ }
2215
+ /**
2216
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2217
+ * via the `definition` "formArrayConfig".
2218
+ */
2219
+ export interface FormArrayConfigV3_55_0 {
2220
+ widget: string;
2221
+ items: FormConfigV3_55_0;
2222
+ }
2223
+ /**
2224
+ * For use with a custom auth handler on a service provider.
2225
+ *
2226
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2227
+ * via the `definition` "customAuthentication".
2228
+ */
2229
+ export interface CustomAuthenticationV3_55_0 {
2230
+ type: 'custom';
2231
+ [k: string]: any;
2232
+ }
2233
+ /**
2234
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2235
+ * via the `definition` "searchParamsAuthentication".
2236
+ */
2237
+ export interface SearchParamsAuthenticationV3_55_0 {
2238
+ type: 'searchParams';
2239
+ params: {
2240
+ name: string;
2241
+ value: string;
2242
+ }[];
2243
+ }
2244
+ /**
2245
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2246
+ * via the `definition` "bearerAuthentication".
2247
+ */
2248
+ export interface BearerAuthenticationV3_55_0 {
2249
+ type: 'bearer';
2250
+ token: string;
2251
+ prefix?: string;
2252
+ header?: string;
2253
+ }
2254
+ /**
2255
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2256
+ * via the `definition` "oauth2BearerAuthentication".
2257
+ */
2258
+ export interface OAuth2BearerAuthenticationV3_55_0 {
2259
+ type: 'oauth2Bearer';
2260
+ token: string;
2261
+ prefix?: string;
2262
+ header?: string;
2263
+ scope?: string;
2264
+ expiresAt?: string;
2265
+ }
2266
+ /**
2267
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2268
+ * via the `definition` "basicAuthentication".
2269
+ */
2270
+ export interface BasicAuthenticationV3_55_0 {
2271
+ type: 'basic';
2272
+ username: string;
2273
+ password: string;
2274
+ useIso8859?: boolean;
2275
+ }
2276
+ /**
2277
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2278
+ * via the `definition` "oauth2Authentication".
2279
+ */
2280
+ export interface OAuth2AuthenticationV3_55_0 {
2281
+ type: 'oauth2';
2282
+ grantType: 'authorizationCode' | 'clientCredentials';
2283
+ authorizationUrl?: string;
2284
+ accessTokenUrl?: string;
2285
+ clientId: string;
2286
+ clientSecret?: string;
2287
+ scope?: string;
2288
+ usePkce?: boolean;
2289
+ redirectUrl?: string;
2290
+ headerPrefix?: string;
2291
+ audience?: string;
2292
+ resource?: string;
2293
+ }
2294
+ /**
2295
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2296
+ * via the `definition` "awsAuthentication".
2297
+ */
2298
+ export interface AWSAuthenticationV3_55_0 {
2299
+ type: 'aws';
2300
+ awsAccessKeyId: string;
2301
+ awsSecretAccessKey: string;
2302
+ }
2303
+ /**
2304
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2305
+ * via the `definition` "googleAuthentication".
2306
+ */
2307
+ export interface GoogleAuthenticationV3_55_0 {
2308
+ type: 'google';
2309
+ clientEmail: string;
2310
+ privateKey: string;
2311
+ }
2312
+ /**
2313
+ * This interface was referenced by `ProjectSchemaJSONV3_55_0`'s JSON-Schema
2314
+ * via the `definition` "serviceConfig".
2315
+ */
2316
+ export interface ServiceConfigV3_55_0 {
2317
+ /**
2318
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
2319
+ */
2320
+ id: string;
2321
+ /**
2322
+ * Human-readable name for this service.
2323
+ */
2324
+ title: string;
2325
+ /**
2326
+ * The service provider id.
2327
+ */
2328
+ provider: string;
2329
+ /**
2330
+ * A namespace to use for the imported types tied to this service.
2331
+ */
2332
+ namespace?: string;
2333
+ serviceType: ServiceTypeV3_55_0;
2334
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
2335
+ authentication?: ServiceAuthenticationV3_55_0;
2336
+ healthCheck?: ServiceHealthCheckV3_55_0;
2337
+ webhookId?: string;
2338
+ /**
2339
+ * Configuration options passed to and handled by the provider.
2340
+ */
2341
+ options?: {
2342
+ [k: string]: any;
2343
+ };
2344
+ }