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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dialogflow_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.changelogs.html">changelogs()</a></code>
</p>
<p class="firstline">Returns the changelogs Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.entityTypes.html">entityTypes()</a></code>
</p>
<p class="firstline">Returns the entityTypes Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.environments.html">environments()</a></code>
</p>
<p class="firstline">Returns the environments Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.flows.html">flows()</a></code>
</p>
<p class="firstline">Returns the flows Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.generators.html">generators()</a></code>
</p>
<p class="firstline">Returns the generators Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.intents.html">intents()</a></code>
</p>
<p class="firstline">Returns the intents Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.playbooks.html">playbooks()</a></code>
</p>
<p class="firstline">Returns the playbooks Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.sessions.html">sessions()</a></code>
</p>
<p class="firstline">Returns the sessions Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.testCases.html">testCases()</a></code>
</p>
<p class="firstline">Returns the testCases Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.tools.html">tools()</a></code>
</p>
<p class="firstline">Returns the tools Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.transitionRouteGroups.html">transitionRouteGroups()</a></code>
</p>
<p class="firstline">Returns the transitionRouteGroups Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v3.projects.locations.agents.webhooks.html">webhooks()</a></code>
</p>
<p class="firstline">Returns the webhooks Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified agent.</p>
<p class="toc_element">
<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports the specified agent to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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`: ExportAgentResponse</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified agent.</p>
<p class="toc_element">
<code><a href="#getGenerativeSettings">getGenerativeSettings(name, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the generative settings for the agent.</p>
<p class="toc_element">
<code><a href="#getValidationResult">getValidationResult(name, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all agents in the specified location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified agent. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).</p>
<p class="toc_element">
<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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 flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).</p>
<p class="toc_element">
<code><a href="#updateGenerativeSettings">updateGenerativeSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the generative settings for the agent.</p>
<p class="toc_element">
<code><a href="#validate">validate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Args:
parent: string, Required. The location to create a agent for. Format: `projects//locations/`. (required)
body: object, The request body.
The object takes the form of:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
"enableInteractionLogging": True or False, # Enables DF Interaction logging.
"enableStackdriverLogging": True or False, # Enables Google Cloud Logging.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
"clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates.
"passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
},
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"satisfiesPzi": True or False, # Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
"satisfiesPzs": True or False, # Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
"startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
"A String",
],
"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
"enableInteractionLogging": True or False, # Enables DF Interaction logging.
"enableStackdriverLogging": True or False, # Enables Google Cloud Logging.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
"clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates.
"passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
},
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"satisfiesPzi": True or False, # Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
"satisfiesPzs": True or False, # Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
"startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
"A String",
],
"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the specified agent.
Args:
name: string, Required. The name of the agent to delete. Format: `projects//locations//agents/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
<pre>Exports the specified agent to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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`: ExportAgentResponse
Args:
name: string, Required. The name of the agent to export. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Agents.ExportAgent.
"agentUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
"dataFormat": "A String", # Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.
"environment": "A String", # Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.
"gitDestination": { # Settings for exporting to a git branch. # Optional. The Git branch to export the agent to.
"commitMessage": "A String", # Commit message for the git push.
"trackingBranch": "A String", # Tracking branch for the git push.
},
"includeBigqueryExportSettings": True or False, # Optional. Whether to include BigQuery Export setting.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the specified agent.
Args:
name: string, Required. The name of the agent. Format: `projects//locations//agents/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
"enableInteractionLogging": True or False, # Enables DF Interaction logging.
"enableStackdriverLogging": True or False, # Enables Google Cloud Logging.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
"clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates.
"passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
},
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"satisfiesPzi": True or False, # Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
"satisfiesPzs": True or False, # Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
"startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
"A String",
],
"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}</pre>
</div>
<div class="method">
<code class="details" id="getGenerativeSettings">getGenerativeSettings(name, languageCode=None, x__xgafv=None)</code>
<pre>Gets the generative settings for the agent.
Args:
name: string, Required. Format: `projects//locations//agents//generativeSettings`. (required)
languageCode: string, Required. Language code of the generative settings.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settings for Generative AI.
"fallbackSettings": { # Settings for Generative Fallback. # Settings for Generative Fallback.
"promptTemplates": [ # Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones.
{ # Prompt template.
"displayName": "A String", # Prompt name.
"frozen": True or False, # If the flag is true, the prompt is frozen and cannot be modified by users.
"promptText": "A String", # Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
},
],
"selectedPrompt": "A String", # Display name of the selected prompt.
},
"generativeSafetySettings": { # Settings for Generative Safety. # Settings for Generative Safety.
"bannedPhrases": [ # Banned phrases for generated text.
{ # Text input which can be used for prompt or banned phrases.
"languageCode": "A String", # Required. Language code of the phrase.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
],
"defaultBannedPhraseMatchStrategy": "A String", # Optional. Default phrase match strategy for banned phrases.
"promptSecuritySettings": { # Settings for prompt security checks. # Optional. Settings for prompt security checks.
"enablePromptSecurity": True or False, # Optional. Enable prompt security checks.
},
},
"knowledgeConnectorSettings": { # Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ". # Settings for knowledge connector.
"agent": "A String", # Name of the virtual agent. Used for LLM prompt. Can be left empty.
"agentIdentity": "A String", # Identity of the agent, e.g. "virtual agent", "AI assistant".
"agentScope": "A String", # Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
"business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
"businessDescription": "A String", # Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
},
"languageCode": "A String", # Language for this settings.
"llmModelSettings": { # Settings for LLM models. # LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # Format: `projects//locations//agents//generativeSettings`.
}</pre>
</div>
<div class="method">
<code class="details" id="getValidationResult">getValidationResult(name, languageCode=None, x__xgafv=None)</code>
<pre>Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
Args:
name: string, Required. The agent name. Format: `projects//locations//agents//validationResult`. (required)
languageCode: string, If not specified, the agent's default language is used.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Agents.GetAgentValidationResult.
"flowValidationResults": [ # Contains all flow validation results.
{ # The response message for Flows.GetFlowValidationResult.
"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
"updateTime": "A String", # Last time the flow was validated.
"validationMessages": [ # Contains all validation messages.
{ # Agent/flow validation message.
"detail": "A String", # The message detail.
"resourceNames": [ # The resource names of the resources where the message is found.
{ # Resource name and display name.
"displayName": "A String", # Display name.
"name": "A String", # Name.
},
],
"resourceType": "A String", # The type of the resources where the message is found.
"resources": [ # The names of the resources where the message is found.
"A String",
],
"severity": "A String", # Indicates the severity of the message.
},
],
},
],
"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of all agents in the specified location.
Args:
parent: string, Required. The location to list all agents for. Format: `projects//locations/`. (required)
pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken: string, The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Agents.ListAgents.
"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
"enableInteractionLogging": True or False, # Enables DF Interaction logging.
"enableStackdriverLogging": True or False, # Enables Google Cloud Logging.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
"clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates.
"passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
},
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"satisfiesPzi": True or False, # Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
"satisfiesPzs": True or False, # Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
"startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
"A String",
],
"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specified agent. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Args:
name: string, The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
"enableInteractionLogging": True or False, # Enables DF Interaction logging.
"enableStackdriverLogging": True or False, # Enables Google Cloud Logging.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
"clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates.
"passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
},
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"satisfiesPzi": True or False, # Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
"satisfiesPzs": True or False, # Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
"startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
"A String",
],
"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
"enableInteractionLogging": True or False, # Enables DF Interaction logging.
"enableStackdriverLogging": True or False, # Enables Google Cloud Logging.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
"clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates.
"passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
},
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"satisfiesPzi": True or False, # Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
"satisfiesPzs": True or False, # Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
"startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
"A String",
],
"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}</pre>
</div>
<div class="method">
<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
<pre>Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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 flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Args:
name: string, Required. The name of the agent to restore into. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Agents.RestoreAgent.
"agentContent": "A String", # Uncompressed raw byte content for agent.
"agentUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
"gitSource": { # Settings for restoring from a git branch # Setting for restoring from a git branch
"trackingBranch": "A String", # tracking branch for the git pull
},
"restoreOption": "A String", # Agent restore mode. If not specified, `KEEP` is assumed.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="updateGenerativeSettings">updateGenerativeSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the generative settings for the agent.
Args:
name: string, Format: `projects//locations//agents//generativeSettings`. (required)
body: object, The request body.
The object takes the form of:
{ # Settings for Generative AI.
"fallbackSettings": { # Settings for Generative Fallback. # Settings for Generative Fallback.
"promptTemplates": [ # Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones.
{ # Prompt template.
"displayName": "A String", # Prompt name.
"frozen": True or False, # If the flag is true, the prompt is frozen and cannot be modified by users.
"promptText": "A String", # Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
},
],
"selectedPrompt": "A String", # Display name of the selected prompt.
},
"generativeSafetySettings": { # Settings for Generative Safety. # Settings for Generative Safety.
"bannedPhrases": [ # Banned phrases for generated text.
{ # Text input which can be used for prompt or banned phrases.
"languageCode": "A String", # Required. Language code of the phrase.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
],
"defaultBannedPhraseMatchStrategy": "A String", # Optional. Default phrase match strategy for banned phrases.
"promptSecuritySettings": { # Settings for prompt security checks. # Optional. Settings for prompt security checks.
"enablePromptSecurity": True or False, # Optional. Enable prompt security checks.
},
},
"knowledgeConnectorSettings": { # Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ". # Settings for knowledge connector.
"agent": "A String", # Name of the virtual agent. Used for LLM prompt. Can be left empty.
"agentIdentity": "A String", # Identity of the agent, e.g. "virtual agent", "AI assistant".
"agentScope": "A String", # Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
"business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
"businessDescription": "A String", # Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
},
"languageCode": "A String", # Language for this settings.
"llmModelSettings": { # Settings for LLM models. # LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # Format: `projects//locations//agents//generativeSettings`.
}
updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settings for Generative AI.
"fallbackSettings": { # Settings for Generative Fallback. # Settings for Generative Fallback.
"promptTemplates": [ # Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones.
{ # Prompt template.
"displayName": "A String", # Prompt name.
"frozen": True or False, # If the flag is true, the prompt is frozen and cannot be modified by users.
"promptText": "A String", # Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
},
],
"selectedPrompt": "A String", # Display name of the selected prompt.
},
"generativeSafetySettings": { # Settings for Generative Safety. # Settings for Generative Safety.
"bannedPhrases": [ # Banned phrases for generated text.
{ # Text input which can be used for prompt or banned phrases.
"languageCode": "A String", # Required. Language code of the phrase.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
],
"defaultBannedPhraseMatchStrategy": "A String", # Optional. Default phrase match strategy for banned phrases.
"promptSecuritySettings": { # Settings for prompt security checks. # Optional. Settings for prompt security checks.
"enablePromptSecurity": True or False, # Optional. Enable prompt security checks.
},
},
"knowledgeConnectorSettings": { # Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ". # Settings for knowledge connector.
"agent": "A String", # Name of the virtual agent. Used for LLM prompt. Can be left empty.
"agentIdentity": "A String", # Identity of the agent, e.g. "virtual agent", "AI assistant".
"agentScope": "A String", # Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
"business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
"businessDescription": "A String", # Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
},
"languageCode": "A String", # Language for this settings.
"llmModelSettings": { # Settings for LLM models. # LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # Format: `projects//locations//agents//generativeSettings`.
}</pre>
</div>
<div class="method">
<code class="details" id="validate">validate(name, body=None, x__xgafv=None)</code>
<pre>Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.
Args:
name: string, Required. The agent to validate. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Agents.ValidateAgent.
"languageCode": "A String", # If not specified, the agent's default language is used.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Agents.GetAgentValidationResult.
"flowValidationResults": [ # Contains all flow validation results.
{ # The response message for Flows.GetFlowValidationResult.
"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
"updateTime": "A String", # Last time the flow was validated.
"validationMessages": [ # Contains all validation messages.
{ # Agent/flow validation message.
"detail": "A String", # The message detail.
"resourceNames": [ # The resource names of the resources where the message is found.
{ # Resource name and display name.
"displayName": "A String", # Display name.
"name": "A String", # Name.
},
],
"resourceType": "A String", # The type of the resources where the message is found.
"resources": [ # The names of the resources where the message is found.
"A String",
],
"severity": "A String", # Indicates the severity of the message.
},
],
},
],
"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
}</pre>
</div>
</body></html>
|
