-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
intent.proto
1148 lines (953 loc) · 42.9 KB
/
intent.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.dialogflow.v2;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/dialogflow/v2/context.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/struct.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.V2";
option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
option java_multiple_files = true;
option java_outer_classname = "IntentProto";
option java_package = "com.google.cloud.dialogflow.v2";
option objc_class_prefix = "DF";
// Service for managing [Intents][google.cloud.dialogflow.v2.Intent].
service Intents {
option (google.api.default_host) = "dialogflow.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/dialogflow";
// Returns the list of all intents in the specified agent.
rpc ListIntents(ListIntentsRequest) returns (ListIntentsResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*/agent}/intents"
additional_bindings {
get: "/v2/{parent=projects/*/locations/*/agent}/intents"
}
additional_bindings {
get: "/v2/{parent=projects/*/agent/environments/*}/intents"
}
additional_bindings {
get: "/v2/{parent=projects/*/locations/*/agent/environments/*}/intents"
}
};
option (google.api.method_signature) = "parent";
option (google.api.method_signature) = "parent,language_code";
}
// Retrieves the specified intent.
rpc GetIntent(GetIntentRequest) returns (Intent) {
option (google.api.http) = {
get: "/v2/{name=projects/*/agent/intents/*}"
additional_bindings {
get: "/v2/{name=projects/*/locations/*/agent/intents/*}"
}
};
option (google.api.method_signature) = "name";
option (google.api.method_signature) = "name,language_code";
}
// Creates an intent in the specified agent.
//
// Note: You should always train an agent prior to sending it queries. See the
// [training
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
rpc CreateIntent(CreateIntentRequest) returns (Intent) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/agent}/intents"
body: "intent"
additional_bindings {
post: "/v2/{parent=projects/*/locations/*/agent}/intents"
body: "intent"
}
};
option (google.api.method_signature) = "parent,intent";
option (google.api.method_signature) = "parent,intent,language_code";
}
// Updates the specified intent.
//
// Note: You should always train an agent prior to sending it queries. See the
// [training
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
rpc UpdateIntent(UpdateIntentRequest) returns (Intent) {
option (google.api.http) = {
patch: "/v2/{intent.name=projects/*/agent/intents/*}"
body: "intent"
additional_bindings {
patch: "/v2/{intent.name=projects/*/locations/*/agent/intents/*}"
body: "intent"
}
};
option (google.api.method_signature) = "intent,language_code";
option (google.api.method_signature) = "intent,language_code,update_mask";
}
// Deletes the specified intent and its direct or indirect followup intents.
//
// Note: You should always train an agent prior to sending it queries. See the
// [training
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
rpc DeleteIntent(DeleteIntentRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/agent/intents/*}"
additional_bindings {
delete: "/v2/{name=projects/*/locations/*/agent/intents/*}"
}
};
option (google.api.method_signature) = "name";
}
// Updates/Creates multiple intents in the specified agent.
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`: An empty [Struct
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
// - `response`:
// [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]
//
// Note: You should always train an agent prior to sending it queries. See the
// [training
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
rpc BatchUpdateIntents(BatchUpdateIntentsRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/agent}/intents:batchUpdate"
body: "*"
additional_bindings {
post: "/v2/{parent=projects/*/locations/*/agent}/intents:batchUpdate"
body: "*"
}
};
option (google.api.method_signature) = "parent,intent_batch_uri";
option (google.api.method_signature) = "parent,intent_batch_inline";
option (google.longrunning.operation_info) = {
response_type: "google.cloud.dialogflow.v2.BatchUpdateIntentsResponse"
metadata_type: "google.protobuf.Struct"
};
}
// Deletes intents in the specified agent.
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`: An empty [Struct
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
// - `response`: An [Empty
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
//
// Note: You should always train an agent prior to sending it queries. See the
// [training
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
rpc BatchDeleteIntents(BatchDeleteIntentsRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/agent}/intents:batchDelete"
body: "*"
additional_bindings {
post: "/v2/{parent=projects/*/locations/*/agent}/intents:batchDelete"
body: "*"
}
};
option (google.api.method_signature) = "parent,intents";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "google.protobuf.Struct"
};
}
}
// An intent categorizes an end-user's intention for one conversation turn. For
// each agent, you define many intents, where your combined intents can handle a
// complete conversation. When an end-user writes or says something, referred to
// as an end-user expression or end-user input, Dialogflow matches the end-user
// input to the best intent in your agent. Matching an intent is also known as
// intent classification.
//
// For more information, see the [intent
// guide](https://cloud.google.com/dialogflow/docs/intents-overview).
message Intent {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/Intent"
pattern: "projects/{project}/agent/intents/{intent}"
pattern: "projects/{project}/locations/{location}/agent/intents/{intent}"
};
// Represents the different states that webhooks can be in.
enum WebhookState {
// Webhook is disabled in the agent and in the intent.
WEBHOOK_STATE_UNSPECIFIED = 0;
// Webhook is enabled in the agent and in the intent.
WEBHOOK_STATE_ENABLED = 1;
// Webhook is enabled in the agent and in the intent. Also, each slot
// filling prompt is forwarded to the webhook.
WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING = 2;
}
// Represents an example that the agent is trained on.
message TrainingPhrase {
// Represents different types of training phrases.
enum Type {
// Not specified. This value should never be used.
TYPE_UNSPECIFIED = 0;
// Examples do not contain @-prefixed entity type names, but example parts
// can be annotated with entity types.
EXAMPLE = 1;
// Templates are not annotated with entity types, but they can contain
// @-prefixed entity type names as substrings.
// Template mode has been deprecated. Example mode is the only supported
// way to create new training phrases. If you have existing training
// phrases that you've created in template mode, those will continue to
// work.
TEMPLATE = 2 [deprecated = true];
}
// Represents a part of a training phrase.
message Part {
// Required. The text for this part.
string text = 1;
// Optional. The entity type name prefixed with `@`.
// This field is required for annotated parts of the training phrase.
string entity_type = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The parameter name for the value extracted from the
// annotated part of the example.
// This field is required for annotated parts of the training phrase.
string alias = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether the text was manually annotated.
// This field is set to true when the Dialogflow Console is used to
// manually annotate the part. When creating an annotated part with the
// API, you must set this to true.
bool user_defined = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Output only. The unique identifier of this training phrase.
string name = 1;
// Required. The type of the training phrase.
Type type = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ordered list of training phrase parts.
// The parts are concatenated in order to form the training phrase.
//
// Note: The API does not automatically annotate training phrases like the
// Dialogflow Console does.
//
// Note: Do not forget to include whitespace at part boundaries,
// so the training phrase is well formatted when the parts are concatenated.
//
// If the training phrase does not need to be annotated with parameters,
// you just need a single part with only the
// [Part.text][google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part.text]
// field set.
//
// If you want to annotate the training phrase, you must create multiple
// parts, where the fields of each part are populated in one of two ways:
//
// - `Part.text` is set to a part of the phrase that has no parameters.
// - `Part.text` is set to a part of the phrase that you want to annotate,
// and the `entity_type`, `alias`, and `user_defined` fields are all
// set.
repeated Part parts = 3 [(google.api.field_behavior) = REQUIRED];
// Optional. Indicates how many times this example was added to
// the intent. Each time a developer adds an existing sample by editing an
// intent or training, this counter is increased.
int32 times_added_count = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Represents intent parameters.
message Parameter {
// The unique identifier of this parameter.
string name = 1;
// Required. The name of the parameter.
string display_name = 2;
// Optional. The definition of the parameter value. It can be:
//
// - a constant string,
// - a parameter value defined as `$parameter_name`,
// - an original parameter value defined as `$parameter_name.original`,
// - a parameter value from some context defined as
// `#context_name.parameter_name`.
string value = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The default value to use when the `value` yields an empty
// result.
// Default values can be extracted from contexts by using the following
// syntax: `#context_name.parameter_name`.
string default_value = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The name of the entity type, prefixed with `@`, that
// describes values of the parameter. If the parameter is
// required, this must be provided.
string entity_type_display_name = 5
[(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether the parameter is required. That is,
// whether the intent cannot be completed without collecting the parameter
// value.
bool mandatory = 6 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of prompts that the agent can present to the
// user in order to collect a value for the parameter.
repeated string prompts = 7 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether the parameter represents a list of values.
bool is_list = 8 [(google.api.field_behavior) = OPTIONAL];
}
// A rich response message.
// Corresponds to the intent `Response` field in the Dialogflow console.
// For more information, see
// [Rich response
// messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
message Message {
// The rich response message integration platform. See
// [Integrations](https://cloud.google.com/dialogflow/docs/integrations).
enum Platform {
// Default platform.
PLATFORM_UNSPECIFIED = 0;
// Facebook.
FACEBOOK = 1;
// Slack.
SLACK = 2;
// Telegram.
TELEGRAM = 3;
// Kik.
KIK = 4;
// Skype.
SKYPE = 5;
// Line.
LINE = 6;
// Viber.
VIBER = 7;
// Google Assistant
// See [Dialogflow webhook
// format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
ACTIONS_ON_GOOGLE = 8;
// Google Hangouts.
GOOGLE_HANGOUTS = 11;
}
// The text response message.
message Text {
// Optional. The collection of the agent's responses.
repeated string text = 1 [(google.api.field_behavior) = OPTIONAL];
}
// The image response message.
message Image {
// Optional. The public URI to an image file.
string image_uri = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. A text description of the image to be used for accessibility,
// e.g., screen readers.
string accessibility_text = 2 [(google.api.field_behavior) = OPTIONAL];
}
// The quick replies response message.
message QuickReplies {
// Optional. The title of the collection of quick replies.
string title = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of quick replies.
repeated string quick_replies = 2
[(google.api.field_behavior) = OPTIONAL];
}
// The card response message.
message Card {
// Contains information about a button.
message Button {
// Optional. The text to show on the button.
string text = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The text to send back to the Dialogflow API or a URI to
// open.
string postback = 2 [(google.api.field_behavior) = OPTIONAL];
}
// Optional. The title of the card.
string title = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The subtitle of the card.
string subtitle = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The public URI to an image file for the card.
string image_uri = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of card buttons.
repeated Button buttons = 4 [(google.api.field_behavior) = OPTIONAL];
}
// The simple response message containing speech or text.
message SimpleResponse {
// One of text_to_speech or ssml must be provided. The plain text of the
// speech output. Mutually exclusive with ssml.
string text_to_speech = 1;
// One of text_to_speech or ssml must be provided. Structured spoken
// response to the user in the SSML format. Mutually exclusive with
// text_to_speech.
string ssml = 2;
// Optional. The text to display.
string display_text = 3 [(google.api.field_behavior) = OPTIONAL];
}
// The collection of simple response candidates.
// This message in `QueryResult.fulfillment_messages` and
// `WebhookResponse.fulfillment_messages` should contain only one
// `SimpleResponse`.
message SimpleResponses {
// Required. The list of simple responses.
repeated SimpleResponse simple_responses = 1
[(google.api.field_behavior) = REQUIRED];
}
// The basic card message. Useful for displaying information.
message BasicCard {
// The button object that appears at the bottom of a card.
message Button {
// Opens the given URI.
message OpenUriAction {
// Required. The HTTP or HTTPS scheme URI.
string uri = 1;
}
// Required. The title of the button.
string title = 1;
// Required. Action to take when a user taps on the button.
OpenUriAction open_uri_action = 2
[(google.api.field_behavior) = REQUIRED];
}
// Optional. The title of the card.
string title = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The subtitle of the card.
string subtitle = 2 [(google.api.field_behavior) = OPTIONAL];
// Required, unless image is present. The body text of the card.
string formatted_text = 3;
// Optional. The image for the card.
Image image = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of card buttons.
repeated Button buttons = 5 [(google.api.field_behavior) = OPTIONAL];
}
// The suggestion chip message that the user can tap to quickly post a reply
// to the conversation.
message Suggestion {
// Required. The text shown the in the suggestion chip.
string title = 1 [(google.api.field_behavior) = REQUIRED];
}
// The collection of suggestions.
message Suggestions {
// Required. The list of suggested replies.
repeated Suggestion suggestions = 1
[(google.api.field_behavior) = REQUIRED];
}
// The suggestion chip message that allows the user to jump out to the app
// or website associated with this agent.
message LinkOutSuggestion {
// Required. The name of the app or site this chip is linking to.
string destination_name = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The URI of the app or site to open when the user taps the
// suggestion chip.
string uri = 2 [(google.api.field_behavior) = REQUIRED];
}
// The card for presenting a list of options to select from.
message ListSelect {
// An item in the list.
message Item {
// Required. Additional information about this option.
SelectItemInfo info = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The title of the list item.
string title = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. The main text describing the item.
string description = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The image to display.
Image image = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Optional. The overall title of the list.
string title = 1 [(google.api.field_behavior) = OPTIONAL];
// Required. List items.
repeated Item items = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Subtitle of the list.
string subtitle = 3 [(google.api.field_behavior) = OPTIONAL];
}
// The card for presenting a carousel of options to select from.
message CarouselSelect {
// An item in the carousel.
message Item {
// Required. Additional info about the option item.
SelectItemInfo info = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Title of the carousel item.
string title = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. The body text of the card.
string description = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The image to display.
Image image = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Required. Carousel items.
repeated Item items = 1 [(google.api.field_behavior) = REQUIRED];
}
// Additional info about the select item for when it is triggered in a
// dialog.
message SelectItemInfo {
// Required. A unique key that will be sent back to the agent if this
// response is given.
string key = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A list of synonyms that can also be used to trigger this
// item in dialog.
repeated string synonyms = 2 [(google.api.field_behavior) = OPTIONAL];
}
// The media content card for Actions on Google.
message MediaContent {
// Format of response media type.
enum ResponseMediaType {
// Unspecified.
RESPONSE_MEDIA_TYPE_UNSPECIFIED = 0;
// Response media type is audio.
AUDIO = 1;
}
// Response media object for media content card.
message ResponseMediaObject {
// Required. Name of media card.
string name = 1;
// Optional. Description of media card.
string description = 2 [(google.api.field_behavior) = OPTIONAL];
// Image to show with the media card.
oneof image {
// Optional. Image to display above media content.
Image large_image = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Icon to display above media content.
Image icon = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Required. Url where the media is stored.
string content_url = 5;
}
// Optional. What type of media is the content (ie "audio").
ResponseMediaType media_type = 1 [(google.api.field_behavior) = OPTIONAL];
// Required. List of media objects.
repeated ResponseMediaObject media_objects = 2;
}
// Browse Carousel Card for Actions on Google.
// https://developers.google.com/actions/assistant/responses#browsing_carousel
message BrowseCarouselCard {
// Browsing carousel tile
message BrowseCarouselCardItem {
// Actions on Google action to open a given url.
message OpenUrlAction {
// Type of the URI.
enum UrlTypeHint {
// Unspecified
URL_TYPE_HINT_UNSPECIFIED = 0;
// Url would be an amp action
AMP_ACTION = 1;
// URL that points directly to AMP content, or to a canonical URL
// which refers to AMP content via <link rel="amphtml">.
AMP_CONTENT = 2;
}
// Required. URL
string url = 1;
// Optional. Specifies the type of viewer that is used when opening
// the URL. Defaults to opening via web browser.
UrlTypeHint url_type_hint = 3
[(google.api.field_behavior) = OPTIONAL];
}
// Required. Action to present to the user.
OpenUrlAction open_uri_action = 1;
// Required. Title of the carousel item. Maximum of two lines of text.
string title = 2;
// Optional. Description of the carousel item. Maximum of four lines of
// text.
string description = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Hero image for the carousel item.
Image image = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Text that appears at the bottom of the Browse Carousel
// Card. Maximum of one line of text.
string footer = 5 [(google.api.field_behavior) = OPTIONAL];
}
// Image display options for Actions on Google. This should be used for
// when the image's aspect ratio does not match the image container's
// aspect ratio.
enum ImageDisplayOptions {
// Fill the gaps between the image and the image container with gray
// bars.
IMAGE_DISPLAY_OPTIONS_UNSPECIFIED = 0;
// Fill the gaps between the image and the image container with gray
// bars.
GRAY = 1;
// Fill the gaps between the image and the image container with white
// bars.
WHITE = 2;
// Image is scaled such that the image width and height match or exceed
// the container dimensions. This may crop the top and bottom of the
// image if the scaled image height is greater than the container
// height, or crop the left and right of the image if the scaled image
// width is greater than the container width. This is similar to "Zoom
// Mode" on a widescreen TV when playing a 4:3 video.
CROPPED = 3;
// Pad the gaps between image and image frame with a blurred copy of the
// same image.
BLURRED_BACKGROUND = 4;
}
// Required. List of items in the Browse Carousel Card. Minimum of two
// items, maximum of ten.
repeated BrowseCarouselCardItem items = 1;
// Optional. Settings for displaying the image. Applies to every image in
// [items][google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.items].
ImageDisplayOptions image_display_options = 2
[(google.api.field_behavior) = OPTIONAL];
}
// Table card for Actions on Google.
message TableCard {
// Required. Title of the card.
string title = 1;
// Optional. Subtitle to the title.
string subtitle = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Image which should be displayed on the card.
Image image = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Display properties for the columns in this table.
repeated ColumnProperties column_properties = 4
[(google.api.field_behavior) = OPTIONAL];
// Optional. Rows in this table of data.
repeated TableCardRow rows = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. List of buttons for the card.
repeated BasicCard.Button buttons = 6
[(google.api.field_behavior) = OPTIONAL];
}
// Column properties for
// [TableCard][google.cloud.dialogflow.v2.Intent.Message.TableCard].
message ColumnProperties {
// Text alignments within a cell.
enum HorizontalAlignment {
// Text is aligned to the leading edge of the column.
HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0;
// Text is aligned to the leading edge of the column.
LEADING = 1;
// Text is centered in the column.
CENTER = 2;
// Text is aligned to the trailing edge of the column.
TRAILING = 3;
}
// Required. Column heading.
string header = 1;
// Optional. Defines text alignment for all cells in this column.
HorizontalAlignment horizontal_alignment = 2
[(google.api.field_behavior) = OPTIONAL];
}
// Row of [TableCard][google.cloud.dialogflow.v2.Intent.Message.TableCard].
message TableCardRow {
// Optional. List of cells that make up this row.
repeated TableCardCell cells = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Whether to add a visual divider after this row.
bool divider_after = 2 [(google.api.field_behavior) = OPTIONAL];
}
// Cell of
// [TableCardRow][google.cloud.dialogflow.v2.Intent.Message.TableCardRow].
message TableCardCell {
// Required. Text in this cell.
string text = 1;
}
// Required. The rich response message.
oneof message {
// The text response.
Text text = 1;
// The image response.
Image image = 2;
// The quick replies response.
QuickReplies quick_replies = 3;
// The card response.
Card card = 4;
// A custom platform-specific response.
google.protobuf.Struct payload = 5;
// The voice and text-only responses for Actions on Google.
SimpleResponses simple_responses = 7;
// The basic card response for Actions on Google.
BasicCard basic_card = 8;
// The suggestion chips for Actions on Google.
Suggestions suggestions = 9;
// The link out suggestion chip for Actions on Google.
LinkOutSuggestion link_out_suggestion = 10;
// The list card response for Actions on Google.
ListSelect list_select = 11;
// The carousel card response for Actions on Google.
CarouselSelect carousel_select = 12;
// Browse carousel card for Actions on Google.
BrowseCarouselCard browse_carousel_card = 22;
// Table card for Actions on Google.
TableCard table_card = 23;
// The media content card for Actions on Google.
MediaContent media_content = 24;
}
// Optional. The platform that this message is intended for.
Platform platform = 6 [(google.api.field_behavior) = OPTIONAL];
}
// Represents a single followup intent in the chain.
message FollowupIntentInfo {
// The unique identifier of the followup intent.
// Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string followup_intent_name = 1;
// The unique identifier of the followup intent's parent.
// Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string parent_followup_intent_name = 2;
}
// Optional. The unique identifier of this intent.
// Required for
// [Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent] and
// [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents]
// methods.
// Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string name = 1 [(google.api.field_behavior) = OPTIONAL];
// Required. The name of this intent.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Indicates whether webhooks are enabled for the intent.
WebhookState webhook_state = 6 [(google.api.field_behavior) = OPTIONAL];
// Optional. The priority of this intent. Higher numbers represent higher
// priorities.
//
// - If the supplied value is unspecified or 0, the service
// translates the value to 500,000, which corresponds to the
// `Normal` priority in the console.
// - If the supplied value is negative, the intent is ignored
// in runtime detect intent requests.
int32 priority = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether this is a fallback intent.
bool is_fallback = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether Machine Learning is disabled for the intent.
// Note: If `ml_disabled` setting is set to true, then this intent is not
// taken into account during inference in `ML ONLY` match mode. Also,
// auto-markup in the UI is turned off.
bool ml_disabled = 19 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates that a live agent should be brought in to handle the
// interaction with the user. In most cases, when you set this flag to true,
// you would also want to set end_interaction to true as well. Default is
// false.
bool live_agent_handoff = 20 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates that this intent ends an interaction. Some integrations
// (e.g., Actions on Google or Dialogflow phone gateway) use this information
// to close interaction with an end user. Default is false.
bool end_interaction = 21 [(google.api.field_behavior) = OPTIONAL];
// Optional. The list of context names required for this intent to be
// triggered.
// Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
repeated string input_context_names = 7
[(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of event names that trigger the intent.
// If the collection of input contexts is not empty, all of the contexts must
// be present in the active user session for an event to trigger this intent.
// Event names are limited to 150 characters.
repeated string events = 8 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of examples that the agent is
// trained on.
repeated TrainingPhrase training_phrases = 9
[(google.api.field_behavior) = OPTIONAL];
// Optional. The name of the action associated with the intent.
// Note: The action name must not contain whitespaces.
string action = 10 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of contexts that are activated when the intent
// is matched. Context messages in this collection should not set the
// parameters field. Setting the `lifespan_count` to 0 will reset the context
// when the intent is matched.
// Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
repeated Context output_contexts = 11
[(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether to delete all contexts in the current
// session when this intent is matched.
bool reset_contexts = 12 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of parameters associated with the intent.
repeated Parameter parameters = 13 [(google.api.field_behavior) = OPTIONAL];
// Optional. The collection of rich messages corresponding to the
// `Response` field in the Dialogflow console.
repeated Message messages = 14 [(google.api.field_behavior) = OPTIONAL];
// Optional. The list of platforms for which the first responses will be
// copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
repeated Message.Platform default_response_platforms = 15
[(google.api.field_behavior) = OPTIONAL];
// Output only.
// Read-only. The unique identifier of the root intent in the chain of
// followup intents. It identifies the correct followup intents chain for
// this intent. We populate this field only in the output.
//
// Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string root_followup_intent_name = 16
[(google.api.field_behavior) = OUTPUT_ONLY];
// Read-only after creation. The unique identifier of the parent intent in the
// chain of followup intents. You can set this field when creating an intent,
// for example with
// [CreateIntent][google.cloud.dialogflow.v2.Intents.CreateIntent] or
// [BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents],
// in order to make this intent a followup intent.
//
// It identifies the parent followup intent.
// Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string parent_followup_intent_name = 17;
// Output only. Read-only. Information about all followup intents that have
// this intent as a direct or indirect parent. We populate this field only in
// the output.
repeated FollowupIntentInfo followup_intent_info = 18
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// The request message for
// [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
message ListIntentsRequest {
// Required. The agent to list all intents from.
// Format: `projects/<Project ID>/agent` or `projects/<Project
// ID>/locations/<Location ID>/agent`.
//
// Alternatively, you can specify the environment to list intents for.
// Format: `projects/<Project ID>/agent/environments/<Environment ID>`
// or `projects/<Project ID>/locations/<Location
// ID>/agent/environments/<Environment ID>`.
// Note: training phrases of the intents will not be returned for non-draft
// environment.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "dialogflow.googleapis.com/Intent"
}
];
// Optional. The language used to access language-specific data.
// If not specified, the agent's default language is used.
// For more information, see
// [Multilingual intent and entity
// data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
string language_code = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The resource view to apply to the returned intent.
IntentView intent_view = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The maximum number of items to return in a single page. By
// default 100 and at most 1000.
int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The next_page_token value returned from a previous list request.
string page_token = 5 [(google.api.field_behavior) = OPTIONAL];
}
// The response message for
// [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
message ListIntentsResponse {
// The list of agent intents. There will be a maximum number of items
// returned based on the page_size field in the request.
repeated Intent intents = 1;
// Token to retrieve the next page of results, or empty if there are no
// more results in the list.
string next_page_token = 2;
}
// The request message for
// [Intents.GetIntent][google.cloud.dialogflow.v2.Intents.GetIntent].
message GetIntentRequest {
// Required. The name of the intent.
// Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/Intent"
}
];