@takeshape/schema 12.14.2 → 12.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/builtin-schema.js +7 -0
- package/dist/migration/index.d.ts +2 -1
- package/dist/migration/index.js +2 -1
- package/dist/project-schema/index.d.ts +4 -1
- package/dist/project-schema/index.js +2 -1
- package/dist/project-schema/latest.d.ts +33 -2
- package/dist/project-schema/migrate.js +4 -1
- package/dist/project-schema/v3.66.0.d.ts +2797 -0
- package/dist/project-schema/v3.66.0.js +7 -0
- package/dist/resolvers/ai/hybrid-search.d.ts +77 -0
- package/dist/resolvers/ai/hybrid-search.js +64 -0
- package/dist/schemas/index.d.ts +2 -2
- package/dist/schemas/index.js +4 -2
- package/dist/schemas/project-schema/latest.json +51 -2
- package/dist/schemas/project-schema/v3.66.0.json +5161 -0
- package/dist/schemas/project-schema.json +3 -0
- package/examples/latest/all-fields-shapes-inline.json +1 -1
- package/examples/latest/all-fields-shapes.json +1 -1
- package/examples/latest/betzino.json +1 -1
- package/examples/latest/blog-schema.json +1 -1
- package/examples/latest/brewery-schema.json +1 -1
- package/examples/latest/chat-agent-schema.json +1 -1
- package/examples/latest/clear-cache-schema.json +1 -1
- package/examples/latest/complex-project-schema.json +1 -1
- package/examples/latest/complex-schema.json +1 -1
- package/examples/latest/edit-schema.json +1 -1
- package/examples/latest/frank-and-fred-schema.json +1 -1
- package/examples/latest/generate-agent-schema.json +1 -1
- package/examples/latest/klirr-schema.json +1 -1
- package/examples/latest/layers/rick-and-morty-layer.json +1 -1
- package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
- package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
- package/examples/latest/layers/wordpress-2024-01.json +1 -1
- package/examples/latest/massive-schema.json +1 -1
- package/examples/latest/mill-components-schema.json +1 -1
- package/examples/latest/nested-shape-arrays.json +1 -1
- package/examples/latest/one-earth.json +1 -1
- package/examples/latest/pet-oneof-array.json +1 -1
- package/examples/latest/post-schema.json +1 -1
- package/examples/latest/pruned-shopify-product-schema.json +1 -1
- package/examples/latest/rag-example.json +1 -1
- package/examples/latest/real-world-schema.json +1 -1
- package/examples/latest/recursive-repeater-schema.json +1 -1
- package/examples/latest/recursive-schema.json +1 -1
- package/examples/latest/rick-and-morty-ast.json +1 -1
- package/examples/latest/rick-and-morty-graphql.json +1 -1
- package/examples/latest/rick-and-morty-rest.json +1 -1
- package/examples/latest/rick-and-morty-user-schema.json +1 -1
- package/examples/latest/rick-and-morty-with-indexing.json +1 -1
- package/examples/latest/schema-where-filter.json +1 -1
- package/examples/latest/schema-with-repeater-draftjs.json +1 -1
- package/examples/latest/schema-with-rick-and-morty.json +1 -1
- package/examples/latest/shape-books-v3_2_0.json +1 -1
- package/examples/latest/shape-books.json +1 -1
- package/examples/latest/shape-editor-schema-edited.json +1 -1
- package/examples/latest/shape-editor-schema-initial.json +1 -1
- package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
- package/examples/latest/shopify-lookbook.json +1 -1
- package/examples/latest/shopify-product-2022-07.json +1 -1
- package/examples/latest/shopify-product-2023-04.json +1 -1
- package/examples/latest/shopify-store-with-widget.json +1 -1
- package/examples/latest/stripe-product-runtime-schema.json +1 -1
- package/examples/latest/stripe-starter-resolved.json +1 -1
- package/examples/latest/user-schema-no-required.json +1 -1
- package/examples/latest/user-schema-with-defaults.json +1 -1
- package/examples/latest/valvoline-ai-demo.json +1 -1
- package/examples/latest/vector-search-schema.json +1 -1
- package/package.json +6 -6
|
@@ -0,0 +1,2797 @@
|
|
|
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_66_0`'s JSON-Schema
|
|
8
|
+
* via the `definition` "args".
|
|
9
|
+
*/
|
|
10
|
+
export type ArgsV3_66_0 = string | ObjectSchemaV3_66_0 | ExtendsSchemaV3_66_0;
|
|
11
|
+
/**
|
|
12
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
13
|
+
* via the `definition` "objectSchema".
|
|
14
|
+
*/
|
|
15
|
+
export type ObjectSchemaV3_66_0 = PropertySchemaV3_66_0 & {
|
|
16
|
+
type: 'object';
|
|
17
|
+
properties: {
|
|
18
|
+
[k: string]: PropertySchemaV3_66_0;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
23
|
+
* via the `definition` "nonNegativeInteger".
|
|
24
|
+
*/
|
|
25
|
+
export type NonNegativeIntegerV3_66_0 = number;
|
|
26
|
+
/**
|
|
27
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
28
|
+
* via the `definition` "nonNegativeIntegerDefault0".
|
|
29
|
+
*/
|
|
30
|
+
export type NonNegativeIntegerDefault0V3_66_0 = NonNegativeIntegerV3_66_0;
|
|
31
|
+
/**
|
|
32
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
33
|
+
* via the `definition` "stringArray".
|
|
34
|
+
*/
|
|
35
|
+
export type StringArrayV3_66_0 = string[];
|
|
36
|
+
/**
|
|
37
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
38
|
+
* via the `definition` "simpleTypes".
|
|
39
|
+
*/
|
|
40
|
+
export type SimpleTypesV3_66_0 = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
|
|
41
|
+
/**
|
|
42
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
43
|
+
* via the `definition` "schemaArray".
|
|
44
|
+
*/
|
|
45
|
+
export type SchemaArrayV3_66_0 = PropertySchemaV3_66_0[];
|
|
46
|
+
/**
|
|
47
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
48
|
+
* via the `definition` "ref".
|
|
49
|
+
*/
|
|
50
|
+
export type RefV3_66_0 = string;
|
|
51
|
+
/**
|
|
52
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
53
|
+
* via the `definition` "objectOrRefArray".
|
|
54
|
+
*/
|
|
55
|
+
export type ObjectOrRefArrayV3_66_0 = (RefSchemaV3_66_0 | RefSchemaLegacyV3_66_0 | ObjectSchemaV3_66_0)[];
|
|
56
|
+
/**
|
|
57
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
58
|
+
* via the `definition` "fieldMapping".
|
|
59
|
+
*/
|
|
60
|
+
export type FieldMappingV3_66_0 = MappingStringV3_66_0 | MappingStringV3_66_0[];
|
|
61
|
+
/**
|
|
62
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
63
|
+
* via the `definition` "mappingString".
|
|
64
|
+
*/
|
|
65
|
+
export type MappingStringV3_66_0 = string;
|
|
66
|
+
/**
|
|
67
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
68
|
+
* via the `definition` "resolver".
|
|
69
|
+
*/
|
|
70
|
+
export type ResolverV3_66_0 = BasicResolverV3_66_0 | ComposeResolverV3_66_0;
|
|
71
|
+
/**
|
|
72
|
+
* A single resolver, can be composed with the ComposeResolver.
|
|
73
|
+
*
|
|
74
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
75
|
+
* via the `definition` "basicResolver".
|
|
76
|
+
*/
|
|
77
|
+
export type BasicResolverV3_66_0 = UtilResolverV3_66_0 | DelegateResolverV3_66_0 | FetchAllResolverV3_66_0 | TakeshapeResolverV3_66_0 | AIHybridSearchResolverV3_66_0 | ShapedbResolverV3_66_0 | ShapedbResolverShapeNameNotRequiredV3_66_0 | GraphqlResolverV3_66_0 | RestResolverV3_66_0 | AwsLambdaResolverV3_66_0 | SalsifyResolverV3_66_0 | SyndigoResolverV3_66_0 | FunctionResolverV3_66_0 | AIGenerateTextResolverV3_66_0 | AIGeneratePropertyResolverV3_66_0 | AIEmbeddingResolverV3_66_0 | AIEmbeddingSearchResolverV3_66_0 | AIParseFileResolverV3_66_0 | ChunkResolverV3_66_0 | AISendAgentMessageResolverV3_66_0 | AIInspectAgentResolverV3_66_0 | AICreateAgentSessionResolverV3_66_0 | AIGetAgentMessageResolverV3_66_0 | AIAbortAgentMessageResolverV3_66_0 | AISendAgentFeedbackResolverV3_66_0;
|
|
78
|
+
/**
|
|
79
|
+
* Name of the resolver function.
|
|
80
|
+
*/
|
|
81
|
+
export type UtilResolverNameV3_66_0 = 'util:noop' | 'util:wrap';
|
|
82
|
+
/**
|
|
83
|
+
* An object describing an operation to generate a parameter.
|
|
84
|
+
*
|
|
85
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
86
|
+
* via the `definition` "parameterOp".
|
|
87
|
+
*/
|
|
88
|
+
export type ParameterOpV3_66_0 = ParameterOpNestedV3_66_0 | ParameterOpValueV3_66_0 | ParameterOpMappingV3_66_0 | ParameterOpOpV3_66_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_66_0`'s JSON-Schema
|
|
93
|
+
* via the `definition` "directiveConfigItem".
|
|
94
|
+
*/
|
|
95
|
+
export type DirectiveConfigItemV3_66_0 = [DirectiveNameV3_66_0, DirectiveOptionsV3_66_0];
|
|
96
|
+
export type DirectiveNameV3_66_0 = string;
|
|
97
|
+
/**
|
|
98
|
+
* An array of individual directive config items to process in order
|
|
99
|
+
*
|
|
100
|
+
* This interface was referenced by `DirectiveMappingMapV3_66_0`'s JSON-Schema definition
|
|
101
|
+
* via the `patternProperty` "[0-9A-Za-z_-]+".
|
|
102
|
+
*
|
|
103
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
104
|
+
* via the `definition` "directiveConfig".
|
|
105
|
+
*/
|
|
106
|
+
export type DirectiveConfigV3_66_0 = DirectiveConfigItemV3_66_0[];
|
|
107
|
+
/**
|
|
108
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
109
|
+
* via the `definition` "parameterOpList".
|
|
110
|
+
*/
|
|
111
|
+
export type ParameterOpListV3_66_0 = ParameterOpV3_66_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_66_0`'s JSON-Schema
|
|
116
|
+
* via the `definition` "argsMapping".
|
|
117
|
+
*/
|
|
118
|
+
export type ArgsMappingV3_66_0 = DirectiveMappingMapV3_66_0 | DirectiveConfigV3_66_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_66_0`'s JSON-Schema
|
|
123
|
+
* via the `definition` "resultsMapping".
|
|
124
|
+
*/
|
|
125
|
+
export type ResultsMappingV3_66_0 = DirectiveMappingMapV3_66_0 | DirectiveConfigV3_66_0;
|
|
126
|
+
/**
|
|
127
|
+
* Name of the resolver function.
|
|
128
|
+
*/
|
|
129
|
+
export type DelegateResolverNameV3_66_0 = 'delegate';
|
|
130
|
+
/**
|
|
131
|
+
* Name of the resolver function.
|
|
132
|
+
*/
|
|
133
|
+
export type FetchAllResolverNameV3_66_0 = 'fetchAll';
|
|
134
|
+
/**
|
|
135
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
136
|
+
* via the `definition` "paginationConfig".
|
|
137
|
+
*/
|
|
138
|
+
export type PaginationConfigV3_66_0 = PaginationCursorConfigV3_66_0 | PaginationPageConfigV3_66_0 | PaginationOffsetConfigV3_66_0;
|
|
139
|
+
/**
|
|
140
|
+
* Name of the resolver function.
|
|
141
|
+
*/
|
|
142
|
+
export type TakeshapeResolverNameV3_66_0 = 'takeshape:get' | 'takeshape:getUser' | 'takeshape:search' | 'takeshape:vectorSearch' | 'takeshape:queryApiIndex' | 'takeshape:assetUrl' | 'takeshape:assetImage' | 'takeshape:assetImageMeta';
|
|
143
|
+
/**
|
|
144
|
+
* Name of the resolver function.
|
|
145
|
+
*/
|
|
146
|
+
export type AIHybridSearchResolverNameV3_66_0 = 'ai:hybridSearch';
|
|
147
|
+
/**
|
|
148
|
+
* Name of the resolver function.
|
|
149
|
+
*/
|
|
150
|
+
export type ShapedbResolverNameV3_66_0 = 'shapedb:get' | 'shapedb:create' | 'shapedb:update' | 'shapedb:delete' | 'shapedb:duplicate' | 'shapedb:find';
|
|
151
|
+
/**
|
|
152
|
+
* Name of the resolver function.
|
|
153
|
+
*/
|
|
154
|
+
export type ShapedbResolverShapeNameNotRequiredNameV3_66_0 = 'shapedb:list' | 'shapedb:taxonomySuggest' | 'shapedb:getRelated';
|
|
155
|
+
/**
|
|
156
|
+
* Name of the resolver function.
|
|
157
|
+
*/
|
|
158
|
+
export type GraphqlResolverNameV3_66_0 = 'graphql:query' | 'graphql:mutation' | 'shopify:bulkQuery';
|
|
159
|
+
/**
|
|
160
|
+
* Name of the resolver function.
|
|
161
|
+
*/
|
|
162
|
+
export type RestResolverNameV3_66_0 = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
|
|
163
|
+
/**
|
|
164
|
+
* A tuple with a string key and a directive config to evaluate
|
|
165
|
+
*
|
|
166
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
167
|
+
* via the `definition` "directiveMappingArrayItem".
|
|
168
|
+
*/
|
|
169
|
+
export type DirectiveMappingArrayItemV3_66_0 = [string, DirectiveConfigV3_66_0];
|
|
170
|
+
/**
|
|
171
|
+
* An array of key / value or directive config tuples
|
|
172
|
+
*/
|
|
173
|
+
export type SearchParamsMappingV3_66_0 = DirectiveMappingArrayItemV3_66_0[];
|
|
174
|
+
/**
|
|
175
|
+
* Name of the resolver function.
|
|
176
|
+
*/
|
|
177
|
+
export type AwsLambdaResolverNameV3_66_0 = 'awsLambda:invoke';
|
|
178
|
+
/**
|
|
179
|
+
* Name of the resolver function.
|
|
180
|
+
*/
|
|
181
|
+
export type SalsifyResolverNameV3_66_0 = 'salsify:listChannelProducts';
|
|
182
|
+
/**
|
|
183
|
+
* Name of the resolver function.
|
|
184
|
+
*/
|
|
185
|
+
export type SyndigoResolverNameV3_66_0 = 'syndigo:searchProducts';
|
|
186
|
+
/**
|
|
187
|
+
* Name of the resolver function.
|
|
188
|
+
*/
|
|
189
|
+
export type FunctionResolverNameV3_66_0 = 'function:run';
|
|
190
|
+
export type FunctionResolverJavascriptV3_66_0 = string;
|
|
191
|
+
/**
|
|
192
|
+
* Name of the resolver function.
|
|
193
|
+
*/
|
|
194
|
+
export type AIResolverNameV3_66_0 = 'ai:generateText' | 'ai:chat';
|
|
195
|
+
export type HistoryV3_66_0 = boolean;
|
|
196
|
+
/**
|
|
197
|
+
* Maximum number of tokens to generate.
|
|
198
|
+
*/
|
|
199
|
+
export type MaximumTokensV3_66_0 = number;
|
|
200
|
+
/**
|
|
201
|
+
* 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
|
|
202
|
+
*/
|
|
203
|
+
export type TemperatureV3_66_0 = number;
|
|
204
|
+
/**
|
|
205
|
+
* 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.
|
|
206
|
+
*/
|
|
207
|
+
export type TopPV3_66_0 = number;
|
|
208
|
+
/**
|
|
209
|
+
* 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.
|
|
210
|
+
*/
|
|
211
|
+
export type TopKV3_66_0 = number;
|
|
212
|
+
/**
|
|
213
|
+
* 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.
|
|
214
|
+
*/
|
|
215
|
+
export type PresencePenaltySettingV3_66_0 = number;
|
|
216
|
+
/**
|
|
217
|
+
* 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.
|
|
218
|
+
*/
|
|
219
|
+
export type FrequencyPenaltySettingV3_66_0 = number;
|
|
220
|
+
/**
|
|
221
|
+
* If set, the model will stop generating text when one of the stop sequences is generated.
|
|
222
|
+
*/
|
|
223
|
+
export type StopSequencesV3_66_0 = string[];
|
|
224
|
+
/**
|
|
225
|
+
* The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
|
|
226
|
+
*/
|
|
227
|
+
export type SeedV3_66_0 = number;
|
|
228
|
+
/**
|
|
229
|
+
* Enable prompt caching for supported providers (e.g., Anthropic). Reduces token costs by caching system messages, tools, and conversation history.
|
|
230
|
+
*
|
|
231
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
232
|
+
* via the `definition` "promptCaching".
|
|
233
|
+
*/
|
|
234
|
+
export type PromptCachingV3_66_0 = boolean;
|
|
235
|
+
/**
|
|
236
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
237
|
+
* via the `definition` "agentToolConfigArg".
|
|
238
|
+
*/
|
|
239
|
+
export type AgentToolConfigArgV3_66_0 = AgentControlledV3_66_0 | VariableValueV3_66_0;
|
|
240
|
+
/**
|
|
241
|
+
* The argument name that will be exposed by the tool for the LLM to use.
|
|
242
|
+
*/
|
|
243
|
+
export type ToolArgumentNameV3_66_0 = string;
|
|
244
|
+
/**
|
|
245
|
+
* Name of argument to pass value to. This prevents the LLM from setting the argument.
|
|
246
|
+
*/
|
|
247
|
+
export type ToolArgumentNameV3_66_01 = string;
|
|
248
|
+
/**
|
|
249
|
+
* Name of variable to pull value from.
|
|
250
|
+
*/
|
|
251
|
+
export type StateVariableNameV3_66_0 = string;
|
|
252
|
+
/**
|
|
253
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
254
|
+
* via the `definition` "aiGuardrail".
|
|
255
|
+
*/
|
|
256
|
+
export type AIGuardrailV3_66_0 = AISimilarityGuardrailV3_66_0;
|
|
257
|
+
/**
|
|
258
|
+
* Name of the resolver function.
|
|
259
|
+
*/
|
|
260
|
+
export type AIResolverNameV3_66_01 = 'ai:generateProperty';
|
|
261
|
+
/**
|
|
262
|
+
* Name of the resolver function.
|
|
263
|
+
*/
|
|
264
|
+
export type AIResolverNameV3_66_02 = 'ai:createEmbedding';
|
|
265
|
+
/**
|
|
266
|
+
* Name of the resolver function.
|
|
267
|
+
*/
|
|
268
|
+
export type AIResolverNameV3_66_03 = 'ai:embeddingSearch';
|
|
269
|
+
/**
|
|
270
|
+
* Name of the resolver function.
|
|
271
|
+
*/
|
|
272
|
+
export type AIResolverNameV3_66_04 = 'ai:parseFile';
|
|
273
|
+
/**
|
|
274
|
+
* Name of the resolver function.
|
|
275
|
+
*/
|
|
276
|
+
export type UtilResolverNameV3_66_01 = 'util:chunk';
|
|
277
|
+
/**
|
|
278
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
279
|
+
* via the `definition` "utilChunkResolverOptions".
|
|
280
|
+
*/
|
|
281
|
+
export type UtilChunkResolverOptionsV3_66_0 = UtilChunkResolverOptionsCharacterCountV3_66_0 | UtilChunkResolverOptionsSeparatorsV3_66_0 | UtilChunkResolverOptionsMarkdownV3_66_0 | UtilChunkResolverOptionsSemanticV3_66_0;
|
|
282
|
+
/**
|
|
283
|
+
* Name of the resolver function.
|
|
284
|
+
*/
|
|
285
|
+
export type AIResolverNameV3_66_05 = 'ai:sendAgentMessage';
|
|
286
|
+
/**
|
|
287
|
+
* Name of the resolver function.
|
|
288
|
+
*/
|
|
289
|
+
export type AIResolverNameV3_66_06 = 'ai:inspectAgent';
|
|
290
|
+
/**
|
|
291
|
+
* Name of the resolver function.
|
|
292
|
+
*/
|
|
293
|
+
export type AIResolverNameV3_66_07 = 'ai:createAgentSession';
|
|
294
|
+
/**
|
|
295
|
+
* Name of the resolver function.
|
|
296
|
+
*/
|
|
297
|
+
export type AIResolverNameV3_66_08 = 'ai:getAgentMessage';
|
|
298
|
+
/**
|
|
299
|
+
* Name of the resolver function.
|
|
300
|
+
*/
|
|
301
|
+
export type AIResolverNameV3_66_09 = 'ai:abortAgentMessage';
|
|
302
|
+
/**
|
|
303
|
+
* Name of the resolver function.
|
|
304
|
+
*/
|
|
305
|
+
export type AIResolverNameV3_66_010 = 'ai:sendAgentFeedback';
|
|
306
|
+
/**
|
|
307
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
308
|
+
* via the `definition` "dependencies".
|
|
309
|
+
*/
|
|
310
|
+
export type DependenciesV3_66_0 = string;
|
|
311
|
+
/**
|
|
312
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
313
|
+
* via the `definition` "extendsSchema".
|
|
314
|
+
*/
|
|
315
|
+
export type ExtendsSchemaV3_66_0 = PropertySchemaV3_66_0 & {
|
|
316
|
+
extends: ObjectOrRefArrayV3_66_0;
|
|
317
|
+
};
|
|
318
|
+
/**
|
|
319
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
320
|
+
* via the `definition` "returnShape".
|
|
321
|
+
*/
|
|
322
|
+
export type ReturnShapeV3_66_0 = string | ReturnShapeArraySchemaV3_66_0;
|
|
323
|
+
/**
|
|
324
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
325
|
+
* via the `definition` "returnShapeArraySchema".
|
|
326
|
+
*/
|
|
327
|
+
export type ReturnShapeArraySchemaV3_66_0 = PropertySchemaV3_66_0 & {
|
|
328
|
+
type: 'array';
|
|
329
|
+
items: RefSchemaV3_66_0 | {
|
|
330
|
+
type: 'boolean' | 'integer' | 'number' | 'string' | 'object';
|
|
331
|
+
[k: string]: any;
|
|
332
|
+
};
|
|
333
|
+
};
|
|
334
|
+
export type ModelTypeV3_66_0 = 'single' | 'multiple' | 'taxonomy';
|
|
335
|
+
/**
|
|
336
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
337
|
+
* via the `definition` "cacheTriggerConfig".
|
|
338
|
+
*/
|
|
339
|
+
export type CacheTriggerConfigV3_66_0 = CacheScheduleTriggerConfigV3_66_0 | CacheWebhookTriggerConfigV3_66_0;
|
|
340
|
+
/**
|
|
341
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
342
|
+
* via the `definition` "shapeSchema".
|
|
343
|
+
*/
|
|
344
|
+
export type ShapeSchemaV3_66_0 = ShapeSchemaAllOfV3_66_0 | ShapeSchemaExtendsV3_66_0 | ShapeSchemaOneOfV3_66_0 | ShapeSchemaEnumV3_66_0 | ObjectSchemaV3_66_0 | ShapeSchemaAnyV3_66_0;
|
|
345
|
+
/**
|
|
346
|
+
* Human-readable id for use in the UI
|
|
347
|
+
*/
|
|
348
|
+
export type WorkflowNameV3_66_0 = string;
|
|
349
|
+
/**
|
|
350
|
+
* machine-readable slug
|
|
351
|
+
*/
|
|
352
|
+
export type NameV3_66_0 = string;
|
|
353
|
+
/**
|
|
354
|
+
* Human-readable id for use in the UI
|
|
355
|
+
*/
|
|
356
|
+
export type TitleV3_66_0 = string;
|
|
357
|
+
export type DescriptionV3_66_0 = string;
|
|
358
|
+
/**
|
|
359
|
+
* Hex color code
|
|
360
|
+
*/
|
|
361
|
+
export type ColorV3_66_0 = string;
|
|
362
|
+
/**
|
|
363
|
+
* Value to indicate whether items in the state should be returned in list queries
|
|
364
|
+
*/
|
|
365
|
+
export type LiveV3_66_0 = boolean;
|
|
366
|
+
/**
|
|
367
|
+
* machine-readable id
|
|
368
|
+
*/
|
|
369
|
+
export type KeyV3_66_0 = string;
|
|
370
|
+
export type StepsV3_66_0 = WorkflowStepV3_66_0[];
|
|
371
|
+
/**
|
|
372
|
+
* The general type of this service, specifying how and where it will be utilized.
|
|
373
|
+
*
|
|
374
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
375
|
+
* via the `definition` "serviceType".
|
|
376
|
+
*/
|
|
377
|
+
export type ServiceTypeV3_66_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
|
|
378
|
+
/**
|
|
379
|
+
* The name of a health check to run
|
|
380
|
+
*/
|
|
381
|
+
export type CheckNameV3_66_0 = 'graphqlIntrospection' | 'ping' | 'none';
|
|
382
|
+
/**
|
|
383
|
+
* The endpoint to use when checking the service health.
|
|
384
|
+
*/
|
|
385
|
+
export type EndpointV3_66_0 = string;
|
|
386
|
+
/**
|
|
387
|
+
* A custom method to use for the health check request.
|
|
388
|
+
*/
|
|
389
|
+
export type RequestMethodV3_66_0 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
390
|
+
/**
|
|
391
|
+
* A custom body to send along with the ping request.
|
|
392
|
+
*/
|
|
393
|
+
export type RequestBodyV3_66_0 = string;
|
|
394
|
+
/**
|
|
395
|
+
* A custom body to send along with the ping request.
|
|
396
|
+
*/
|
|
397
|
+
export type RequestBodyFormatV3_66_0 = 'string' | 'form' | 'json' | 'form-data';
|
|
398
|
+
/**
|
|
399
|
+
* The amount of time to wait when receiving a response from the health check, in seconds.
|
|
400
|
+
*/
|
|
401
|
+
export type RequestTimeoutV3_66_0 = number;
|
|
402
|
+
/**
|
|
403
|
+
* The response status code that qualifies as healthy.
|
|
404
|
+
*/
|
|
405
|
+
export type HealthyResponseStatusCodeV3_66_0 = number;
|
|
406
|
+
/**
|
|
407
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
408
|
+
* via the `definition` "serviceHealthCheckTrigger".
|
|
409
|
+
*/
|
|
410
|
+
export type ServiceHealthCheckTriggerV3_66_0 = 'manual' | 'schedule';
|
|
411
|
+
/**
|
|
412
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
413
|
+
* via the `definition` "agentApiInput".
|
|
414
|
+
*/
|
|
415
|
+
export type AgentAPIInputV3_66_0 = AgentAPIMutationInputV3_66_0;
|
|
416
|
+
export type InteractionTimeoutMillisecondsV3_66_0 = number;
|
|
417
|
+
export type AgentStateSessionMemoryV3_66_0 = AgentStateSessionMemoryAssignmentV3_66_0[];
|
|
418
|
+
export type VariablesV3_66_0 = AgentVariableV3_66_0[];
|
|
419
|
+
/**
|
|
420
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
421
|
+
* via the `definition` "agentExecution".
|
|
422
|
+
*/
|
|
423
|
+
export type AgentExecutionV3_66_0 = AgentExecutionGraphQLV3_66_0 | AgentExecutionGenerateV3_66_0 | AgentExecutionChatV3_66_0;
|
|
424
|
+
/**
|
|
425
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
426
|
+
* via the `definition` "agentAiStateInput".
|
|
427
|
+
*/
|
|
428
|
+
export type AgentAIStateInputV3_66_0 = AgentAIStateInputArgumentV3_66_0 | AgentAIStateInputTemplateV3_66_0;
|
|
429
|
+
/**
|
|
430
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
431
|
+
* via the `definition` "agentAiStateAttachments".
|
|
432
|
+
*/
|
|
433
|
+
export type AgentAIStateAttachmentsV3_66_0 = AgentAIStateAttachmentsNoneV3_66_0 | AgentAIStateAttachmentsArgV3_66_0 | AgentAIStateAttachmentsExpressionV3_66_0;
|
|
434
|
+
export type HistoryV3_66_01 = boolean;
|
|
435
|
+
/**
|
|
436
|
+
* Maximum number of tokens to generate. Defaults to 1024
|
|
437
|
+
*/
|
|
438
|
+
export type MaximumTokensV3_66_01 = number;
|
|
439
|
+
/**
|
|
440
|
+
* 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
|
|
441
|
+
*/
|
|
442
|
+
export type TemperatureV3_66_01 = number;
|
|
443
|
+
/**
|
|
444
|
+
* 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.
|
|
445
|
+
*/
|
|
446
|
+
export type TopPV3_66_01 = number;
|
|
447
|
+
/**
|
|
448
|
+
* 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.
|
|
449
|
+
*/
|
|
450
|
+
export type TopKV3_66_01 = number;
|
|
451
|
+
/**
|
|
452
|
+
* 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.
|
|
453
|
+
*/
|
|
454
|
+
export type PresencePenaltySettingV3_66_01 = number;
|
|
455
|
+
/**
|
|
456
|
+
* 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.
|
|
457
|
+
*/
|
|
458
|
+
export type FrequencyPenaltySettingV3_66_01 = number;
|
|
459
|
+
/**
|
|
460
|
+
* If set, the model will stop generating text when one of the stop sequences is generated.
|
|
461
|
+
*/
|
|
462
|
+
export type StopSequencesV3_66_01 = string[];
|
|
463
|
+
/**
|
|
464
|
+
* The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
|
|
465
|
+
*/
|
|
466
|
+
export type SeedV3_66_01 = number;
|
|
467
|
+
/**
|
|
468
|
+
* Maximal number of automatic roundtrips for tool calls.
|
|
469
|
+
*/
|
|
470
|
+
export type MaxToolRoundtripsV3_66_0 = number;
|
|
471
|
+
/**
|
|
472
|
+
* Enable prompt caching for supported providers (e.g., Anthropic). Reduces token costs by caching system messages, tools, and conversation history.
|
|
473
|
+
*/
|
|
474
|
+
export type PromptCachingV3_66_01 = boolean;
|
|
475
|
+
/**
|
|
476
|
+
* If true, structured outputs will be enabled on the model for non-text requests.
|
|
477
|
+
*/
|
|
478
|
+
export type StructuredOutputsV3_66_0 = boolean;
|
|
479
|
+
/**
|
|
480
|
+
* Enable OpenAI schema format. Must be enabled if `structuredOutputs` is enabled.
|
|
481
|
+
*/
|
|
482
|
+
export type EnableOpenAISchemaFormatV3_66_0 = boolean;
|
|
483
|
+
export type MinimatchPatternV3_66_0 = string;
|
|
484
|
+
/**
|
|
485
|
+
* Remove properties from the schema sent to the model with keys matching these minimatch glob patterns.
|
|
486
|
+
*
|
|
487
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
488
|
+
* via the `definition` "removePropertyKeyPatterns".
|
|
489
|
+
*/
|
|
490
|
+
export type RemovePropertyKeyPatternsV3_66_0 = MinimatchPatternV3_66_0[];
|
|
491
|
+
/**
|
|
492
|
+
* Remove Markdown formatting from the LLM response
|
|
493
|
+
*/
|
|
494
|
+
export type StripMarkdownV3_66_0 = boolean;
|
|
495
|
+
/**
|
|
496
|
+
* These steps are evaluated in order until a destination is found.
|
|
497
|
+
*
|
|
498
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
499
|
+
* via the `definition` "agentTransition".
|
|
500
|
+
*/
|
|
501
|
+
export type AgentTransitionV3_66_0 = AgentTransitionImmediateV3_66_0 | AgentTransitionSuspendV3_66_0;
|
|
502
|
+
export type AgentStateSessionMemoryV3_66_01 = AgentStateSessionMemoryAssignmentV3_66_0[];
|
|
503
|
+
export type GuardIDV3_66_0 = string;
|
|
504
|
+
export type VariablesV3_66_01 = AgentVariableV3_66_0[];
|
|
505
|
+
/**
|
|
506
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
507
|
+
* via the `definition` "historyStrategyTransform".
|
|
508
|
+
*/
|
|
509
|
+
export type HistoryStrategyTransformV3_66_0 = HistoryStrategyTransformNoneV3_66_0 | HistoryStrategyTransformReplaceV3_66_0 | HistoryStrategyTransformSummarizeV3_66_0;
|
|
510
|
+
/**
|
|
511
|
+
* Enabling this will require a proof-of-work token to be included with each request. This will prevent abuse and spam.
|
|
512
|
+
*/
|
|
513
|
+
export type EnableAgentAbuseProtectionV3_66_0 = boolean;
|
|
514
|
+
/**
|
|
515
|
+
* The human-readable name of the Guard.
|
|
516
|
+
*/
|
|
517
|
+
export type NameV3_66_01 = string;
|
|
518
|
+
/**
|
|
519
|
+
* A description of the Guard.
|
|
520
|
+
*/
|
|
521
|
+
export type DescriptionV3_66_01 = string;
|
|
522
|
+
/**
|
|
523
|
+
* Guards will not run unless enabled.
|
|
524
|
+
*/
|
|
525
|
+
export type EnabledV3_66_0 = boolean;
|
|
526
|
+
/**
|
|
527
|
+
* The remote id of the Guardrail.
|
|
528
|
+
*/
|
|
529
|
+
export type GuardrailIdentifierV3_66_0 = string;
|
|
530
|
+
/**
|
|
531
|
+
* The remote version of the Guardrail.
|
|
532
|
+
*/
|
|
533
|
+
export type GuardrailVersionV3_66_0 = string;
|
|
534
|
+
/**
|
|
535
|
+
* A message to return when the input message is blocked by the Guard.
|
|
536
|
+
*/
|
|
537
|
+
export type BlockedInputMessagingV3_66_0 = string;
|
|
538
|
+
/**
|
|
539
|
+
* A message to return when the output message is blocked by the Guard.
|
|
540
|
+
*/
|
|
541
|
+
export type BlockedOutputsMessagingV3_66_0 = string;
|
|
542
|
+
export type ExampleV3_66_0 = string;
|
|
543
|
+
/**
|
|
544
|
+
* A topic to block.
|
|
545
|
+
*/
|
|
546
|
+
export type TopicV3_66_0 = {
|
|
547
|
+
name: string;
|
|
548
|
+
definition: string;
|
|
549
|
+
/**
|
|
550
|
+
* Examples of the topic that can hint the LLM.
|
|
551
|
+
*/
|
|
552
|
+
examples?: ExampleV3_66_0[];
|
|
553
|
+
type: 'DENY';
|
|
554
|
+
}[];
|
|
555
|
+
export type InputStrengthV3_66_0 = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
556
|
+
export type OutputStrengthV3_66_0 = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
557
|
+
/**
|
|
558
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
559
|
+
* via the `definition` "guardrailModality".
|
|
560
|
+
*/
|
|
561
|
+
export type GuardrailModalityV3_66_0 = 'TEXT' | 'IMAGE';
|
|
562
|
+
/**
|
|
563
|
+
* Whether to filter images or text
|
|
564
|
+
*/
|
|
565
|
+
export type InputModalitiesV3_66_0 = GuardrailModalityV3_66_0[];
|
|
566
|
+
/**
|
|
567
|
+
* Whether to filter images or text
|
|
568
|
+
*/
|
|
569
|
+
export type OutputModalitiesV3_66_0 = GuardrailModalityV3_66_0[];
|
|
570
|
+
/**
|
|
571
|
+
* Types of content to filter.
|
|
572
|
+
*/
|
|
573
|
+
export type FilterV3_66_0 = {
|
|
574
|
+
type: 'HATE' | 'INSULTS' | 'MICONDUCT' | 'PROMPT_ATTACK' | 'SEXUAL' | 'VIOLENCE';
|
|
575
|
+
inputStrength: InputStrengthV3_66_0;
|
|
576
|
+
outputStrength: OutputStrengthV3_66_0;
|
|
577
|
+
inputModalities?: InputModalitiesV3_66_0;
|
|
578
|
+
outputModalities?: OutputModalitiesV3_66_0;
|
|
579
|
+
}[];
|
|
580
|
+
/**
|
|
581
|
+
* Specific words to block.
|
|
582
|
+
*/
|
|
583
|
+
export type WordListV3_66_0 = {
|
|
584
|
+
text: string;
|
|
585
|
+
}[];
|
|
586
|
+
/**
|
|
587
|
+
* This is solely used for blocking profanity.
|
|
588
|
+
*/
|
|
589
|
+
export type ManagedWordListV3_66_0 = {
|
|
590
|
+
type: 'PROFANITY';
|
|
591
|
+
}[];
|
|
592
|
+
/**
|
|
593
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
594
|
+
* via the `definition` "guardrailSensitiveInformationAction".
|
|
595
|
+
*/
|
|
596
|
+
export type GuardrailSensitiveInformationActionV3_66_0 = 'ANONYMIZE' | 'BLOCK';
|
|
597
|
+
/**
|
|
598
|
+
* PII entity to infer from the text.
|
|
599
|
+
*/
|
|
600
|
+
export type PIIEntityV3_66_0 = {
|
|
601
|
+
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';
|
|
602
|
+
action: GuardrailSensitiveInformationActionV3_66_0;
|
|
603
|
+
}[];
|
|
604
|
+
/**
|
|
605
|
+
* A regular expression to match sensitive information.
|
|
606
|
+
*/
|
|
607
|
+
export type RegularExpressionV3_66_0 = {
|
|
608
|
+
name: string;
|
|
609
|
+
description?: string;
|
|
610
|
+
pattern: string;
|
|
611
|
+
action: GuardrailSensitiveInformationActionV3_66_0;
|
|
612
|
+
}[];
|
|
613
|
+
/**
|
|
614
|
+
* The type of filter.
|
|
615
|
+
*/
|
|
616
|
+
export type TypeV3_66_0 = 'GROUNDING' | 'RELEVANCE';
|
|
617
|
+
/**
|
|
618
|
+
* The threshold for the filter as a floating point value greater than 0.0 and less than 1.0.
|
|
619
|
+
*/
|
|
620
|
+
export type ThresholdV3_66_0 = number;
|
|
621
|
+
/**
|
|
622
|
+
* Filter to evaluate grounding text.
|
|
623
|
+
*/
|
|
624
|
+
export type FilterV3_66_01 = {
|
|
625
|
+
type: TypeV3_66_0;
|
|
626
|
+
threshold: ThresholdV3_66_0;
|
|
627
|
+
}[];
|
|
628
|
+
/**
|
|
629
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
630
|
+
* via the `definition` "toolExecution".
|
|
631
|
+
*/
|
|
632
|
+
export type ToolExecutionJSONV3_66_0 = ToolExecutionRemoteJSONV3_66_0 | ToolExecutionGraphQLJSONV3_66_0;
|
|
633
|
+
/**
|
|
634
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
635
|
+
* via the `definition` "toolQueryConfig".
|
|
636
|
+
*/
|
|
637
|
+
export type ToolQueryConfigV3_66_0 = ToolQueryRefConfigV3_66_0 | string;
|
|
638
|
+
/**
|
|
639
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
640
|
+
* via the `definition` "allOfSchema".
|
|
641
|
+
*/
|
|
642
|
+
export type AllOfSchemaV3_66_0 = PropertySchemaV3_66_0 & {
|
|
643
|
+
allOf: ObjectOrRefArrayV3_66_0;
|
|
644
|
+
};
|
|
645
|
+
/**
|
|
646
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
647
|
+
* via the `definition` "oneOfSchema".
|
|
648
|
+
*/
|
|
649
|
+
export type OneOfSchemaV3_66_0 = PropertySchemaV3_66_0 & {
|
|
650
|
+
oneOf: ObjectOrRefArrayV3_66_0;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* Options to be passed to the serialization routine.
|
|
654
|
+
*
|
|
655
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
656
|
+
* via the `definition` "parameterSerializeOptions".
|
|
657
|
+
*
|
|
658
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
659
|
+
* via the `patternProperty` "^[^\n\r]*$".
|
|
660
|
+
*/
|
|
661
|
+
export type ParameterSerializeOptionsV3_66_0 = ParameterSerializeStyleOptionsV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
662
|
+
/**
|
|
663
|
+
* An array of key / value or directive config tuples
|
|
664
|
+
*
|
|
665
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
666
|
+
* via the `definition` "directiveMappingArray".
|
|
667
|
+
*/
|
|
668
|
+
export type DirectiveMappingArrayV3_66_0 = DirectiveMappingArrayItemV3_66_0[];
|
|
669
|
+
/**
|
|
670
|
+
* A resolver which references a specific service
|
|
671
|
+
*
|
|
672
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
673
|
+
* via the `definition` "serviceResolver".
|
|
674
|
+
*/
|
|
675
|
+
export type ServiceResolverV3_66_0 = TakeshapeResolverV3_66_0 | ShapedbResolverShapeNameNotRequiredV3_66_0 | ShapedbResolverV3_66_0 | GraphqlResolverV3_66_0 | RestResolverV3_66_0 | AwsLambdaResolverV3_66_0;
|
|
676
|
+
/**
|
|
677
|
+
* An array of key / value or directive config tuples
|
|
678
|
+
*
|
|
679
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
680
|
+
* via the `definition` "searchParamsMapping".
|
|
681
|
+
*/
|
|
682
|
+
export type SearchParamsMappingV3_66_01 = DirectiveMappingArrayItemV3_66_0[];
|
|
683
|
+
/**
|
|
684
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
685
|
+
* via the `definition` "shapeWithObjectSchema".
|
|
686
|
+
*/
|
|
687
|
+
export type ShapeWithObjectSchemaV3_66_0 = ShapeJSONV3_66_0 & {
|
|
688
|
+
schema: ObjectSchemaV3_66_0;
|
|
689
|
+
};
|
|
690
|
+
/**
|
|
691
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
692
|
+
* via the `definition` "serviceAuthentication".
|
|
693
|
+
*/
|
|
694
|
+
export type ServiceAuthenticationV3_66_0 = OAuth2AuthenticationV3_66_0 | OAuth2BearerAuthenticationV3_66_0 | BearerAuthenticationV3_66_0 | BasicAuthenticationV3_66_0 | SearchParamsAuthenticationV3_66_0 | AWSAuthenticationV3_66_0 | GoogleAuthenticationV3_66_0 | CustomAuthenticationV3_66_0;
|
|
695
|
+
/**
|
|
696
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
697
|
+
* via the `definition` "anyServiceConfig".
|
|
698
|
+
*/
|
|
699
|
+
export type AnyServiceConfigV3_66_0 = ServiceConfigJSONV3_66_0 | ServiceConfigV3_66_0;
|
|
700
|
+
export interface ProjectSchemaJSONV3_66_0 {
|
|
701
|
+
$schema?: string;
|
|
702
|
+
/**
|
|
703
|
+
* The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
|
|
704
|
+
*/
|
|
705
|
+
apiVersion: string;
|
|
706
|
+
/**
|
|
707
|
+
* The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
|
|
708
|
+
*/
|
|
709
|
+
schemaVersion: '3.66.0';
|
|
710
|
+
/**
|
|
711
|
+
* The ID of the TakeShape project this schema belongs to.
|
|
712
|
+
*/
|
|
713
|
+
projectId: string;
|
|
714
|
+
/**
|
|
715
|
+
* The ID of the TakeShape user who created the schema.
|
|
716
|
+
*/
|
|
717
|
+
author?: string;
|
|
718
|
+
deactivated?: number;
|
|
719
|
+
/**
|
|
720
|
+
* The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
|
|
721
|
+
*/
|
|
722
|
+
defaultLocale: string;
|
|
723
|
+
locales: string[];
|
|
724
|
+
queries: QueryMapV3_66_0;
|
|
725
|
+
mutations: QueryMapV3_66_0;
|
|
726
|
+
shapes: ShapeMapV3_66_0;
|
|
727
|
+
forms?: FormMapV3_66_0;
|
|
728
|
+
workflows: WorkflowMapV3_66_0;
|
|
729
|
+
services?: ServiceMapJSONV3_66_0;
|
|
730
|
+
agents?: AgentMapV3_66_0;
|
|
731
|
+
guards?: GuardMapV3_66_0;
|
|
732
|
+
tools?: ToolMapV3_66_0;
|
|
733
|
+
}
|
|
734
|
+
/**
|
|
735
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
736
|
+
* via the `definition` "queryMap".
|
|
737
|
+
*/
|
|
738
|
+
export interface QueryMapV3_66_0 {
|
|
739
|
+
[k: string]: QueryJSONV3_66_0;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* This interface was referenced by `QueryMapV3_66_0`'s JSON-Schema definition
|
|
743
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
744
|
+
*
|
|
745
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
746
|
+
* via the `definition` "query".
|
|
747
|
+
*/
|
|
748
|
+
export interface QueryJSONV3_66_0 {
|
|
749
|
+
args?: ArgsV3_66_0;
|
|
750
|
+
resolver: ResolverV3_66_0;
|
|
751
|
+
shape: ReturnShapeV3_66_0;
|
|
752
|
+
/**
|
|
753
|
+
* Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
|
|
754
|
+
*/
|
|
755
|
+
description?: string;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
759
|
+
* via the `definition` "propertySchema".
|
|
760
|
+
*/
|
|
761
|
+
export interface PropertySchemaV3_66_0 {
|
|
762
|
+
$ref?: string;
|
|
763
|
+
title?: string;
|
|
764
|
+
description?: string;
|
|
765
|
+
default?: any;
|
|
766
|
+
readOnly?: boolean;
|
|
767
|
+
multipleOf?: number;
|
|
768
|
+
maximum?: number;
|
|
769
|
+
exclusiveMaximum?: number;
|
|
770
|
+
minimum?: number;
|
|
771
|
+
exclusiveMinimum?: number;
|
|
772
|
+
maxLength?: NonNegativeIntegerV3_66_0;
|
|
773
|
+
minLength?: NonNegativeIntegerDefault0V3_66_0;
|
|
774
|
+
pattern?: string;
|
|
775
|
+
additionalItems?: PropertySchemaV3_66_0;
|
|
776
|
+
items?: PropertySchemaV3_66_0;
|
|
777
|
+
maxItems?: NonNegativeIntegerV3_66_0;
|
|
778
|
+
minItems?: NonNegativeIntegerDefault0V3_66_0;
|
|
779
|
+
uniqueItems?: boolean;
|
|
780
|
+
contains?: PropertySchemaV3_66_0;
|
|
781
|
+
maxProperties?: NonNegativeIntegerV3_66_0;
|
|
782
|
+
minProperties?: NonNegativeIntegerDefault0V3_66_0;
|
|
783
|
+
required?: StringArrayV3_66_0;
|
|
784
|
+
additionalProperties?: PropertySchemaV3_66_0 | false;
|
|
785
|
+
definitions?: {
|
|
786
|
+
[k: string]: PropertySchemaV3_66_0;
|
|
787
|
+
};
|
|
788
|
+
properties?: {
|
|
789
|
+
[k: string]: PropertySchemaV3_66_0;
|
|
790
|
+
};
|
|
791
|
+
const?: any;
|
|
792
|
+
enum?: any[];
|
|
793
|
+
type?: SimpleTypesV3_66_0 | SimpleTypesV3_66_0[];
|
|
794
|
+
format?: string;
|
|
795
|
+
contentMediaType?: string;
|
|
796
|
+
contentEncoding?: string;
|
|
797
|
+
allOf?: SchemaArrayV3_66_0;
|
|
798
|
+
discriminator?: {
|
|
799
|
+
propertyName?: string;
|
|
800
|
+
[k: string]: any;
|
|
801
|
+
};
|
|
802
|
+
oneOf?: SchemaArrayV3_66_0;
|
|
803
|
+
extends?: ObjectOrRefArrayV3_66_0;
|
|
804
|
+
'@backreference'?: BackReferenceV3_66_0;
|
|
805
|
+
'@input'?: PropertySchemaV3_66_0;
|
|
806
|
+
'@output'?: PropertySchemaV3_66_0;
|
|
807
|
+
'@syncLocaleStructure'?: boolean;
|
|
808
|
+
'@sensitive'?: boolean;
|
|
809
|
+
'@draftjs'?: boolean;
|
|
810
|
+
'@l10n'?: boolean;
|
|
811
|
+
'@key'?: string;
|
|
812
|
+
'@workflow'?: string;
|
|
813
|
+
'@mapping'?: FieldMappingV3_66_0;
|
|
814
|
+
'@tag'?: string;
|
|
815
|
+
'@tags'?: string[];
|
|
816
|
+
'@deprecationReason'?: string;
|
|
817
|
+
'@args'?: ArgsV3_66_0;
|
|
818
|
+
'@resolver'?: ResolverV3_66_0;
|
|
819
|
+
'@dependencies'?: DependenciesV3_66_0;
|
|
820
|
+
'@ref'?: RefV3_66_0;
|
|
821
|
+
'@derivedFrom'?: string;
|
|
822
|
+
'@indexed'?: IndexedV3_66_0;
|
|
823
|
+
'@graphql'?: GraphQLConfigV3_66_0;
|
|
824
|
+
}
|
|
825
|
+
/**
|
|
826
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
827
|
+
* via the `definition` "refSchema".
|
|
828
|
+
*/
|
|
829
|
+
export interface RefSchemaV3_66_0 {
|
|
830
|
+
'@ref': RefV3_66_0;
|
|
831
|
+
[k: string]: any;
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
835
|
+
* via the `definition` "refSchemaLegacy".
|
|
836
|
+
*/
|
|
837
|
+
export interface RefSchemaLegacyV3_66_0 {
|
|
838
|
+
$ref: RefV3_66_0;
|
|
839
|
+
[k: string]: any;
|
|
840
|
+
}
|
|
841
|
+
/**
|
|
842
|
+
* A configuration object for a reverse reference in a relationship.
|
|
843
|
+
*
|
|
844
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
845
|
+
* via the `definition` "backreference".
|
|
846
|
+
*/
|
|
847
|
+
export interface BackReferenceV3_66_0 {
|
|
848
|
+
enabled: boolean;
|
|
849
|
+
name?: string;
|
|
850
|
+
}
|
|
851
|
+
/**
|
|
852
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
853
|
+
* via the `definition` "utilResolver".
|
|
854
|
+
*/
|
|
855
|
+
export interface UtilResolverV3_66_0 {
|
|
856
|
+
if?: string;
|
|
857
|
+
id?: string;
|
|
858
|
+
name: UtilResolverNameV3_66_0;
|
|
859
|
+
options?: UtilResolverOptionsV3_66_0;
|
|
860
|
+
/**
|
|
861
|
+
* Optional value to return from the noop resolver.
|
|
862
|
+
*/
|
|
863
|
+
value?: number | string | boolean | {
|
|
864
|
+
[k: string]: any;
|
|
865
|
+
} | any[] | null;
|
|
866
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
867
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
868
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
869
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
870
|
+
}
|
|
871
|
+
export interface UtilResolverOptionsV3_66_0 {
|
|
872
|
+
[k: string]: any;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
876
|
+
* via the `definition` "parameterConfigForJson".
|
|
877
|
+
*/
|
|
878
|
+
export interface ParameterConfigForJsonV3_66_0 {
|
|
879
|
+
ops: ParameterOpListV3_66_0;
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* An object describing an operation to generate a parameter, using a nested OpList.
|
|
883
|
+
*
|
|
884
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
885
|
+
* via the `definition` "parameterOpNested".
|
|
886
|
+
*/
|
|
887
|
+
export interface ParameterOpNestedV3_66_0 {
|
|
888
|
+
/**
|
|
889
|
+
* A path to the parameter for this operation.
|
|
890
|
+
*/
|
|
891
|
+
path: string;
|
|
892
|
+
/**
|
|
893
|
+
* A mode for this parameter's operation.
|
|
894
|
+
*/
|
|
895
|
+
op?: 'set' | 'concat' | 'extend' | 'remove';
|
|
896
|
+
ops: ParameterOpListV3_66_0;
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* An object describing an operation to generate a parameter using a value.
|
|
900
|
+
*
|
|
901
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
902
|
+
* via the `definition` "parameterOpValue".
|
|
903
|
+
*/
|
|
904
|
+
export interface ParameterOpValueV3_66_0 {
|
|
905
|
+
/**
|
|
906
|
+
* A path to the parameter for this operation.
|
|
907
|
+
*/
|
|
908
|
+
path: string;
|
|
909
|
+
/**
|
|
910
|
+
* A mode for this parameter's operation.
|
|
911
|
+
*/
|
|
912
|
+
op?: 'set' | 'concat' | 'extend' | 'remove';
|
|
913
|
+
/**
|
|
914
|
+
* A value to set directly at this path.
|
|
915
|
+
*/
|
|
916
|
+
value: number | string | boolean | {
|
|
917
|
+
[k: string]: any;
|
|
918
|
+
} | any[] | null;
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* An object describing an operation to generate a parameter using a mapping.
|
|
922
|
+
*
|
|
923
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
924
|
+
* via the `definition` "parameterOpMapping".
|
|
925
|
+
*/
|
|
926
|
+
export interface ParameterOpMappingV3_66_0 {
|
|
927
|
+
/**
|
|
928
|
+
* A path to the parameter for this operation.
|
|
929
|
+
*/
|
|
930
|
+
path: string;
|
|
931
|
+
/**
|
|
932
|
+
* A mode for this parameter's operation.
|
|
933
|
+
*/
|
|
934
|
+
op?: 'set' | 'concat' | 'extend' | 'remove';
|
|
935
|
+
/**
|
|
936
|
+
* Either a valid JSONPath or a directive pipeline to evaluate against the query context.
|
|
937
|
+
*/
|
|
938
|
+
mapping: string | DirectiveConfigV3_66_0;
|
|
939
|
+
}
|
|
940
|
+
export interface DirectiveOptionsV3_66_0 {
|
|
941
|
+
[k: string]: any;
|
|
942
|
+
}
|
|
943
|
+
/**
|
|
944
|
+
* An object describing an operation to generate a parameter using a mapping.
|
|
945
|
+
*
|
|
946
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
947
|
+
* via the `definition` "parameterOpOp".
|
|
948
|
+
*/
|
|
949
|
+
export interface ParameterOpOpV3_66_0 {
|
|
950
|
+
/**
|
|
951
|
+
* A path to the parameter for this operation.
|
|
952
|
+
*/
|
|
953
|
+
path: string;
|
|
954
|
+
/**
|
|
955
|
+
* A mode for this parameter's operation.
|
|
956
|
+
*/
|
|
957
|
+
op: 'set' | 'concat' | 'extend' | 'remove';
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* An map of object keys / key paths to directive configs
|
|
961
|
+
*
|
|
962
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
963
|
+
* via the `definition` "directiveMappingMap".
|
|
964
|
+
*/
|
|
965
|
+
export interface DirectiveMappingMapV3_66_0 {
|
|
966
|
+
[k: string]: DirectiveConfigV3_66_0;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
970
|
+
* via the `definition` "delegateResolver".
|
|
971
|
+
*/
|
|
972
|
+
export interface DelegateResolverV3_66_0 {
|
|
973
|
+
if?: string;
|
|
974
|
+
id?: string;
|
|
975
|
+
name: DelegateResolverNameV3_66_0;
|
|
976
|
+
options?: DelegateResolverOptionsV3_66_0;
|
|
977
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
978
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
979
|
+
/**
|
|
980
|
+
* A ref to a query/mutation/property to delegate to.
|
|
981
|
+
*/
|
|
982
|
+
to: string;
|
|
983
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
984
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
985
|
+
}
|
|
986
|
+
export interface DelegateResolverOptionsV3_66_0 {
|
|
987
|
+
[k: string]: any;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* A resolver that automatically paginates through a GraphQL query and returns all items as a flat array.
|
|
991
|
+
*
|
|
992
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
993
|
+
* via the `definition` "fetchAllResolver".
|
|
994
|
+
*/
|
|
995
|
+
export interface FetchAllResolverV3_66_0 {
|
|
996
|
+
if?: string;
|
|
997
|
+
id?: string;
|
|
998
|
+
name: FetchAllResolverNameV3_66_0;
|
|
999
|
+
options?: FetchAllResolverOptionsV3_66_0;
|
|
1000
|
+
/**
|
|
1001
|
+
* The GraphQL query string to execute
|
|
1002
|
+
*/
|
|
1003
|
+
query: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* Path to the paginated field within the query response (e.g., 'variants'). All pagination paths are relative to this.
|
|
1006
|
+
*/
|
|
1007
|
+
dataPath?: string;
|
|
1008
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1009
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1010
|
+
pagination?: PaginationConfigV3_66_0;
|
|
1011
|
+
}
|
|
1012
|
+
export interface FetchAllResolverOptionsV3_66_0 {
|
|
1013
|
+
/**
|
|
1014
|
+
* Maximum number of pages to fetch
|
|
1015
|
+
*/
|
|
1016
|
+
maxPages?: number;
|
|
1017
|
+
/**
|
|
1018
|
+
* Number of items per page (overrides pagination config)
|
|
1019
|
+
*/
|
|
1020
|
+
pageSize?: number;
|
|
1021
|
+
}
|
|
1022
|
+
/**
|
|
1023
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1024
|
+
* via the `definition` "paginationCursorConfig".
|
|
1025
|
+
*/
|
|
1026
|
+
export interface PaginationCursorConfigV3_66_0 {
|
|
1027
|
+
type: 'cursor';
|
|
1028
|
+
cursorArg: string;
|
|
1029
|
+
cursorPath: string;
|
|
1030
|
+
pageSize?: number;
|
|
1031
|
+
pageSizeArg: string;
|
|
1032
|
+
hasMorePath: string;
|
|
1033
|
+
itemsPath: string;
|
|
1034
|
+
}
|
|
1035
|
+
/**
|
|
1036
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1037
|
+
* via the `definition` "paginationPageConfig".
|
|
1038
|
+
*/
|
|
1039
|
+
export interface PaginationPageConfigV3_66_0 {
|
|
1040
|
+
type: 'page';
|
|
1041
|
+
pageArg: string;
|
|
1042
|
+
pageSize?: number;
|
|
1043
|
+
pageSizeArg?: string;
|
|
1044
|
+
itemsPath: string;
|
|
1045
|
+
pageTotalPath: string;
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1049
|
+
* via the `definition` "paginationOffsetConfig".
|
|
1050
|
+
*/
|
|
1051
|
+
export interface PaginationOffsetConfigV3_66_0 {
|
|
1052
|
+
type: 'offset';
|
|
1053
|
+
offsetArg: string;
|
|
1054
|
+
pageSize?: number;
|
|
1055
|
+
pageSizeArg?: string;
|
|
1056
|
+
itemsPath: string;
|
|
1057
|
+
itemTotalPath: string;
|
|
1058
|
+
}
|
|
1059
|
+
/**
|
|
1060
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1061
|
+
* via the `definition` "takeshapeResolver".
|
|
1062
|
+
*/
|
|
1063
|
+
export interface TakeshapeResolverV3_66_0 {
|
|
1064
|
+
if?: string;
|
|
1065
|
+
id?: string;
|
|
1066
|
+
name: TakeshapeResolverNameV3_66_0;
|
|
1067
|
+
/**
|
|
1068
|
+
* Internal service identifier.
|
|
1069
|
+
*/
|
|
1070
|
+
service: 'takeshape';
|
|
1071
|
+
options?: TakeshapeResolverOptionsV3_66_0;
|
|
1072
|
+
/**
|
|
1073
|
+
* An optional Shape name for the resolver.
|
|
1074
|
+
*/
|
|
1075
|
+
shapeName?: string;
|
|
1076
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1077
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1078
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1079
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1080
|
+
}
|
|
1081
|
+
export interface TakeshapeResolverOptionsV3_66_0 {
|
|
1082
|
+
[k: string]: any;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1086
|
+
* via the `definition` "aiHybridSearchResolver".
|
|
1087
|
+
*/
|
|
1088
|
+
export interface AIHybridSearchResolverV3_66_0 {
|
|
1089
|
+
if?: string;
|
|
1090
|
+
id?: string;
|
|
1091
|
+
name: AIHybridSearchResolverNameV3_66_0;
|
|
1092
|
+
/**
|
|
1093
|
+
* A vector property ref to use for the query. The property must have an ai:createEmbedding resolver configured. The embedding service and model are derived from the property's resolver config.
|
|
1094
|
+
*/
|
|
1095
|
+
vectorProperty: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* Weight factor for keyword search results. Default: 0.5
|
|
1098
|
+
*/
|
|
1099
|
+
keywordWeight?: number;
|
|
1100
|
+
/**
|
|
1101
|
+
* Weight factor for vector search results. Default: 0.5
|
|
1102
|
+
*/
|
|
1103
|
+
vectorWeight?: number;
|
|
1104
|
+
/**
|
|
1105
|
+
* Number of nearest neighbors for vector search. Default: 3
|
|
1106
|
+
*/
|
|
1107
|
+
vectorK?: number;
|
|
1108
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1109
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1110
|
+
}
|
|
1111
|
+
/**
|
|
1112
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1113
|
+
* via the `definition` "shapedbResolver".
|
|
1114
|
+
*/
|
|
1115
|
+
export interface ShapedbResolverV3_66_0 {
|
|
1116
|
+
if?: string;
|
|
1117
|
+
id?: string;
|
|
1118
|
+
name: ShapedbResolverNameV3_66_0;
|
|
1119
|
+
/**
|
|
1120
|
+
* Internal service identifier.
|
|
1121
|
+
*/
|
|
1122
|
+
service: 'shapedb';
|
|
1123
|
+
options?: ShapedbResolverOptionsV3_66_0;
|
|
1124
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1125
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1126
|
+
/**
|
|
1127
|
+
* A Shape name for the resolver to use.
|
|
1128
|
+
*/
|
|
1129
|
+
shapeName: string;
|
|
1130
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1131
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1132
|
+
}
|
|
1133
|
+
export interface ShapedbResolverOptionsV3_66_0 {
|
|
1134
|
+
[k: string]: any;
|
|
1135
|
+
}
|
|
1136
|
+
/**
|
|
1137
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1138
|
+
* via the `definition` "shapedbResolverShapeNameNotRequired".
|
|
1139
|
+
*/
|
|
1140
|
+
export interface ShapedbResolverShapeNameNotRequiredV3_66_0 {
|
|
1141
|
+
if?: string;
|
|
1142
|
+
id?: string;
|
|
1143
|
+
name: ShapedbResolverShapeNameNotRequiredNameV3_66_0;
|
|
1144
|
+
/**
|
|
1145
|
+
* Internal service identifier.
|
|
1146
|
+
*/
|
|
1147
|
+
service: 'shapedb';
|
|
1148
|
+
options?: ShapedbResolverShapeNameNotRequiredOptionsV3_66_0;
|
|
1149
|
+
/**
|
|
1150
|
+
* An optional Shape name for the resolver.
|
|
1151
|
+
*/
|
|
1152
|
+
shapeName?: string;
|
|
1153
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1154
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1155
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1156
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1157
|
+
}
|
|
1158
|
+
export interface ShapedbResolverShapeNameNotRequiredOptionsV3_66_0 {
|
|
1159
|
+
[k: string]: any;
|
|
1160
|
+
}
|
|
1161
|
+
/**
|
|
1162
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1163
|
+
* via the `definition` "graphqlResolver".
|
|
1164
|
+
*/
|
|
1165
|
+
export interface GraphqlResolverV3_66_0 {
|
|
1166
|
+
if?: string;
|
|
1167
|
+
id?: string;
|
|
1168
|
+
name: GraphqlResolverNameV3_66_0;
|
|
1169
|
+
/**
|
|
1170
|
+
* Configuration for a service to use with this resolver.
|
|
1171
|
+
*/
|
|
1172
|
+
service: string;
|
|
1173
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1174
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1175
|
+
options?: GraphqlResolverOptionsV3_66_0;
|
|
1176
|
+
/**
|
|
1177
|
+
* A fieldname to use in queries.
|
|
1178
|
+
*/
|
|
1179
|
+
fieldName: string;
|
|
1180
|
+
headers?: ParameterConfigForHeadersV3_66_0;
|
|
1181
|
+
searchParams?: ParameterConfigForSearchParamsV3_66_0;
|
|
1182
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1183
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1184
|
+
}
|
|
1185
|
+
export interface GraphqlResolverOptionsV3_66_0 {
|
|
1186
|
+
selectionSet?: string;
|
|
1187
|
+
unboxParentSelectionSet?: boolean;
|
|
1188
|
+
ignoreErrors?: boolean;
|
|
1189
|
+
skipWhenMissingArgs?: boolean;
|
|
1190
|
+
ttl?: number;
|
|
1191
|
+
timeout?: number;
|
|
1192
|
+
allowStream?: boolean;
|
|
1193
|
+
retry?: number | {
|
|
1194
|
+
[k: string]: any;
|
|
1195
|
+
};
|
|
1196
|
+
[k: string]: any;
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1200
|
+
* via the `definition` "parameterConfigForHeaders".
|
|
1201
|
+
*/
|
|
1202
|
+
export interface ParameterConfigForHeadersV3_66_0 {
|
|
1203
|
+
ops: ParameterOpListV3_66_0;
|
|
1204
|
+
serialize?: ParameterSerializeConfigForHeadersV3_66_0;
|
|
1205
|
+
}
|
|
1206
|
+
/**
|
|
1207
|
+
* Top-level paths to use headers serialization options for.
|
|
1208
|
+
*
|
|
1209
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1210
|
+
* via the `definition` "parameterSerializeConfigForHeaders".
|
|
1211
|
+
*/
|
|
1212
|
+
export interface ParameterSerializeConfigForHeadersV3_66_0 {
|
|
1213
|
+
defaults?: ParameterSerializeStyleOptionsForHeadersV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
1214
|
+
paths?: {
|
|
1215
|
+
/**
|
|
1216
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
1217
|
+
* via the `patternProperty` "^[^\n\r]*$".
|
|
1218
|
+
*/
|
|
1219
|
+
[k: string]: ParameterSerializeStyleOptionsForHeadersV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
1220
|
+
};
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* Options to be passed to the serialization routine.
|
|
1224
|
+
*
|
|
1225
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1226
|
+
* via the `definition` "parameterSerializeStyleOptionsForHeaders".
|
|
1227
|
+
*/
|
|
1228
|
+
export interface ParameterSerializeStyleOptionsForHeadersV3_66_0 {
|
|
1229
|
+
style: 'simple' | 'none';
|
|
1230
|
+
explode?: boolean;
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* Options to be passed to the serialization routine.
|
|
1234
|
+
*
|
|
1235
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1236
|
+
* via the `definition` "parameterSerializeContentOptions".
|
|
1237
|
+
*/
|
|
1238
|
+
export interface ParameterSerializeContentOptionsV3_66_0 {
|
|
1239
|
+
contentType: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
|
|
1242
|
+
*/
|
|
1243
|
+
allowReserved?: boolean;
|
|
1244
|
+
skipEncoding?: boolean;
|
|
1245
|
+
/**
|
|
1246
|
+
* Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
|
|
1247
|
+
*/
|
|
1248
|
+
options?: {
|
|
1249
|
+
[k: string]: any;
|
|
1250
|
+
};
|
|
1251
|
+
}
|
|
1252
|
+
/**
|
|
1253
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1254
|
+
* via the `definition` "parameterConfigForSearchParams".
|
|
1255
|
+
*/
|
|
1256
|
+
export interface ParameterConfigForSearchParamsV3_66_0 {
|
|
1257
|
+
ops: ParameterOpListV3_66_0;
|
|
1258
|
+
serialize?: ParameterSerializeConfigForSearchParamsV3_66_0;
|
|
1259
|
+
}
|
|
1260
|
+
/**
|
|
1261
|
+
* Top-level paths to use search params serialization options for.
|
|
1262
|
+
*
|
|
1263
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1264
|
+
* via the `definition` "parameterSerializeConfigForSearchParams".
|
|
1265
|
+
*/
|
|
1266
|
+
export interface ParameterSerializeConfigForSearchParamsV3_66_0 {
|
|
1267
|
+
defaults?: ParameterSerializeStyleOptionsForSearchParamsV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
1268
|
+
paths?: {
|
|
1269
|
+
/**
|
|
1270
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
1271
|
+
* via the `patternProperty` "^[^\n\r]*$".
|
|
1272
|
+
*/
|
|
1273
|
+
[k: string]: ParameterSerializeStyleOptionsForSearchParamsV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
1274
|
+
};
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* Options to be passed to the serialization routine.
|
|
1278
|
+
*
|
|
1279
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1280
|
+
* via the `definition` "parameterSerializeStyleOptionsForSearchParams".
|
|
1281
|
+
*/
|
|
1282
|
+
export interface ParameterSerializeStyleOptionsForSearchParamsV3_66_0 {
|
|
1283
|
+
style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
|
|
1284
|
+
explode?: boolean;
|
|
1285
|
+
allowEmptyValue?: boolean;
|
|
1286
|
+
/**
|
|
1287
|
+
* The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
|
|
1288
|
+
*/
|
|
1289
|
+
allowReserved?: boolean;
|
|
1290
|
+
skipEncoding?: boolean;
|
|
1291
|
+
}
|
|
1292
|
+
/**
|
|
1293
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1294
|
+
* via the `definition` "restResolver".
|
|
1295
|
+
*/
|
|
1296
|
+
export interface RestResolverV3_66_0 {
|
|
1297
|
+
if?: string;
|
|
1298
|
+
id?: string;
|
|
1299
|
+
name: RestResolverNameV3_66_0;
|
|
1300
|
+
/**
|
|
1301
|
+
* Configuration for a service to use with this resolver.
|
|
1302
|
+
*/
|
|
1303
|
+
service: string;
|
|
1304
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1305
|
+
searchParamsMapping?: SearchParamsMappingV3_66_0;
|
|
1306
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1307
|
+
options?: RestResolverOptionsV3_66_0;
|
|
1308
|
+
body?: ParameterConfigForBodyV3_66_0;
|
|
1309
|
+
form?: ParameterConfigForSearchParamsV3_66_0;
|
|
1310
|
+
headers?: ParameterConfigForHeadersV3_66_0;
|
|
1311
|
+
json?: ParameterConfigForJsonV3_66_0;
|
|
1312
|
+
/**
|
|
1313
|
+
* Mapping and serialization configuration for the path, or a simple string.
|
|
1314
|
+
*/
|
|
1315
|
+
path: ParameterConfigForPathParamsV3_66_0 | string;
|
|
1316
|
+
searchParams?: ParameterConfigForSearchParamsV3_66_0;
|
|
1317
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1318
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1319
|
+
}
|
|
1320
|
+
export interface RestResolverOptionsV3_66_0 {
|
|
1321
|
+
trailingSlash?: boolean;
|
|
1322
|
+
allowStream?: boolean;
|
|
1323
|
+
ttl?: number;
|
|
1324
|
+
timeout?: number;
|
|
1325
|
+
retry?: number | {
|
|
1326
|
+
[k: string]: any;
|
|
1327
|
+
};
|
|
1328
|
+
[k: string]: any;
|
|
1329
|
+
}
|
|
1330
|
+
/**
|
|
1331
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1332
|
+
* via the `definition` "parameterConfigForBody".
|
|
1333
|
+
*/
|
|
1334
|
+
export interface ParameterConfigForBodyV3_66_0 {
|
|
1335
|
+
ops: ParameterOpListV3_66_0;
|
|
1336
|
+
serialize?: ParameterSerializeConfigForBodyV3_66_0;
|
|
1337
|
+
}
|
|
1338
|
+
/**
|
|
1339
|
+
* Top-level paths to use serialization options for.
|
|
1340
|
+
*
|
|
1341
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1342
|
+
* via the `definition` "parameterSerializeConfigForBody".
|
|
1343
|
+
*/
|
|
1344
|
+
export interface ParameterSerializeConfigForBodyV3_66_0 {
|
|
1345
|
+
content?: ParameterSerializeContentOptionsV3_66_0;
|
|
1346
|
+
}
|
|
1347
|
+
/**
|
|
1348
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1349
|
+
* via the `definition` "parameterConfigForPathParams".
|
|
1350
|
+
*/
|
|
1351
|
+
export interface ParameterConfigForPathParamsV3_66_0 {
|
|
1352
|
+
ops: ParameterOpListV3_66_0;
|
|
1353
|
+
serialize: ParameterSerializeConfigForPathParamsV3_66_0;
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* Top-level paths to use path params serialization options for.
|
|
1357
|
+
*
|
|
1358
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1359
|
+
* via the `definition` "parameterSerializeConfigForPathParams".
|
|
1360
|
+
*/
|
|
1361
|
+
export interface ParameterSerializeConfigForPathParamsV3_66_0 {
|
|
1362
|
+
/**
|
|
1363
|
+
* For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
|
|
1364
|
+
*/
|
|
1365
|
+
template: string;
|
|
1366
|
+
defaults?: ParameterSerializeStyleOptionsForPathParamsV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
1367
|
+
paths?: {
|
|
1368
|
+
/**
|
|
1369
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
1370
|
+
* via the `patternProperty` "^[^\n\r]*$".
|
|
1371
|
+
*/
|
|
1372
|
+
[k: string]: ParameterSerializeStyleOptionsForPathParamsV3_66_0 | ParameterSerializeContentOptionsV3_66_0;
|
|
1373
|
+
};
|
|
1374
|
+
}
|
|
1375
|
+
/**
|
|
1376
|
+
* Options to be passed to the serialization routine.
|
|
1377
|
+
*
|
|
1378
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1379
|
+
* via the `definition` "parameterSerializeStyleOptionsForPathParams".
|
|
1380
|
+
*/
|
|
1381
|
+
export interface ParameterSerializeStyleOptionsForPathParamsV3_66_0 {
|
|
1382
|
+
style: 'simple' | 'label' | 'matrix' | 'none';
|
|
1383
|
+
explode?: boolean;
|
|
1384
|
+
allowEmptyValue?: boolean;
|
|
1385
|
+
/**
|
|
1386
|
+
* The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
|
|
1387
|
+
*/
|
|
1388
|
+
allowReserved?: boolean;
|
|
1389
|
+
skipEncoding?: boolean;
|
|
1390
|
+
}
|
|
1391
|
+
/**
|
|
1392
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1393
|
+
* via the `definition` "awsLambdaResolver".
|
|
1394
|
+
*/
|
|
1395
|
+
export interface AwsLambdaResolverV3_66_0 {
|
|
1396
|
+
if?: string;
|
|
1397
|
+
id?: string;
|
|
1398
|
+
name: AwsLambdaResolverNameV3_66_0;
|
|
1399
|
+
/**
|
|
1400
|
+
* Configuration for a service to use with this resolver.
|
|
1401
|
+
*/
|
|
1402
|
+
service: string;
|
|
1403
|
+
options?: AwsLambdaResolverOptionsV3_66_0;
|
|
1404
|
+
payload?: ParameterConfigForJsonV3_66_0;
|
|
1405
|
+
/**
|
|
1406
|
+
* Mapping configuration for the FunctionName.
|
|
1407
|
+
*/
|
|
1408
|
+
functionName: string | ParameterConfigForAwsLambdaV3_66_0;
|
|
1409
|
+
clientContext?: ParameterConfigForJsonV3_66_0;
|
|
1410
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1411
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1412
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1413
|
+
searchParamsMapping?: SearchParamsMappingV3_66_0;
|
|
1414
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1415
|
+
}
|
|
1416
|
+
export interface AwsLambdaResolverOptionsV3_66_0 {
|
|
1417
|
+
[k: string]: any;
|
|
1418
|
+
}
|
|
1419
|
+
/**
|
|
1420
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1421
|
+
* via the `definition` "parameterConfigForAwsLambda".
|
|
1422
|
+
*/
|
|
1423
|
+
export interface ParameterConfigForAwsLambdaV3_66_0 {
|
|
1424
|
+
ops: ParameterOpListV3_66_0;
|
|
1425
|
+
serialize: ParameterSerializeConfigForPathParamsV3_66_0;
|
|
1426
|
+
}
|
|
1427
|
+
/**
|
|
1428
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1429
|
+
* via the `definition` "salsifyResolver".
|
|
1430
|
+
*/
|
|
1431
|
+
export interface SalsifyResolverV3_66_0 {
|
|
1432
|
+
if?: string;
|
|
1433
|
+
id?: string;
|
|
1434
|
+
name: SalsifyResolverNameV3_66_0;
|
|
1435
|
+
/**
|
|
1436
|
+
* Configuration for a service to use with this resolver.
|
|
1437
|
+
*/
|
|
1438
|
+
service: string;
|
|
1439
|
+
options?: SalsifyResolverOptionsV3_66_0;
|
|
1440
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1441
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1442
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1443
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1444
|
+
}
|
|
1445
|
+
export interface SalsifyResolverOptionsV3_66_0 {
|
|
1446
|
+
[k: string]: any;
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1450
|
+
* via the `definition` "syndigoResolver".
|
|
1451
|
+
*/
|
|
1452
|
+
export interface SyndigoResolverV3_66_0 {
|
|
1453
|
+
if?: string;
|
|
1454
|
+
id?: string;
|
|
1455
|
+
name: SyndigoResolverNameV3_66_0;
|
|
1456
|
+
/**
|
|
1457
|
+
* Configuration for a service to use with this resolver.
|
|
1458
|
+
*/
|
|
1459
|
+
service: string;
|
|
1460
|
+
options?: SyndigoResolverOptionsV3_66_0;
|
|
1461
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1462
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1463
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1464
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1465
|
+
}
|
|
1466
|
+
export interface SyndigoResolverOptionsV3_66_0 {
|
|
1467
|
+
[k: string]: any;
|
|
1468
|
+
}
|
|
1469
|
+
/**
|
|
1470
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1471
|
+
* via the `definition` "functionResolver".
|
|
1472
|
+
*/
|
|
1473
|
+
export interface FunctionResolverV3_66_0 {
|
|
1474
|
+
if?: string;
|
|
1475
|
+
id?: string;
|
|
1476
|
+
name: FunctionResolverNameV3_66_0;
|
|
1477
|
+
options?: FunctionResolverOptionsV3_66_0;
|
|
1478
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1479
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1480
|
+
argsMapping?: ArgsMappingV3_66_0;
|
|
1481
|
+
resultsMapping?: ResultsMappingV3_66_0;
|
|
1482
|
+
javascript?: FunctionResolverJavascriptV3_66_0;
|
|
1483
|
+
}
|
|
1484
|
+
export interface FunctionResolverOptionsV3_66_0 {
|
|
1485
|
+
[k: string]: any;
|
|
1486
|
+
}
|
|
1487
|
+
/**
|
|
1488
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1489
|
+
* via the `definition` "aiGenerateTextResolver".
|
|
1490
|
+
*/
|
|
1491
|
+
export interface AIGenerateTextResolverV3_66_0 {
|
|
1492
|
+
if?: string;
|
|
1493
|
+
id?: string;
|
|
1494
|
+
name: AIResolverNameV3_66_0;
|
|
1495
|
+
/**
|
|
1496
|
+
* Configuration for a service to use with this resolver.
|
|
1497
|
+
*/
|
|
1498
|
+
service: string;
|
|
1499
|
+
options?: AIGenerateTextResolverOptionsV3_66_0;
|
|
1500
|
+
systemPrompt: string;
|
|
1501
|
+
inputTemplate?: string;
|
|
1502
|
+
model: string;
|
|
1503
|
+
tools?: AgentToolConfigV3_66_0[];
|
|
1504
|
+
guardrails?: AIGuardrailV3_66_0[];
|
|
1505
|
+
context?: ParameterConfigForJsonV3_66_0;
|
|
1506
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1510
|
+
* via the `definition` "aiGenerateTextResolverOptions".
|
|
1511
|
+
*/
|
|
1512
|
+
export interface AIGenerateTextResolverOptionsV3_66_0 {
|
|
1513
|
+
history?: HistoryV3_66_0;
|
|
1514
|
+
maxTokens?: MaximumTokensV3_66_0;
|
|
1515
|
+
temperature?: TemperatureV3_66_0;
|
|
1516
|
+
topP?: TopPV3_66_0;
|
|
1517
|
+
topK?: TopKV3_66_0;
|
|
1518
|
+
presencePenalty?: PresencePenaltySettingV3_66_0;
|
|
1519
|
+
frequencyPenalty?: FrequencyPenaltySettingV3_66_0;
|
|
1520
|
+
stopSequences?: StopSequencesV3_66_0;
|
|
1521
|
+
seed?: SeedV3_66_0;
|
|
1522
|
+
/**
|
|
1523
|
+
* Maximum number of retries. Set to 0 to disable retries. Defaults to 2
|
|
1524
|
+
*/
|
|
1525
|
+
maxRetries?: number;
|
|
1526
|
+
/**
|
|
1527
|
+
* The tool choice strategy. Default: 'auto'
|
|
1528
|
+
*/
|
|
1529
|
+
toolChoice?: (('auto' | 'none' | 'required') | string) & string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Maximal number of automatic roundtrips for tool calls.
|
|
1532
|
+
*/
|
|
1533
|
+
maxToolRoundtrips?: number;
|
|
1534
|
+
promptCaching?: PromptCachingV3_66_0;
|
|
1535
|
+
[k: string]: any;
|
|
1536
|
+
}
|
|
1537
|
+
/**
|
|
1538
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1539
|
+
* via the `definition` "agentToolConfig".
|
|
1540
|
+
*/
|
|
1541
|
+
export interface AgentToolConfigV3_66_0 {
|
|
1542
|
+
tool: string;
|
|
1543
|
+
alias?: string;
|
|
1544
|
+
description?: string;
|
|
1545
|
+
argBindings?: AgentToolConfigArgV3_66_0[];
|
|
1546
|
+
}
|
|
1547
|
+
/**
|
|
1548
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1549
|
+
* via the `definition` "agentToolConfigArgAgent".
|
|
1550
|
+
*/
|
|
1551
|
+
export interface AgentControlledV3_66_0 {
|
|
1552
|
+
type: 'agent';
|
|
1553
|
+
argName: ToolArgumentNameV3_66_0;
|
|
1554
|
+
}
|
|
1555
|
+
/**
|
|
1556
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1557
|
+
* via the `definition` "agentToolConfigArgVariable".
|
|
1558
|
+
*/
|
|
1559
|
+
export interface VariableValueV3_66_0 {
|
|
1560
|
+
type: 'variable';
|
|
1561
|
+
argName: ToolArgumentNameV3_66_01;
|
|
1562
|
+
variableName: StateVariableNameV3_66_0;
|
|
1563
|
+
}
|
|
1564
|
+
/**
|
|
1565
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1566
|
+
* via the `definition` "aiSimilarityGuardrail".
|
|
1567
|
+
*/
|
|
1568
|
+
export interface AISimilarityGuardrailV3_66_0 {
|
|
1569
|
+
name: 'similarity';
|
|
1570
|
+
shape: string;
|
|
1571
|
+
defaultResponse: string;
|
|
1572
|
+
threshold?: number;
|
|
1573
|
+
}
|
|
1574
|
+
/**
|
|
1575
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1576
|
+
* via the `definition` "aiGeneratePropertyResolver".
|
|
1577
|
+
*/
|
|
1578
|
+
export interface AIGeneratePropertyResolverV3_66_0 {
|
|
1579
|
+
id?: string;
|
|
1580
|
+
name: AIResolverNameV3_66_01;
|
|
1581
|
+
/**
|
|
1582
|
+
* Configuration for a service to use with this resolver.
|
|
1583
|
+
*/
|
|
1584
|
+
service: string;
|
|
1585
|
+
model: string;
|
|
1586
|
+
systemPrompt?: string;
|
|
1587
|
+
}
|
|
1588
|
+
/**
|
|
1589
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1590
|
+
* via the `definition` "aiEmbeddingResolver".
|
|
1591
|
+
*/
|
|
1592
|
+
export interface AIEmbeddingResolverV3_66_0 {
|
|
1593
|
+
if?: string;
|
|
1594
|
+
id?: string;
|
|
1595
|
+
name: AIResolverNameV3_66_02;
|
|
1596
|
+
/**
|
|
1597
|
+
* Configuration for a service to use with this resolver.
|
|
1598
|
+
*/
|
|
1599
|
+
service: string;
|
|
1600
|
+
options?: AIEmbeddingResolverOptionsV3_66_0;
|
|
1601
|
+
model: string;
|
|
1602
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1603
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1604
|
+
}
|
|
1605
|
+
/**
|
|
1606
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1607
|
+
* via the `definition` "aiEmbeddingResolverOptions".
|
|
1608
|
+
*/
|
|
1609
|
+
export interface AIEmbeddingResolverOptionsV3_66_0 {
|
|
1610
|
+
useDependencies?: boolean;
|
|
1611
|
+
[k: string]: any;
|
|
1612
|
+
}
|
|
1613
|
+
/**
|
|
1614
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1615
|
+
* via the `definition` "aiEmbeddingSearchResolver".
|
|
1616
|
+
*/
|
|
1617
|
+
export interface AIEmbeddingSearchResolverV3_66_0 {
|
|
1618
|
+
if?: string;
|
|
1619
|
+
id?: string;
|
|
1620
|
+
name: AIResolverNameV3_66_03;
|
|
1621
|
+
/**
|
|
1622
|
+
* A vector property ref to use for the query.
|
|
1623
|
+
*/
|
|
1624
|
+
vectorProperty: string;
|
|
1625
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1626
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1627
|
+
}
|
|
1628
|
+
/**
|
|
1629
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1630
|
+
* via the `definition` "aiParseFileResolver".
|
|
1631
|
+
*/
|
|
1632
|
+
export interface AIParseFileResolverV3_66_0 {
|
|
1633
|
+
if?: string;
|
|
1634
|
+
id?: string;
|
|
1635
|
+
name: AIResolverNameV3_66_04;
|
|
1636
|
+
/**
|
|
1637
|
+
* Configuration for a service to use with this resolver.
|
|
1638
|
+
*/
|
|
1639
|
+
service: string;
|
|
1640
|
+
options?: AIEmbeddingResolverOptionsV3_66_0;
|
|
1641
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1642
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1643
|
+
}
|
|
1644
|
+
/**
|
|
1645
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1646
|
+
* via the `definition` "utilChunkResolver".
|
|
1647
|
+
*/
|
|
1648
|
+
export interface ChunkResolverV3_66_0 {
|
|
1649
|
+
if?: string;
|
|
1650
|
+
id?: string;
|
|
1651
|
+
name: UtilResolverNameV3_66_01;
|
|
1652
|
+
options: UtilChunkResolverOptionsV3_66_0;
|
|
1653
|
+
args?: ParameterConfigForJsonV3_66_0;
|
|
1654
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1655
|
+
}
|
|
1656
|
+
/**
|
|
1657
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1658
|
+
* via the `definition` "utilChunkResolverOptionsCharacterCount".
|
|
1659
|
+
*/
|
|
1660
|
+
export interface UtilChunkResolverOptionsCharacterCountV3_66_0 {
|
|
1661
|
+
type: 'characterCount';
|
|
1662
|
+
characterCount: number;
|
|
1663
|
+
}
|
|
1664
|
+
/**
|
|
1665
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1666
|
+
* via the `definition` "utilChunkResolverOptionsSeparators".
|
|
1667
|
+
*/
|
|
1668
|
+
export interface UtilChunkResolverOptionsSeparatorsV3_66_0 {
|
|
1669
|
+
type: 'separators';
|
|
1670
|
+
separators: string[];
|
|
1671
|
+
}
|
|
1672
|
+
/**
|
|
1673
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1674
|
+
* via the `definition` "utilChunkResolverOptionsMarkdown".
|
|
1675
|
+
*/
|
|
1676
|
+
export interface UtilChunkResolverOptionsMarkdownV3_66_0 {
|
|
1677
|
+
type: 'markdown';
|
|
1678
|
+
/**
|
|
1679
|
+
* New chunks will be created at headers for this level or lower. Default 2.
|
|
1680
|
+
*/
|
|
1681
|
+
headerLevel?: number;
|
|
1682
|
+
/**
|
|
1683
|
+
* A new chunk will be started when this number of characters is reached, regardless of markup.
|
|
1684
|
+
*/
|
|
1685
|
+
maxCharacters?: number;
|
|
1686
|
+
}
|
|
1687
|
+
/**
|
|
1688
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1689
|
+
* via the `definition` "utilChunkResolverOptionsSemantic".
|
|
1690
|
+
*/
|
|
1691
|
+
export interface UtilChunkResolverOptionsSemanticV3_66_0 {
|
|
1692
|
+
type: 'semantic';
|
|
1693
|
+
serviceId: string;
|
|
1694
|
+
modelId: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* Similarity below which two embeddings are considered different.
|
|
1697
|
+
*/
|
|
1698
|
+
similarityThreshold?: number;
|
|
1699
|
+
/**
|
|
1700
|
+
* Advanced. How many sentences to advance when grouping sentences to create embeddings. Default 1.
|
|
1701
|
+
*/
|
|
1702
|
+
stride?: number;
|
|
1703
|
+
/**
|
|
1704
|
+
* Advanced. How many sentences are grouped together to create embeddings. Default 3.
|
|
1705
|
+
*/
|
|
1706
|
+
sentenceCount?: number;
|
|
1707
|
+
/**
|
|
1708
|
+
* The maximum number of characters in a chunk.
|
|
1709
|
+
*/
|
|
1710
|
+
maxCharacters?: number;
|
|
1711
|
+
/**
|
|
1712
|
+
* The maximum number of tokens in a chunk.
|
|
1713
|
+
*/
|
|
1714
|
+
maxTokens?: number;
|
|
1715
|
+
}
|
|
1716
|
+
/**
|
|
1717
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1718
|
+
* via the `definition` "aiRunAgentResolver".
|
|
1719
|
+
*/
|
|
1720
|
+
export interface AISendAgentMessageResolverV3_66_0 {
|
|
1721
|
+
id?: string;
|
|
1722
|
+
name: AIResolverNameV3_66_05;
|
|
1723
|
+
agentName: string;
|
|
1724
|
+
inputName: string;
|
|
1725
|
+
}
|
|
1726
|
+
/**
|
|
1727
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1728
|
+
* via the `definition` "aiInspectAgentResolver".
|
|
1729
|
+
*/
|
|
1730
|
+
export interface AIInspectAgentResolverV3_66_0 {
|
|
1731
|
+
id?: string;
|
|
1732
|
+
name: AIResolverNameV3_66_06;
|
|
1733
|
+
agentName: string;
|
|
1734
|
+
}
|
|
1735
|
+
/**
|
|
1736
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1737
|
+
* via the `definition` "aiCreateAgentSessionResolver".
|
|
1738
|
+
*/
|
|
1739
|
+
export interface AICreateAgentSessionResolverV3_66_0 {
|
|
1740
|
+
id?: string;
|
|
1741
|
+
name: AIResolverNameV3_66_07;
|
|
1742
|
+
agentName: string;
|
|
1743
|
+
}
|
|
1744
|
+
/**
|
|
1745
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1746
|
+
* via the `definition` "aiGetAgentMessageResolver".
|
|
1747
|
+
*/
|
|
1748
|
+
export interface AIGetAgentMessageResolverV3_66_0 {
|
|
1749
|
+
id?: string;
|
|
1750
|
+
name: AIResolverNameV3_66_08;
|
|
1751
|
+
agentName: string;
|
|
1752
|
+
}
|
|
1753
|
+
/**
|
|
1754
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1755
|
+
* via the `definition` "aiAbortAgentMessageResolver".
|
|
1756
|
+
*/
|
|
1757
|
+
export interface AIAbortAgentMessageResolverV3_66_0 {
|
|
1758
|
+
id?: string;
|
|
1759
|
+
name: AIResolverNameV3_66_09;
|
|
1760
|
+
agentName: string;
|
|
1761
|
+
}
|
|
1762
|
+
/**
|
|
1763
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1764
|
+
* via the `definition` "aiSendAgentFeedbackResolver".
|
|
1765
|
+
*/
|
|
1766
|
+
export interface AISendAgentFeedbackResolverV3_66_0 {
|
|
1767
|
+
id?: string;
|
|
1768
|
+
name: AIResolverNameV3_66_010;
|
|
1769
|
+
agentName: string;
|
|
1770
|
+
}
|
|
1771
|
+
/**
|
|
1772
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1773
|
+
* via the `definition` "composeResolver".
|
|
1774
|
+
*/
|
|
1775
|
+
export interface ComposeResolverV3_66_0 {
|
|
1776
|
+
compose: BasicResolverV3_66_0[];
|
|
1777
|
+
resultsMapping?: DirectiveMappingMapV3_66_0 | DirectiveConfigV3_66_0;
|
|
1778
|
+
results?: ParameterConfigForJsonV3_66_0;
|
|
1779
|
+
}
|
|
1780
|
+
/**
|
|
1781
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1782
|
+
* via the `definition` "indexed".
|
|
1783
|
+
*/
|
|
1784
|
+
export interface IndexedV3_66_0 {
|
|
1785
|
+
nested?: boolean;
|
|
1786
|
+
}
|
|
1787
|
+
/**
|
|
1788
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1789
|
+
* via the `definition` "graphql".
|
|
1790
|
+
*/
|
|
1791
|
+
export interface GraphQLConfigV3_66_0 {
|
|
1792
|
+
json?: boolean;
|
|
1793
|
+
}
|
|
1794
|
+
/**
|
|
1795
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1796
|
+
* via the `definition` "shapeMap".
|
|
1797
|
+
*/
|
|
1798
|
+
export interface ShapeMapV3_66_0 {
|
|
1799
|
+
[k: string]: ShapeJSONV3_66_0;
|
|
1800
|
+
}
|
|
1801
|
+
/**
|
|
1802
|
+
* A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
|
|
1803
|
+
*
|
|
1804
|
+
* This interface was referenced by `ShapeMapV3_66_0`'s JSON-Schema definition
|
|
1805
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
1806
|
+
*
|
|
1807
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1808
|
+
* via the `definition` "shape".
|
|
1809
|
+
*/
|
|
1810
|
+
export interface ShapeJSONV3_66_0 {
|
|
1811
|
+
/**
|
|
1812
|
+
* 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
|
|
1813
|
+
*/
|
|
1814
|
+
name: string;
|
|
1815
|
+
/**
|
|
1816
|
+
* 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.
|
|
1817
|
+
*/
|
|
1818
|
+
id: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* The human-readable name for a Shape for use in a UI.
|
|
1821
|
+
*/
|
|
1822
|
+
title: string;
|
|
1823
|
+
description?: string;
|
|
1824
|
+
type?: 'interface' | 'input' | 'output';
|
|
1825
|
+
interfaces?: string[];
|
|
1826
|
+
/**
|
|
1827
|
+
* Specifying a model type allows Shape data to be stored in TakeShape's built-in database
|
|
1828
|
+
*/
|
|
1829
|
+
model?: {
|
|
1830
|
+
type: ModelTypeV3_66_0;
|
|
1831
|
+
};
|
|
1832
|
+
workflow?: string;
|
|
1833
|
+
loaders?: ShapeLoadersV3_66_0;
|
|
1834
|
+
joins?: ShapeJoinsV3_66_0;
|
|
1835
|
+
cache?: ShapeCacheConfigV3_66_0;
|
|
1836
|
+
context?: ShapeContextV3_66_0;
|
|
1837
|
+
schema: ShapeSchemaV3_66_0;
|
|
1838
|
+
}
|
|
1839
|
+
/**
|
|
1840
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1841
|
+
* via the `definition` "shapeLoaders".
|
|
1842
|
+
*/
|
|
1843
|
+
export interface ShapeLoadersV3_66_0 {
|
|
1844
|
+
list: StoredListQueryLoaderConfigV3_66_0 | StoredListQueryLoaderConfigV3_66_0[];
|
|
1845
|
+
get?: GetQueryLoaderConfigV3_66_0;
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1849
|
+
* via the `definition` "storedListQueryLoaderConfig".
|
|
1850
|
+
*/
|
|
1851
|
+
export interface StoredListQueryLoaderConfigV3_66_0 {
|
|
1852
|
+
query: string;
|
|
1853
|
+
args?: {
|
|
1854
|
+
[k: string]: any;
|
|
1855
|
+
} | {
|
|
1856
|
+
[k: string]: any;
|
|
1857
|
+
}[];
|
|
1858
|
+
pagination?: PaginationConfigV3_66_0;
|
|
1859
|
+
}
|
|
1860
|
+
/**
|
|
1861
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1862
|
+
* via the `definition` "getQueryLoaderConfig".
|
|
1863
|
+
*/
|
|
1864
|
+
export interface GetQueryLoaderConfigV3_66_0 {
|
|
1865
|
+
query: string;
|
|
1866
|
+
args?: {
|
|
1867
|
+
[k: string]: any;
|
|
1868
|
+
};
|
|
1869
|
+
idArg?: string;
|
|
1870
|
+
}
|
|
1871
|
+
/**
|
|
1872
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1873
|
+
* via the `definition` "shapeJoins".
|
|
1874
|
+
*/
|
|
1875
|
+
export interface ShapeJoinsV3_66_0 {
|
|
1876
|
+
[k: string]: ShapeJoinV3_66_0;
|
|
1877
|
+
}
|
|
1878
|
+
/**
|
|
1879
|
+
* This interface was referenced by `ShapeJoinsV3_66_0`'s JSON-Schema definition
|
|
1880
|
+
* via the `patternProperty` "[:0-9A-Za-z_-]+".
|
|
1881
|
+
*
|
|
1882
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1883
|
+
* via the `definition` "shapeJoin".
|
|
1884
|
+
*/
|
|
1885
|
+
export interface ShapeJoinV3_66_0 {
|
|
1886
|
+
resolver: DelegateResolverV3_66_0 | ShapedbResolverV3_66_0;
|
|
1887
|
+
dependencies?: string;
|
|
1888
|
+
}
|
|
1889
|
+
/**
|
|
1890
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1891
|
+
* via the `definition` "shapeCacheConfig".
|
|
1892
|
+
*/
|
|
1893
|
+
export interface ShapeCacheConfigV3_66_0 {
|
|
1894
|
+
enabled: boolean;
|
|
1895
|
+
idField?: string;
|
|
1896
|
+
searchSummaryField?: string;
|
|
1897
|
+
fragment?: CachedFragmentConfigV3_66_0;
|
|
1898
|
+
triggers?: CacheTriggerConfigV3_66_0[];
|
|
1899
|
+
/**
|
|
1900
|
+
* Number of seconds this Shape should be cached. Default 0.
|
|
1901
|
+
*/
|
|
1902
|
+
maxAge?: number;
|
|
1903
|
+
/**
|
|
1904
|
+
* Requests after maxAge will send a request to origin to revalidate while serving stale content for this duration in the meantime.
|
|
1905
|
+
*/
|
|
1906
|
+
staleWhileRevalidate?: number;
|
|
1907
|
+
}
|
|
1908
|
+
/**
|
|
1909
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1910
|
+
* via the `definition` "cachedFragmentConfig".
|
|
1911
|
+
*/
|
|
1912
|
+
export interface CachedFragmentConfigV3_66_0 {
|
|
1913
|
+
ignoreFields?: string[];
|
|
1914
|
+
maxDepth?: number;
|
|
1915
|
+
selectionSet?: string;
|
|
1916
|
+
includeDeprecated?: boolean;
|
|
1917
|
+
}
|
|
1918
|
+
/**
|
|
1919
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1920
|
+
* via the `definition` "cacheScheduleTriggerConfig".
|
|
1921
|
+
*/
|
|
1922
|
+
export interface CacheScheduleTriggerConfigV3_66_0 {
|
|
1923
|
+
type: 'schedule';
|
|
1924
|
+
loader: 'get' | 'list';
|
|
1925
|
+
interval: number;
|
|
1926
|
+
}
|
|
1927
|
+
/**
|
|
1928
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1929
|
+
* via the `definition` "cacheWebhookTriggerConfig".
|
|
1930
|
+
*/
|
|
1931
|
+
export interface CacheWebhookTriggerConfigV3_66_0 {
|
|
1932
|
+
type: 'webhook';
|
|
1933
|
+
loader: 'get' | 'list';
|
|
1934
|
+
service: string;
|
|
1935
|
+
events: string[];
|
|
1936
|
+
}
|
|
1937
|
+
/**
|
|
1938
|
+
* Context configuration for storing variables that can be accessed by descendant resolvers
|
|
1939
|
+
*
|
|
1940
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1941
|
+
* via the `definition` "shapeContext".
|
|
1942
|
+
*/
|
|
1943
|
+
export interface ShapeContextV3_66_0 {
|
|
1944
|
+
/**
|
|
1945
|
+
* Variables to store in context when resolving fields on this shape. Keys are variable names, values are paths to property values.
|
|
1946
|
+
*/
|
|
1947
|
+
variables?: {
|
|
1948
|
+
[k: string]: string;
|
|
1949
|
+
};
|
|
1950
|
+
}
|
|
1951
|
+
/**
|
|
1952
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1953
|
+
* via the `definition` "shapeSchemaAllOf".
|
|
1954
|
+
*/
|
|
1955
|
+
export interface ShapeSchemaAllOfV3_66_0 {
|
|
1956
|
+
allOf: ObjectOrRefArrayV3_66_0;
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1960
|
+
* via the `definition` "shapeSchemaExtends".
|
|
1961
|
+
*/
|
|
1962
|
+
export interface ShapeSchemaExtendsV3_66_0 {
|
|
1963
|
+
extends: ObjectOrRefArrayV3_66_0;
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1967
|
+
* via the `definition` "shapeSchemaOneOf".
|
|
1968
|
+
*/
|
|
1969
|
+
export interface ShapeSchemaOneOfV3_66_0 {
|
|
1970
|
+
title?: string;
|
|
1971
|
+
description?: string;
|
|
1972
|
+
discriminator?: {
|
|
1973
|
+
propertyName: string;
|
|
1974
|
+
[k: string]: any;
|
|
1975
|
+
};
|
|
1976
|
+
oneOf: ObjectOrRefArrayV3_66_0;
|
|
1977
|
+
}
|
|
1978
|
+
/**
|
|
1979
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1980
|
+
* via the `definition` "shapeSchemaEnum".
|
|
1981
|
+
*/
|
|
1982
|
+
export interface ShapeSchemaEnumV3_66_0 {
|
|
1983
|
+
enum: any[];
|
|
1984
|
+
}
|
|
1985
|
+
/**
|
|
1986
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1987
|
+
* via the `definition` "shapeSchemaAny".
|
|
1988
|
+
*/
|
|
1989
|
+
export interface ShapeSchemaAnyV3_66_0 {
|
|
1990
|
+
}
|
|
1991
|
+
/**
|
|
1992
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
1993
|
+
* via the `definition` "formMap".
|
|
1994
|
+
*/
|
|
1995
|
+
export interface FormMapV3_66_0 {
|
|
1996
|
+
[k: string]: FormsConfigV3_66_0;
|
|
1997
|
+
}
|
|
1998
|
+
/**
|
|
1999
|
+
* This interface was referenced by `FormMapV3_66_0`'s JSON-Schema definition
|
|
2000
|
+
* via the `patternProperty` "[0-9A-Za-z_-]+".
|
|
2001
|
+
*
|
|
2002
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2003
|
+
* via the `definition` "formsConfig".
|
|
2004
|
+
*/
|
|
2005
|
+
export interface FormsConfigV3_66_0 {
|
|
2006
|
+
default: FormConfigV3_66_0;
|
|
2007
|
+
[k: string]: FormConfigV3_66_0;
|
|
2008
|
+
}
|
|
2009
|
+
/**
|
|
2010
|
+
* This interface was referenced by `FormsConfigV3_66_0`'s JSON-Schema definition
|
|
2011
|
+
* via the `patternProperty` "[0-9A-Za-z_-]+".
|
|
2012
|
+
*
|
|
2013
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
2014
|
+
* via the `patternProperty` "[0-9A-Za-z_-]+".
|
|
2015
|
+
*
|
|
2016
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2017
|
+
* via the `definition` "formConfig".
|
|
2018
|
+
*/
|
|
2019
|
+
export interface FormConfigV3_66_0 {
|
|
2020
|
+
[k: string]: any;
|
|
2021
|
+
}
|
|
2022
|
+
/**
|
|
2023
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2024
|
+
* via the `definition` "workflowMap".
|
|
2025
|
+
*/
|
|
2026
|
+
export interface WorkflowMapV3_66_0 {
|
|
2027
|
+
[k: string]: WorkflowV3_66_0;
|
|
2028
|
+
}
|
|
2029
|
+
/**
|
|
2030
|
+
* This interface was referenced by `WorkflowMapV3_66_0`'s JSON-Schema definition
|
|
2031
|
+
* via the `patternProperty` "[0-9A-Za-z_-]+".
|
|
2032
|
+
*
|
|
2033
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2034
|
+
* via the `definition` "workflow".
|
|
2035
|
+
*/
|
|
2036
|
+
export interface WorkflowV3_66_0 {
|
|
2037
|
+
/**
|
|
2038
|
+
* machine-readable id
|
|
2039
|
+
*/
|
|
2040
|
+
name: string;
|
|
2041
|
+
title: WorkflowNameV3_66_0;
|
|
2042
|
+
steps: StepsV3_66_0;
|
|
2043
|
+
[k: string]: any;
|
|
2044
|
+
}
|
|
2045
|
+
/**
|
|
2046
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2047
|
+
* via the `definition` "workflowStep".
|
|
2048
|
+
*/
|
|
2049
|
+
export interface WorkflowStepV3_66_0 {
|
|
2050
|
+
name: NameV3_66_0;
|
|
2051
|
+
title: TitleV3_66_0;
|
|
2052
|
+
description?: DescriptionV3_66_0;
|
|
2053
|
+
color: ColorV3_66_0;
|
|
2054
|
+
live: LiveV3_66_0;
|
|
2055
|
+
key: KeyV3_66_0;
|
|
2056
|
+
}
|
|
2057
|
+
/**
|
|
2058
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2059
|
+
* via the `definition` "storedServiceMap".
|
|
2060
|
+
*/
|
|
2061
|
+
export interface ServiceMapJSONV3_66_0 {
|
|
2062
|
+
[k: string]: ServiceConfigJSONV3_66_0;
|
|
2063
|
+
}
|
|
2064
|
+
/**
|
|
2065
|
+
* This interface was referenced by `ServiceMapJSONV3_66_0`'s JSON-Schema definition
|
|
2066
|
+
* via the `patternProperty` "[0-9A-Za-z_-]+".
|
|
2067
|
+
*
|
|
2068
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2069
|
+
* via the `definition` "storedServiceConfig".
|
|
2070
|
+
*/
|
|
2071
|
+
export interface ServiceConfigJSONV3_66_0 {
|
|
2072
|
+
/**
|
|
2073
|
+
* Machine-readable identifier, should typically be the same as the property name on the services object.
|
|
2074
|
+
*/
|
|
2075
|
+
id: string;
|
|
2076
|
+
/**
|
|
2077
|
+
* Human-readable name for this service.
|
|
2078
|
+
*/
|
|
2079
|
+
title: string;
|
|
2080
|
+
/**
|
|
2081
|
+
* The service provider id.
|
|
2082
|
+
*/
|
|
2083
|
+
provider: string;
|
|
2084
|
+
/**
|
|
2085
|
+
* A namespace to use for the imported types tied to this service.
|
|
2086
|
+
*/
|
|
2087
|
+
namespace?: string;
|
|
2088
|
+
serviceType: ServiceTypeV3_66_0;
|
|
2089
|
+
authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
|
|
2090
|
+
authentication?: string;
|
|
2091
|
+
healthCheck?: ServiceHealthCheckV3_66_0;
|
|
2092
|
+
webhookId?: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* Configuration options passed to and handled by the provider.
|
|
2095
|
+
*/
|
|
2096
|
+
options?: {
|
|
2097
|
+
[k: string]: any;
|
|
2098
|
+
};
|
|
2099
|
+
}
|
|
2100
|
+
/**
|
|
2101
|
+
* Configuration for ping health checks.
|
|
2102
|
+
*
|
|
2103
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2104
|
+
* via the `definition` "serviceHealthCheck".
|
|
2105
|
+
*/
|
|
2106
|
+
export interface ServiceHealthCheckV3_66_0 {
|
|
2107
|
+
checkName: CheckNameV3_66_0;
|
|
2108
|
+
endpoint?: EndpointV3_66_0;
|
|
2109
|
+
requestMethod?: RequestMethodV3_66_0;
|
|
2110
|
+
requestHeaders?: RequestHeadersV3_66_0;
|
|
2111
|
+
requestSearchParams?: RequestSearchParamsV3_66_0;
|
|
2112
|
+
requestBody?: RequestBodyV3_66_0;
|
|
2113
|
+
requestBodyFormat?: RequestBodyFormatV3_66_0;
|
|
2114
|
+
requestTimeout?: RequestTimeoutV3_66_0;
|
|
2115
|
+
healthyResponseStatusCode?: HealthyResponseStatusCodeV3_66_0;
|
|
2116
|
+
triggers?: ServiceHealthCheckTriggerV3_66_0[];
|
|
2117
|
+
}
|
|
2118
|
+
/**
|
|
2119
|
+
* Any custom headers to set with the health check request.
|
|
2120
|
+
*/
|
|
2121
|
+
export interface RequestHeadersV3_66_0 {
|
|
2122
|
+
[k: string]: any;
|
|
2123
|
+
}
|
|
2124
|
+
/**
|
|
2125
|
+
* Any custom search params to set with the health check request.
|
|
2126
|
+
*/
|
|
2127
|
+
export interface RequestSearchParamsV3_66_0 {
|
|
2128
|
+
[k: string]: any;
|
|
2129
|
+
}
|
|
2130
|
+
/**
|
|
2131
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2132
|
+
* via the `definition` "agentMap".
|
|
2133
|
+
*/
|
|
2134
|
+
export interface AgentMapV3_66_0 {
|
|
2135
|
+
[k: string]: AgentJSONV3_66_0;
|
|
2136
|
+
}
|
|
2137
|
+
/**
|
|
2138
|
+
* An Agent is a configuration for an AI service such as a chat bot or a search engine.
|
|
2139
|
+
*
|
|
2140
|
+
* This interface was referenced by `AgentMapV3_66_0`'s JSON-Schema definition
|
|
2141
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
2142
|
+
*
|
|
2143
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2144
|
+
* via the `definition` "agent".
|
|
2145
|
+
*/
|
|
2146
|
+
export interface AgentJSONV3_66_0 {
|
|
2147
|
+
title?: string;
|
|
2148
|
+
description?: string;
|
|
2149
|
+
disabled?: boolean;
|
|
2150
|
+
systemPrompt?: string;
|
|
2151
|
+
api: AgentAPIV3_66_0;
|
|
2152
|
+
memory?: AgentMemoryV3_66_0;
|
|
2153
|
+
start: AgentStartV3_66_0;
|
|
2154
|
+
states: AgentStatesV3_66_0;
|
|
2155
|
+
guards?: AgentGuardV3_66_0[];
|
|
2156
|
+
historyStrategies?: HistoryStrategyMapV3_66_0;
|
|
2157
|
+
protection?: AgentProtectionV3_66_0;
|
|
2158
|
+
}
|
|
2159
|
+
/**
|
|
2160
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2161
|
+
* via the `definition` "agentApi".
|
|
2162
|
+
*/
|
|
2163
|
+
export interface AgentAPIV3_66_0 {
|
|
2164
|
+
inputs: AgentAPIInputV3_66_0[];
|
|
2165
|
+
}
|
|
2166
|
+
/**
|
|
2167
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2168
|
+
* via the `definition` "agentApiMutationInput".
|
|
2169
|
+
*/
|
|
2170
|
+
export interface AgentAPIMutationInputV3_66_0 {
|
|
2171
|
+
type: 'mutation';
|
|
2172
|
+
name: string;
|
|
2173
|
+
args: string;
|
|
2174
|
+
interactionTimeout?: InteractionTimeoutMillisecondsV3_66_0;
|
|
2175
|
+
}
|
|
2176
|
+
/**
|
|
2177
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2178
|
+
* via the `definition` "agentMemory".
|
|
2179
|
+
*/
|
|
2180
|
+
export interface AgentMemoryV3_66_0 {
|
|
2181
|
+
sessionMemory: AgentSessionMemoryV3_66_0;
|
|
2182
|
+
}
|
|
2183
|
+
/**
|
|
2184
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2185
|
+
* via the `definition` "agentSessionMemory".
|
|
2186
|
+
*/
|
|
2187
|
+
export interface AgentSessionMemoryV3_66_0 {
|
|
2188
|
+
shape?: string;
|
|
2189
|
+
}
|
|
2190
|
+
/**
|
|
2191
|
+
* Configuration for the start of an agent's execution
|
|
2192
|
+
*
|
|
2193
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2194
|
+
* via the `definition` "agentStart".
|
|
2195
|
+
*/
|
|
2196
|
+
export interface AgentStartV3_66_0 {
|
|
2197
|
+
transitions: AgentTransitionSuspendV3_66_0[];
|
|
2198
|
+
}
|
|
2199
|
+
/**
|
|
2200
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2201
|
+
* via the `definition` "agentTransitionSuspend".
|
|
2202
|
+
*/
|
|
2203
|
+
export interface AgentTransitionSuspendV3_66_0 {
|
|
2204
|
+
type: 'suspend';
|
|
2205
|
+
destination: string;
|
|
2206
|
+
input: string;
|
|
2207
|
+
condition?: string;
|
|
2208
|
+
limit?: number;
|
|
2209
|
+
sessionMemory?: AgentStateSessionMemoryV3_66_0;
|
|
2210
|
+
historyStrategy?: string;
|
|
2211
|
+
}
|
|
2212
|
+
/**
|
|
2213
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2214
|
+
* via the `definition` "agentStateSessionMemoryAssignment".
|
|
2215
|
+
*/
|
|
2216
|
+
export interface AgentStateSessionMemoryAssignmentV3_66_0 {
|
|
2217
|
+
memoryPath?: string;
|
|
2218
|
+
expression: string;
|
|
2219
|
+
}
|
|
2220
|
+
/**
|
|
2221
|
+
* States that are traversed during the execution of an agent.
|
|
2222
|
+
*
|
|
2223
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2224
|
+
* via the `definition` "agentStateMap".
|
|
2225
|
+
*/
|
|
2226
|
+
export interface AgentStatesV3_66_0 {
|
|
2227
|
+
[k: string]: AgentStateV3_66_0;
|
|
2228
|
+
}
|
|
2229
|
+
/**
|
|
2230
|
+
* One step of an agent's execution.
|
|
2231
|
+
*
|
|
2232
|
+
* This interface was referenced by `AgentStatesV3_66_0`'s JSON-Schema definition
|
|
2233
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
2234
|
+
*
|
|
2235
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2236
|
+
* via the `definition` "agentState".
|
|
2237
|
+
*/
|
|
2238
|
+
export interface AgentStateV3_66_0 {
|
|
2239
|
+
name: string;
|
|
2240
|
+
variables?: VariablesV3_66_0;
|
|
2241
|
+
execution: AgentExecutionV3_66_0;
|
|
2242
|
+
transitions?: AgentTransitionV3_66_0[];
|
|
2243
|
+
}
|
|
2244
|
+
/**
|
|
2245
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2246
|
+
* via the `definition` "agentVariable".
|
|
2247
|
+
*/
|
|
2248
|
+
export interface AgentVariableV3_66_0 {
|
|
2249
|
+
name: string;
|
|
2250
|
+
/**
|
|
2251
|
+
* These are evaluated in order until a value is found.
|
|
2252
|
+
*/
|
|
2253
|
+
steps: AgentVariableStepV3_66_0[];
|
|
2254
|
+
}
|
|
2255
|
+
/**
|
|
2256
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2257
|
+
* via the `definition` "agentVariableStep".
|
|
2258
|
+
*/
|
|
2259
|
+
export interface AgentVariableStepV3_66_0 {
|
|
2260
|
+
condition?: string;
|
|
2261
|
+
expression: string;
|
|
2262
|
+
}
|
|
2263
|
+
/**
|
|
2264
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2265
|
+
* via the `definition` "agentExecutionGraphql".
|
|
2266
|
+
*/
|
|
2267
|
+
export interface AgentExecutionGraphQLV3_66_0 {
|
|
2268
|
+
type: 'graphql';
|
|
2269
|
+
query: string;
|
|
2270
|
+
path?: string;
|
|
2271
|
+
}
|
|
2272
|
+
/**
|
|
2273
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2274
|
+
* via the `definition` "agentExecutionGenerate".
|
|
2275
|
+
*/
|
|
2276
|
+
export interface AgentExecutionGenerateV3_66_0 {
|
|
2277
|
+
type: 'generate';
|
|
2278
|
+
service: string;
|
|
2279
|
+
model: string;
|
|
2280
|
+
systemPrompt?: string;
|
|
2281
|
+
input: AgentAIStateInputV3_66_0;
|
|
2282
|
+
attachments?: AgentAIStateAttachmentsV3_66_0;
|
|
2283
|
+
outputShape?: string;
|
|
2284
|
+
tools?: AgentToolConfigV3_66_0[];
|
|
2285
|
+
memoryTools?: MemoryToolJSONV3_66_0[];
|
|
2286
|
+
clientTools?: ClientToolJSONV3_66_0[];
|
|
2287
|
+
options?: AgentGenerateOptionsV3_66_0;
|
|
2288
|
+
}
|
|
2289
|
+
/**
|
|
2290
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2291
|
+
* via the `definition` "agentAiStateInputArg".
|
|
2292
|
+
*/
|
|
2293
|
+
export interface AgentAIStateInputArgumentV3_66_0 {
|
|
2294
|
+
type: 'arg';
|
|
2295
|
+
}
|
|
2296
|
+
/**
|
|
2297
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2298
|
+
* via the `definition` "agentAiStateInputTemplate".
|
|
2299
|
+
*/
|
|
2300
|
+
export interface AgentAIStateInputTemplateV3_66_0 {
|
|
2301
|
+
type: 'template';
|
|
2302
|
+
inputTemplate: string;
|
|
2303
|
+
}
|
|
2304
|
+
/**
|
|
2305
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2306
|
+
* via the `definition` "agentAiStateAttachmentsNone".
|
|
2307
|
+
*/
|
|
2308
|
+
export interface AgentAIStateAttachmentsNoneV3_66_0 {
|
|
2309
|
+
type: 'none';
|
|
2310
|
+
}
|
|
2311
|
+
/**
|
|
2312
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2313
|
+
* via the `definition` "agentAiStateAttachmentsArg".
|
|
2314
|
+
*/
|
|
2315
|
+
export interface AgentAIStateAttachmentsArgV3_66_0 {
|
|
2316
|
+
type: 'arg';
|
|
2317
|
+
}
|
|
2318
|
+
/**
|
|
2319
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2320
|
+
* via the `definition` "agentAiStateAttachmentsExpression".
|
|
2321
|
+
*/
|
|
2322
|
+
export interface AgentAIStateAttachmentsExpressionV3_66_0 {
|
|
2323
|
+
type: 'expression';
|
|
2324
|
+
expression: string;
|
|
2325
|
+
}
|
|
2326
|
+
/**
|
|
2327
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2328
|
+
* via the `definition` "memoryTool".
|
|
2329
|
+
*/
|
|
2330
|
+
export interface MemoryToolJSONV3_66_0 {
|
|
2331
|
+
name: string;
|
|
2332
|
+
description?: string;
|
|
2333
|
+
args?: string;
|
|
2334
|
+
operation: 'set' | 'merge' | 'add' | 'clear' | 'get' | 'search' | 'remove' | 'update' | 'concat';
|
|
2335
|
+
path?: string;
|
|
2336
|
+
}
|
|
2337
|
+
/**
|
|
2338
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2339
|
+
* via the `definition` "clientTool".
|
|
2340
|
+
*/
|
|
2341
|
+
export interface ClientToolJSONV3_66_0 {
|
|
2342
|
+
name: string;
|
|
2343
|
+
description?: string;
|
|
2344
|
+
parameters?: string;
|
|
2345
|
+
/**
|
|
2346
|
+
* noop = fire-and-forget yield = waits for client response
|
|
2347
|
+
*/
|
|
2348
|
+
type: 'noop' | 'yield';
|
|
2349
|
+
}
|
|
2350
|
+
/**
|
|
2351
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2352
|
+
* via the `definition` "agentGenerateOptions".
|
|
2353
|
+
*/
|
|
2354
|
+
export interface AgentGenerateOptionsV3_66_0 {
|
|
2355
|
+
history?: HistoryV3_66_01;
|
|
2356
|
+
maxTokens?: MaximumTokensV3_66_01;
|
|
2357
|
+
temperature?: TemperatureV3_66_01;
|
|
2358
|
+
topP?: TopPV3_66_01;
|
|
2359
|
+
topK?: TopKV3_66_01;
|
|
2360
|
+
presencePenalty?: PresencePenaltySettingV3_66_01;
|
|
2361
|
+
frequencyPenalty?: FrequencyPenaltySettingV3_66_01;
|
|
2362
|
+
stopSequences?: StopSequencesV3_66_01;
|
|
2363
|
+
seed?: SeedV3_66_01;
|
|
2364
|
+
/**
|
|
2365
|
+
* Maximum number of retries. Set to 0 to disable retries. Defaults to 2
|
|
2366
|
+
*/
|
|
2367
|
+
maxRetries?: number;
|
|
2368
|
+
/**
|
|
2369
|
+
* The tool choice strategy. Default: 'auto'
|
|
2370
|
+
*/
|
|
2371
|
+
toolChoice?: (('auto' | 'none' | 'required') | string) & string;
|
|
2372
|
+
maxToolRoundtrips?: MaxToolRoundtripsV3_66_0;
|
|
2373
|
+
promptCaching?: PromptCachingV3_66_01;
|
|
2374
|
+
structuredOutputs?: StructuredOutputsV3_66_0;
|
|
2375
|
+
enableOpenAIFormat?: EnableOpenAISchemaFormatV3_66_0;
|
|
2376
|
+
removePropertyKeyPatterns?: RemovePropertyKeyPatternsV3_66_0;
|
|
2377
|
+
stripMarkdown?: StripMarkdownV3_66_0;
|
|
2378
|
+
}
|
|
2379
|
+
/**
|
|
2380
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2381
|
+
* via the `definition` "agentExecutionChat".
|
|
2382
|
+
*/
|
|
2383
|
+
export interface AgentExecutionChatV3_66_0 {
|
|
2384
|
+
type: 'chat';
|
|
2385
|
+
service: string;
|
|
2386
|
+
model: string;
|
|
2387
|
+
systemPrompt?: string;
|
|
2388
|
+
input: AgentAIStateInputV3_66_0;
|
|
2389
|
+
attachments?: AgentAIStateAttachmentsV3_66_0;
|
|
2390
|
+
artifact?: string;
|
|
2391
|
+
tools?: AgentToolConfigV3_66_0[];
|
|
2392
|
+
memoryTools?: MemoryToolJSONV3_66_0[];
|
|
2393
|
+
clientTools?: ClientToolJSONV3_66_0[];
|
|
2394
|
+
options?: AgentGenerateOptionsV3_66_0;
|
|
2395
|
+
}
|
|
2396
|
+
/**
|
|
2397
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2398
|
+
* via the `definition` "agentTransitionImmediate".
|
|
2399
|
+
*/
|
|
2400
|
+
export interface AgentTransitionImmediateV3_66_0 {
|
|
2401
|
+
type: 'immediate';
|
|
2402
|
+
destination: string;
|
|
2403
|
+
condition?: string;
|
|
2404
|
+
limit?: number;
|
|
2405
|
+
sessionMemory?: AgentStateSessionMemoryV3_66_01;
|
|
2406
|
+
historyStrategy?: string;
|
|
2407
|
+
}
|
|
2408
|
+
/**
|
|
2409
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2410
|
+
* via the `definition` "agentGuard".
|
|
2411
|
+
*/
|
|
2412
|
+
export interface AgentGuardV3_66_0 {
|
|
2413
|
+
guardId: GuardIDV3_66_0;
|
|
2414
|
+
}
|
|
2415
|
+
/**
|
|
2416
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2417
|
+
* via the `definition` "historyStrategyMap".
|
|
2418
|
+
*/
|
|
2419
|
+
export interface HistoryStrategyMapV3_66_0 {
|
|
2420
|
+
[k: string]: HistoryStrategyV3_66_0;
|
|
2421
|
+
}
|
|
2422
|
+
/**
|
|
2423
|
+
* This interface was referenced by `HistoryStrategyMapV3_66_0`'s JSON-Schema definition
|
|
2424
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
2425
|
+
*
|
|
2426
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2427
|
+
* via the `definition` "historyStrategy".
|
|
2428
|
+
*/
|
|
2429
|
+
export interface HistoryStrategyV3_66_0 {
|
|
2430
|
+
name: string;
|
|
2431
|
+
variables?: VariablesV3_66_01;
|
|
2432
|
+
filter?: HistoryStrategyFilterV3_66_0;
|
|
2433
|
+
transform: HistoryStrategyTransformV3_66_0;
|
|
2434
|
+
}
|
|
2435
|
+
/**
|
|
2436
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2437
|
+
* via the `definition` "historyStrategyFilter".
|
|
2438
|
+
*/
|
|
2439
|
+
export interface HistoryStrategyFilterV3_66_0 {
|
|
2440
|
+
toolCalls?: 'retain' | 'clear';
|
|
2441
|
+
}
|
|
2442
|
+
/**
|
|
2443
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2444
|
+
* via the `definition` "historyStrategyTransformNone".
|
|
2445
|
+
*/
|
|
2446
|
+
export interface HistoryStrategyTransformNoneV3_66_0 {
|
|
2447
|
+
type: 'none';
|
|
2448
|
+
}
|
|
2449
|
+
/**
|
|
2450
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2451
|
+
* via the `definition` "historyStrategyTransformReplace".
|
|
2452
|
+
*/
|
|
2453
|
+
export interface HistoryStrategyTransformReplaceV3_66_0 {
|
|
2454
|
+
type: 'replace';
|
|
2455
|
+
template: string;
|
|
2456
|
+
}
|
|
2457
|
+
/**
|
|
2458
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2459
|
+
* via the `definition` "historyStrategyTransformSummarize".
|
|
2460
|
+
*/
|
|
2461
|
+
export interface HistoryStrategyTransformSummarizeV3_66_0 {
|
|
2462
|
+
type: 'generate';
|
|
2463
|
+
service: string;
|
|
2464
|
+
model: string;
|
|
2465
|
+
systemPrompt: string;
|
|
2466
|
+
tools?: AgentToolConfigV3_66_0[];
|
|
2467
|
+
options?: AgentGenerateOptionsV3_66_0;
|
|
2468
|
+
}
|
|
2469
|
+
/**
|
|
2470
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2471
|
+
* via the `definition` "agentProtection".
|
|
2472
|
+
*/
|
|
2473
|
+
export interface AgentProtectionV3_66_0 {
|
|
2474
|
+
enabled: EnableAgentAbuseProtectionV3_66_0;
|
|
2475
|
+
}
|
|
2476
|
+
/**
|
|
2477
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2478
|
+
* via the `definition` "guardMap".
|
|
2479
|
+
*/
|
|
2480
|
+
export interface GuardMapV3_66_0 {
|
|
2481
|
+
[k: string]: GuardJSONV3_66_0;
|
|
2482
|
+
}
|
|
2483
|
+
/**
|
|
2484
|
+
* A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.
|
|
2485
|
+
*
|
|
2486
|
+
* This interface was referenced by `GuardMapV3_66_0`'s JSON-Schema definition
|
|
2487
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
2488
|
+
*
|
|
2489
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2490
|
+
* via the `definition` "guard".
|
|
2491
|
+
*/
|
|
2492
|
+
export interface GuardJSONV3_66_0 {
|
|
2493
|
+
name: NameV3_66_01;
|
|
2494
|
+
description?: DescriptionV3_66_01;
|
|
2495
|
+
enabled?: EnabledV3_66_0;
|
|
2496
|
+
guardrailIdentifier?: GuardrailIdentifierV3_66_0;
|
|
2497
|
+
guardrailVersion?: GuardrailVersionV3_66_0;
|
|
2498
|
+
blockedInputMessaging?: BlockedInputMessagingV3_66_0;
|
|
2499
|
+
blockedOutputsMessaging?: BlockedOutputsMessagingV3_66_0;
|
|
2500
|
+
topicPolicyConfig?: TopicPolicyV3_66_0;
|
|
2501
|
+
contentPolicyConfig?: ContentPolicyV3_66_0;
|
|
2502
|
+
wordPolicyConfig?: WordPolicyV3_66_0;
|
|
2503
|
+
sensitiveInformationPolicyConfig?: SensitiveInformationPolicyV3_66_0;
|
|
2504
|
+
contextualGroundingPolicyConfig?: ContextualGroundingPolicyV3_66_0;
|
|
2505
|
+
}
|
|
2506
|
+
/**
|
|
2507
|
+
* Topics to identify and block.
|
|
2508
|
+
*/
|
|
2509
|
+
export interface TopicPolicyV3_66_0 {
|
|
2510
|
+
topicsConfig: TopicV3_66_0;
|
|
2511
|
+
}
|
|
2512
|
+
/**
|
|
2513
|
+
* Types of content to filter and strength configuration.
|
|
2514
|
+
*/
|
|
2515
|
+
export interface ContentPolicyV3_66_0 {
|
|
2516
|
+
filtersConfig: FilterV3_66_0;
|
|
2517
|
+
}
|
|
2518
|
+
/**
|
|
2519
|
+
* Specific words to identify and block.
|
|
2520
|
+
*/
|
|
2521
|
+
export interface WordPolicyV3_66_0 {
|
|
2522
|
+
wordsConfig?: WordListV3_66_0;
|
|
2523
|
+
managedWordListsConfig?: ManagedWordListV3_66_0;
|
|
2524
|
+
}
|
|
2525
|
+
/**
|
|
2526
|
+
* Filter out and block or obscure sensitive information. Matching text will be handled per the policy.
|
|
2527
|
+
*/
|
|
2528
|
+
export interface SensitiveInformationPolicyV3_66_0 {
|
|
2529
|
+
piiEntitiesConfig?: PIIEntityV3_66_0;
|
|
2530
|
+
regexesConfig?: RegularExpressionV3_66_0;
|
|
2531
|
+
}
|
|
2532
|
+
/**
|
|
2533
|
+
* Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.
|
|
2534
|
+
*/
|
|
2535
|
+
export interface ContextualGroundingPolicyV3_66_0 {
|
|
2536
|
+
filtersConfig: FilterV3_66_01;
|
|
2537
|
+
}
|
|
2538
|
+
/**
|
|
2539
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2540
|
+
* via the `definition` "toolMap".
|
|
2541
|
+
*/
|
|
2542
|
+
export interface ToolMapV3_66_0 {
|
|
2543
|
+
[k: string]: ToolJSONV3_66_0;
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* This interface was referenced by `ToolMapV3_66_0`'s JSON-Schema definition
|
|
2547
|
+
* via the `patternProperty` "^[0-9A-Za-z_]+$".
|
|
2548
|
+
*
|
|
2549
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2550
|
+
* via the `definition` "tool".
|
|
2551
|
+
*/
|
|
2552
|
+
export interface ToolJSONV3_66_0 {
|
|
2553
|
+
visibility?: 'public' | 'private';
|
|
2554
|
+
execution: ToolExecutionJSONV3_66_0;
|
|
2555
|
+
description?: string;
|
|
2556
|
+
}
|
|
2557
|
+
/**
|
|
2558
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2559
|
+
* via the `definition` "toolExecutionRemote".
|
|
2560
|
+
*/
|
|
2561
|
+
export interface ToolExecutionRemoteJSONV3_66_0 {
|
|
2562
|
+
type: 'remote';
|
|
2563
|
+
toolName: string;
|
|
2564
|
+
service: string;
|
|
2565
|
+
parameters?: ObjectSchemaV3_66_0;
|
|
2566
|
+
}
|
|
2567
|
+
/**
|
|
2568
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2569
|
+
* via the `definition` "toolExecutionGraphQL".
|
|
2570
|
+
*/
|
|
2571
|
+
export interface ToolExecutionGraphQLJSONV3_66_0 {
|
|
2572
|
+
type: 'graphql';
|
|
2573
|
+
query: ToolQueryConfigV3_66_0;
|
|
2574
|
+
path?: string;
|
|
2575
|
+
optimizeResponse?: ToolExecutionGraphQLOptimizeResponseJSONV3_66_0;
|
|
2576
|
+
}
|
|
2577
|
+
/**
|
|
2578
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2579
|
+
* via the `definition` "toolQueryRefConfig".
|
|
2580
|
+
*/
|
|
2581
|
+
export interface ToolQueryRefConfigV3_66_0 {
|
|
2582
|
+
ref: string;
|
|
2583
|
+
selectionSet?: string;
|
|
2584
|
+
args?: string[];
|
|
2585
|
+
}
|
|
2586
|
+
/**
|
|
2587
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2588
|
+
* via the `definition` "toolExecutionGraphQLOptimizeResponse".
|
|
2589
|
+
*/
|
|
2590
|
+
export interface ToolExecutionGraphQLOptimizeResponseJSONV3_66_0 {
|
|
2591
|
+
compactPagination?: boolean;
|
|
2592
|
+
}
|
|
2593
|
+
/**
|
|
2594
|
+
* All possible options for the more specific ParameterSerializeStyleOptions types.
|
|
2595
|
+
*
|
|
2596
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2597
|
+
* via the `definition` "parameterSerializeStyleOptions".
|
|
2598
|
+
*/
|
|
2599
|
+
export interface ParameterSerializeStyleOptionsV3_66_0 {
|
|
2600
|
+
style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
|
|
2601
|
+
explode?: boolean;
|
|
2602
|
+
allowEmptyValue?: boolean;
|
|
2603
|
+
/**
|
|
2604
|
+
* The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
|
|
2605
|
+
*/
|
|
2606
|
+
allowReserved?: boolean;
|
|
2607
|
+
skipEncoding?: boolean;
|
|
2608
|
+
}
|
|
2609
|
+
/**
|
|
2610
|
+
* All possible options for the more specific ParameterSerializeConfig types.
|
|
2611
|
+
*
|
|
2612
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2613
|
+
* via the `definition` "parameterSerializeConfig".
|
|
2614
|
+
*/
|
|
2615
|
+
export interface ParameterSerializeConfigV3_66_0 {
|
|
2616
|
+
content?: ParameterSerializeContentOptionsV3_66_0;
|
|
2617
|
+
defaults?: ParameterSerializeOptionsV3_66_0;
|
|
2618
|
+
paths?: {
|
|
2619
|
+
[k: string]: ParameterSerializeOptionsV3_66_0;
|
|
2620
|
+
};
|
|
2621
|
+
}
|
|
2622
|
+
/**
|
|
2623
|
+
* All possible options for the more specific ParameterConfig types.
|
|
2624
|
+
*
|
|
2625
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2626
|
+
* via the `definition` "parameterConfig".
|
|
2627
|
+
*/
|
|
2628
|
+
export interface ParameterConfigV3_66_0 {
|
|
2629
|
+
ops: ParameterOpListV3_66_0;
|
|
2630
|
+
serialize?: ParameterSerializeConfigV3_66_0;
|
|
2631
|
+
}
|
|
2632
|
+
/**
|
|
2633
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2634
|
+
* via the `definition` "aiParseFileResolverOptions".
|
|
2635
|
+
*/
|
|
2636
|
+
export interface AIParseFileResolverOptionsV3_66_0 {
|
|
2637
|
+
[k: string]: any;
|
|
2638
|
+
}
|
|
2639
|
+
/**
|
|
2640
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2641
|
+
* via the `definition` "listQueryLoaderConfig".
|
|
2642
|
+
*/
|
|
2643
|
+
export interface ListQueryLoaderConfigV3_66_0 {
|
|
2644
|
+
query: string;
|
|
2645
|
+
args?: {
|
|
2646
|
+
[k: string]: any;
|
|
2647
|
+
};
|
|
2648
|
+
pagination?: PaginationConfigV3_66_0;
|
|
2649
|
+
}
|
|
2650
|
+
/**
|
|
2651
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2652
|
+
* via the `definition` "formScalarConfig".
|
|
2653
|
+
*/
|
|
2654
|
+
export interface FormScalarConfigV3_66_0 {
|
|
2655
|
+
widget: string;
|
|
2656
|
+
}
|
|
2657
|
+
/**
|
|
2658
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2659
|
+
* via the `definition` "formObjectConfig".
|
|
2660
|
+
*/
|
|
2661
|
+
export interface FormObjectConfigV3_66_0 {
|
|
2662
|
+
widget?: string;
|
|
2663
|
+
order?: string[];
|
|
2664
|
+
properties?: {
|
|
2665
|
+
[k: string]: FormConfigV3_66_0;
|
|
2666
|
+
};
|
|
2667
|
+
}
|
|
2668
|
+
/**
|
|
2669
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2670
|
+
* via the `definition` "formArrayConfig".
|
|
2671
|
+
*/
|
|
2672
|
+
export interface FormArrayConfigV3_66_0 {
|
|
2673
|
+
widget: string;
|
|
2674
|
+
items: FormConfigV3_66_0;
|
|
2675
|
+
}
|
|
2676
|
+
/**
|
|
2677
|
+
* For use with a custom auth handler on a service provider.
|
|
2678
|
+
*
|
|
2679
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2680
|
+
* via the `definition` "customAuthentication".
|
|
2681
|
+
*/
|
|
2682
|
+
export interface CustomAuthenticationV3_66_0 {
|
|
2683
|
+
type: 'custom';
|
|
2684
|
+
[k: string]: any;
|
|
2685
|
+
}
|
|
2686
|
+
/**
|
|
2687
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2688
|
+
* via the `definition` "searchParamsAuthentication".
|
|
2689
|
+
*/
|
|
2690
|
+
export interface SearchParamsAuthenticationV3_66_0 {
|
|
2691
|
+
type: 'searchParams';
|
|
2692
|
+
params: {
|
|
2693
|
+
name: string;
|
|
2694
|
+
value: string;
|
|
2695
|
+
}[];
|
|
2696
|
+
}
|
|
2697
|
+
/**
|
|
2698
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2699
|
+
* via the `definition` "bearerAuthentication".
|
|
2700
|
+
*/
|
|
2701
|
+
export interface BearerAuthenticationV3_66_0 {
|
|
2702
|
+
type: 'bearer';
|
|
2703
|
+
token: string;
|
|
2704
|
+
prefix?: string;
|
|
2705
|
+
header?: string;
|
|
2706
|
+
}
|
|
2707
|
+
/**
|
|
2708
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2709
|
+
* via the `definition` "oauth2BearerAuthentication".
|
|
2710
|
+
*/
|
|
2711
|
+
export interface OAuth2BearerAuthenticationV3_66_0 {
|
|
2712
|
+
type: 'oauth2Bearer';
|
|
2713
|
+
token: string;
|
|
2714
|
+
prefix?: string;
|
|
2715
|
+
header?: string;
|
|
2716
|
+
scope?: string;
|
|
2717
|
+
expiresAt?: string;
|
|
2718
|
+
}
|
|
2719
|
+
/**
|
|
2720
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2721
|
+
* via the `definition` "basicAuthentication".
|
|
2722
|
+
*/
|
|
2723
|
+
export interface BasicAuthenticationV3_66_0 {
|
|
2724
|
+
type: 'basic';
|
|
2725
|
+
username: string;
|
|
2726
|
+
password: string;
|
|
2727
|
+
useIso8859?: boolean;
|
|
2728
|
+
}
|
|
2729
|
+
/**
|
|
2730
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2731
|
+
* via the `definition` "oauth2Authentication".
|
|
2732
|
+
*/
|
|
2733
|
+
export interface OAuth2AuthenticationV3_66_0 {
|
|
2734
|
+
type: 'oauth2';
|
|
2735
|
+
grantType: 'authorizationCode' | 'clientCredentials';
|
|
2736
|
+
authorizationUrl?: string;
|
|
2737
|
+
accessTokenUrl?: string;
|
|
2738
|
+
clientId: string;
|
|
2739
|
+
clientSecret?: string;
|
|
2740
|
+
scope?: string;
|
|
2741
|
+
usePkce?: boolean;
|
|
2742
|
+
redirectUrl?: string;
|
|
2743
|
+
headerPrefix?: string;
|
|
2744
|
+
audience?: string;
|
|
2745
|
+
resource?: string;
|
|
2746
|
+
}
|
|
2747
|
+
/**
|
|
2748
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2749
|
+
* via the `definition` "awsAuthentication".
|
|
2750
|
+
*/
|
|
2751
|
+
export interface AWSAuthenticationV3_66_0 {
|
|
2752
|
+
type: 'aws';
|
|
2753
|
+
awsAccessKeyId: string;
|
|
2754
|
+
awsSecretAccessKey: string;
|
|
2755
|
+
}
|
|
2756
|
+
/**
|
|
2757
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2758
|
+
* via the `definition` "googleAuthentication".
|
|
2759
|
+
*/
|
|
2760
|
+
export interface GoogleAuthenticationV3_66_0 {
|
|
2761
|
+
type: 'google';
|
|
2762
|
+
clientEmail: string;
|
|
2763
|
+
privateKey: string;
|
|
2764
|
+
}
|
|
2765
|
+
/**
|
|
2766
|
+
* This interface was referenced by `ProjectSchemaJSONV3_66_0`'s JSON-Schema
|
|
2767
|
+
* via the `definition` "serviceConfig".
|
|
2768
|
+
*/
|
|
2769
|
+
export interface ServiceConfigV3_66_0 {
|
|
2770
|
+
/**
|
|
2771
|
+
* Machine-readable identifier, should typically be the same as the property name on the services object.
|
|
2772
|
+
*/
|
|
2773
|
+
id: string;
|
|
2774
|
+
/**
|
|
2775
|
+
* Human-readable name for this service.
|
|
2776
|
+
*/
|
|
2777
|
+
title: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* The service provider id.
|
|
2780
|
+
*/
|
|
2781
|
+
provider: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* A namespace to use for the imported types tied to this service.
|
|
2784
|
+
*/
|
|
2785
|
+
namespace?: string;
|
|
2786
|
+
serviceType: ServiceTypeV3_66_0;
|
|
2787
|
+
authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
|
|
2788
|
+
authentication?: ServiceAuthenticationV3_66_0;
|
|
2789
|
+
healthCheck?: ServiceHealthCheckV3_66_0;
|
|
2790
|
+
webhookId?: string;
|
|
2791
|
+
/**
|
|
2792
|
+
* Configuration options passed to and handled by the provider.
|
|
2793
|
+
*/
|
|
2794
|
+
options?: {
|
|
2795
|
+
[k: string]: any;
|
|
2796
|
+
};
|
|
2797
|
+
}
|