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