1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: alpha
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: dialogflowcxflows.dialogflowcx.cnrm.cloud.google.com
13spec:
14 group: dialogflowcx.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: DialogflowCXFlow
19 plural: dialogflowcxflows
20 shortNames:
21 - gcpdialogflowcxflow
22 - gcpdialogflowcxflows
23 singular: dialogflowcxflow
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1alpha1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 description:
62 description: The description of the flow. The maximum length is 500
63 characters. If exceeded, the request is rejected.
64 type: string
65 displayName:
66 description: The human-readable name of the flow.
67 type: string
68 eventHandlers:
69 description: |-
70 A flow's event handlers serve two purposes:
71 They are responsible for handling events (e.g. no match, webhook errors) in the flow.
72 They are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
73 Unlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
74 items:
75 properties:
76 event:
77 description: The name of the event to handle.
78 type: string
79 name:
80 description: The unique identifier of this event handler.
81 type: string
82 targetFlow:
83 description: |-
84 The target flow to transition to.
85 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
86 type: string
87 targetPage:
88 description: |-
89 The target page to transition to.
90 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
91 type: string
92 triggerFulfillment:
93 description: The fulfillment to call when the event occurs.
94 Handling webhook errors with a fulfillment enabled with webhook
95 could cause infinite loop. It is invalid to specify such fulfillment
96 for a handler handling webhooks.
97 properties:
98 messages:
99 description: The list of rich message responses to present
100 to the user.
101 items:
102 properties:
103 text:
104 description: The text response message.
105 properties:
106 allowPlaybackInterruption:
107 description: Whether the playback of this message
108 can be interrupted by the end user's speech
109 and the client can then starts the next Dialogflow
110 request.
111 type: boolean
112 text:
113 description: A collection of text responses.
114 items:
115 type: string
116 type: array
117 type: object
118 type: object
119 type: array
120 returnPartialResponses:
121 description: 'Whether Dialogflow should return currently
122 queued fulfillment response messages in streaming APIs.
123 If a webhook is specified, it happens before Dialogflow
124 invokes webhook. Warning: 1) This flag only affects streaming
125 API. Responses are still queued and returned once in non-streaming
126 API. 2) The flag can be enabled in any fulfillment but
127 only the first 3 partial responses will be returned. You
128 may only want to apply it to fulfillments that have slow
129 webhooks.'
130 type: boolean
131 tag:
132 description: The tag used by the webhook to identify which
133 fulfillment is being called. This field is required if
134 webhook is specified.
135 type: string
136 webhook:
137 description: 'The webhook to call. Format: projects/<Project
138 ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook
139 ID>.'
140 type: string
141 type: object
142 type: object
143 type: array
144 languageCode:
145 description: |-
146 Immutable. The language of the following fields in flow:
147 Flow.event_handlers.trigger_fulfillment.messages
148 Flow.event_handlers.trigger_fulfillment.conditional_cases
149 Flow.transition_routes.trigger_fulfillment.messages
150 Flow.transition_routes.trigger_fulfillment.conditional_cases
151 If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
152 type: string
153 nluSettings:
154 description: NLU related settings of the flow.
155 properties:
156 classificationThreshold:
157 description: |-
158 To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold.
159 If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
160 type: number
161 modelTrainingMode:
162 description: |-
163 Indicates NLU model training mode.
164 * MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
165 * MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values: ["MODEL_TRAINING_MODE_AUTOMATIC", "MODEL_TRAINING_MODE_MANUAL"].
166 type: string
167 modelType:
168 description: |-
169 Indicates the type of NLU model.
170 * MODEL_TYPE_STANDARD: Use standard NLU model.
171 * MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values: ["MODEL_TYPE_STANDARD", "MODEL_TYPE_ADVANCED"].
172 type: string
173 type: object
174 parent:
175 description: |-
176 Immutable. The agent to create a flow for.
177 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
178 type: string
179 resourceID:
180 description: Immutable. Optional. The service-generated name of the
181 resource. Used for acquisition only. Leave unset to create a new
182 resource.
183 type: string
184 transitionRouteGroups:
185 description: |-
186 A flow's transition route group serve two purposes:
187 They are responsible for matching the user's first utterances in the flow.
188 They are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.
189 Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>.
190 items:
191 type: string
192 type: array
193 transitionRoutes:
194 description: |-
195 A flow's transition routes serve two purposes:
196 They are responsible for matching the user's first utterances in the flow.
197 They are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
198
199 TransitionRoutes are evalauted in the following order:
200 TransitionRoutes with intent specified.
201 TransitionRoutes with only condition specified.
202 TransitionRoutes with intent specified are inherited by pages in the flow.
203 items:
204 properties:
205 condition:
206 description: |-
207 The condition to evaluate against form parameters or session parameters.
208 At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
209 type: string
210 intent:
211 description: |-
212 The unique identifier of an Intent.
213 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
214 type: string
215 name:
216 description: The unique identifier of this transition route.
217 type: string
218 targetFlow:
219 description: |-
220 The target flow to transition to.
221 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
222 type: string
223 targetPage:
224 description: |-
225 The target page to transition to.
226 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
227 type: string
228 triggerFulfillment:
229 description: The fulfillment to call when the condition is satisfied.
230 At least one of triggerFulfillment and target must be specified.
231 When both are defined, triggerFulfillment is executed first.
232 properties:
233 messages:
234 description: The list of rich message responses to present
235 to the user.
236 items:
237 properties:
238 text:
239 description: The text response message.
240 properties:
241 allowPlaybackInterruption:
242 description: Whether the playback of this message
243 can be interrupted by the end user's speech
244 and the client can then starts the next Dialogflow
245 request.
246 type: boolean
247 text:
248 description: A collection of text responses.
249 items:
250 type: string
251 type: array
252 type: object
253 type: object
254 type: array
255 returnPartialResponses:
256 description: 'Whether Dialogflow should return currently
257 queued fulfillment response messages in streaming APIs.
258 If a webhook is specified, it happens before Dialogflow
259 invokes webhook. Warning: 1) This flag only affects streaming
260 API. Responses are still queued and returned once in non-streaming
261 API. 2) The flag can be enabled in any fulfillment but
262 only the first 3 partial responses will be returned. You
263 may only want to apply it to fulfillments that have slow
264 webhooks.'
265 type: boolean
266 tag:
267 description: The tag used by the webhook to identify which
268 fulfillment is being called. This field is required if
269 webhook is specified.
270 type: string
271 webhook:
272 description: 'The webhook to call. Format: projects/<Project
273 ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook
274 ID>.'
275 type: string
276 type: object
277 type: object
278 type: array
279 required:
280 - displayName
281 type: object
282 status:
283 properties:
284 conditions:
285 description: Conditions represent the latest available observation
286 of the resource's current state.
287 items:
288 properties:
289 lastTransitionTime:
290 description: Last time the condition transitioned from one status
291 to another.
292 type: string
293 message:
294 description: Human-readable message indicating details about
295 last transition.
296 type: string
297 reason:
298 description: Unique, one-word, CamelCase reason for the condition's
299 last transition.
300 type: string
301 status:
302 description: Status is the status of the condition. Can be True,
303 False, Unknown.
304 type: string
305 type:
306 description: Type is the type of the condition.
307 type: string
308 type: object
309 type: array
310 name:
311 description: |-
312 The unique identifier of the flow.
313 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
314 type: string
315 observedGeneration:
316 description: ObservedGeneration is the generation of the resource
317 that was most recently observed by the Config Connector controller.
318 If this is equal to metadata.generation, then that means that the
319 current reported status reflects the most recent desired state of
320 the resource.
321 type: integer
322 type: object
323 required:
324 - spec
325 type: object
326 served: true
327 storage: true
328 subresources:
329 status: {}
330status:
331 acceptedNames:
332 kind: ""
333 plural: ""
334 conditions: []
335 storedVersions: []
View as plain text