@takeshape/schema 11.61.0 → 11.63.7

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