google-cloud-dialogflow-cx-v3 0.20.0 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +2 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +6 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +4 -0
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +200 -1
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +10 -1
  7. data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +19 -0
  8. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +338 -0
  9. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +75 -0
  10. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +119 -0
  11. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +10 -1
  12. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +36 -0
  13. data/lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.rb +45 -0
  14. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +10 -1
  15. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +36 -0
  16. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +10 -1
  17. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +84 -0
  18. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +10 -1
  19. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +10 -1
  20. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +184 -0
  21. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +75 -0
  22. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +10 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +116 -0
  24. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +3 -1
  25. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +10 -1
  26. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +10 -1
  27. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +185 -0
  28. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +75 -0
  29. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +3 -1
  30. data/lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb +51 -0
  31. data/lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb +2 -2
  32. data/lib/google/cloud/dialogflow/cx/v3/inline_pb.rb +47 -0
  33. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +13 -1
  34. data/lib/google/cloud/dialogflow/cx/v3/intent_services_pb.rb +22 -0
  35. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +278 -1
  36. data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +781 -0
  37. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +338 -0
  38. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +892 -0
  39. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +120 -0
  40. data/lib/google/cloud/dialogflow/cx/v3/intents/rest.rb +1 -0
  41. data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -0
  42. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +6 -1
  43. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +10 -1
  44. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +84 -0
  45. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +2 -1
  46. data/lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb +47 -0
  47. data/lib/google/cloud/dialogflow/cx/v3/security_settings_pb.rb +2 -1
  48. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +10 -1
  49. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +84 -0
  50. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +10 -1
  51. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +84 -0
  52. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +3 -1
  53. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -1
  54. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +48 -0
  55. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +10 -1
  56. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +10 -1
  57. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +228 -0
  58. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +75 -0
  59. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +10 -1
  60. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +84 -0
  61. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +1 -1
  62. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  63. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +10 -1
  64. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +10 -1
  65. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +130 -0
  66. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +75 -0
  67. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +10 -1
  68. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +84 -0
  69. data/proto_docs/google/api/field_behavior.rb +14 -0
  70. data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +28 -0
  71. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +44 -0
  72. data/proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb +61 -0
  73. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +7 -0
  74. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +11 -0
  75. data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb +109 -0
  76. data/proto_docs/google/cloud/dialogflow/cx/v3/import_strategy.rb +1 -1
  77. data/proto_docs/google/cloud/dialogflow/cx/v3/inline.rb +49 -0
  78. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +175 -0
  79. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +52 -2
  80. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +14 -0
  81. data/proto_docs/google/cloud/dialogflow/cx/v3/safety_settings.rb +49 -0
  82. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +17 -2
  83. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +11 -1
  84. data/proto_docs/google/cloud/dialogflow/cx/v3/validation_message.rb +3 -0
  85. metadata +15 -5
@@ -0,0 +1,109 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dialogflow
23
+ module CX
24
+ module V3
25
+ # Settings for Generative AI.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
29
+ # ID>/generativeSettings`.
30
+ # @!attribute [rw] fallback_settings
31
+ # @return [::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings]
32
+ # Settings for Generative Fallback.
33
+ # @!attribute [rw] generative_safety_settings
34
+ # @return [::Google::Cloud::Dialogflow::CX::V3::SafetySettings]
35
+ # Settings for Generative Safety.
36
+ # @!attribute [rw] knowledge_connector_settings
37
+ # @return [::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::KnowledgeConnectorSettings]
38
+ # Settings for knowledge connector.
39
+ # @!attribute [rw] language_code
40
+ # @return [::String]
41
+ # Language for this settings.
42
+ class GenerativeSettings
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
+
46
+ # Settings for Generative Fallback.
47
+ # @!attribute [rw] selected_prompt
48
+ # @return [::String]
49
+ # Display name of the selected prompt.
50
+ # @!attribute [rw] prompt_templates
51
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
52
+ # Stored prompts that can be selected, for example default templates like
53
+ # "conservative" or "chatty", or user defined ones.
54
+ class FallbackSettings
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+
58
+ # Prompt template.
59
+ # @!attribute [rw] display_name
60
+ # @return [::String]
61
+ # Prompt name.
62
+ # @!attribute [rw] prompt_text
63
+ # @return [::String]
64
+ # Prompt text that is sent to a LLM on no-match default, placeholders are
65
+ # filled downstream. For example: "Here is a conversation $conversation,
66
+ # a response is: "
67
+ # @!attribute [rw] frozen
68
+ # @return [::Boolean]
69
+ # If the flag is true, the prompt is frozen and cannot be modified by
70
+ # users.
71
+ class PromptTemplate
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+ end
76
+
77
+ # Settings for knowledge connector. These parameters are used for LLM prompt
78
+ # like "You are <agent>. You are a helpful and verbose <agent_identity> at
79
+ # <business>, <business_description>. Your task is to help humans on
80
+ # <agent_scope>".
81
+ # @!attribute [rw] business
82
+ # @return [::String]
83
+ # Name of the company, organization or other entity that the agent
84
+ # represents. Used for knowledge connector LLM prompt and for knowledge
85
+ # search.
86
+ # @!attribute [rw] agent
87
+ # @return [::String]
88
+ # Name of the virtual agent. Used for LLM prompt. Can be left empty.
89
+ # @!attribute [rw] agent_identity
90
+ # @return [::String]
91
+ # Identity of the agent, e.g. "virtual agent", "AI assistant".
92
+ # @!attribute [rw] business_description
93
+ # @return [::String]
94
+ # Company description, used for LLM prompt, e.g. "a family company selling
95
+ # freshly roasted coffee beans".
96
+ # @!attribute [rw] agent_scope
97
+ # @return [::String]
98
+ # Agent scope, e.g. "Example company website", "internal Example
99
+ # company website for employees", "manual of car owner".
100
+ class KnowledgeConnectorSettings
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
+ end
104
+ end
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Dialogflow
23
- module Cx
23
+ module CX
24
24
  module V3
25
25
  # Import strategies for the conflict resolution of resources (i.e. intents,
26
26
  # entities, and webhooks) with identical display names during import
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dialogflow
23
+ module CX
24
+ module V3
25
+ # Inline destination for a Dialogflow operation that writes or exports objects
26
+ # (e.g. {::Google::Cloud::Dialogflow::CX::V3::Intent intents}) outside of Dialogflow.
27
+ # @!attribute [r] content
28
+ # @return [::String]
29
+ # Output only. The uncompressed byte content for the objects.
30
+ # Only populated in responses.
31
+ class InlineDestination
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+
36
+ # Inline source for a Dialogflow operation that reads or imports objects
37
+ # (e.g. {::Google::Cloud::Dialogflow::CX::V3::Intent intents}) into Dialogflow.
38
+ # @!attribute [rw] content
39
+ # @return [::String]
40
+ # The uncompressed byte content for the objects.
41
+ class InlineSource
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -310,6 +310,181 @@ module Google
310
310
  extend ::Google::Protobuf::MessageExts::ClassMethods
311
311
  end
312
312
 
313
+ # The request message for
314
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#import_intents Intents.ImportIntents}.
315
+ # @!attribute [rw] parent
316
+ # @return [::String]
317
+ # Required. The agent to import the intents into.
318
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
319
+ # @!attribute [rw] intents_uri
320
+ # @return [::String]
321
+ # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
322
+ # to import intents from. The format of this URI must be
323
+ # `gs://<bucket-name>/<object-name>`.
324
+ #
325
+ # Dialogflow performs a read operation for the Cloud Storage object
326
+ # on the caller's behalf, so your request authentication must
327
+ # have read permissions for the object. For more information, see
328
+ # [Dialogflow access
329
+ # control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
330
+ # @!attribute [rw] intents_content
331
+ # @return [::Google::Cloud::Dialogflow::CX::V3::InlineSource]
332
+ # Uncompressed byte content of intents.
333
+ # @!attribute [rw] merge_option
334
+ # @return [::Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest::MergeOption]
335
+ # Merge option for importing intents. If not specified, `REJECT` is assumed.
336
+ class ImportIntentsRequest
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+
340
+ # Merge option when display name conflicts exist during import.
341
+ module MergeOption
342
+ # Unspecified. Should not be used.
343
+ MERGE_OPTION_UNSPECIFIED = 0
344
+
345
+ # DEPRECATED: Please use
346
+ # [REPORT_CONFLICT][ImportIntentsRequest.REPORT_CONFLICT] instead.
347
+ # Fail the request if there are intents whose display names conflict with
348
+ # the display names of intents in the agent.
349
+ REJECT = 1
350
+
351
+ # Replace the original intent in the agent with the new intent when display
352
+ # name conflicts exist.
353
+ REPLACE = 2
354
+
355
+ # Merge the original intent with the new intent when display name conflicts
356
+ # exist.
357
+ MERGE = 3
358
+
359
+ # Create new intents with new display names to differentiate them from the
360
+ # existing intents when display name conflicts exist.
361
+ RENAME = 4
362
+
363
+ # Report conflict information if display names conflict is detected.
364
+ # Otherwise, import intents.
365
+ REPORT_CONFLICT = 5
366
+
367
+ # Keep the original intent and discard the conflicting new intent when
368
+ # display name conflicts exist.
369
+ KEEP = 6
370
+ end
371
+ end
372
+
373
+ # The response message for
374
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#import_intents Intents.ImportIntents}.
375
+ # @!attribute [rw] intents
376
+ # @return [::Array<::String>]
377
+ # The unique identifier of the imported intents.
378
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
379
+ # ID>/intents/<Intent ID>`.
380
+ # @!attribute [rw] conflicting_resources
381
+ # @return [::Google::Cloud::Dialogflow::CX::V3::ImportIntentsResponse::ConflictingResources]
382
+ # Info which resources have conflicts when
383
+ # [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] merge_option is
384
+ # set in ImportIntentsRequest.
385
+ class ImportIntentsResponse
386
+ include ::Google::Protobuf::MessageExts
387
+ extend ::Google::Protobuf::MessageExts::ClassMethods
388
+
389
+ # Conflicting resources detected during the import process. Only filled when
390
+ # [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] is set in the
391
+ # request and there are conflicts in the display names.
392
+ # @!attribute [rw] intent_display_names
393
+ # @return [::Array<::String>]
394
+ # Display names of conflicting intents.
395
+ # @!attribute [rw] entity_display_names
396
+ # @return [::Array<::String>]
397
+ # Display names of conflicting entities.
398
+ class ConflictingResources
399
+ include ::Google::Protobuf::MessageExts
400
+ extend ::Google::Protobuf::MessageExts::ClassMethods
401
+ end
402
+ end
403
+
404
+ # Metadata returned for the
405
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#import_intents Intents.ImportIntents}
406
+ # long running operation.
407
+ class ImportIntentsMetadata
408
+ include ::Google::Protobuf::MessageExts
409
+ extend ::Google::Protobuf::MessageExts::ClassMethods
410
+ end
411
+
412
+ # The request message for
413
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#export_intents Intents.ExportIntents}.
414
+ # @!attribute [rw] parent
415
+ # @return [::String]
416
+ # Required. The name of the parent agent to export intents.
417
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
418
+ # ID>`.
419
+ # @!attribute [rw] intents
420
+ # @return [::Array<::String>]
421
+ # Required. The name of the intents to export.
422
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
423
+ # ID>/intents/<Intent ID>`.
424
+ # @!attribute [rw] intents_uri
425
+ # @return [::String]
426
+ # Optional. The [Google Cloud
427
+ # Storage](https://cloud.google.com/storage/docs/) URI to export the
428
+ # intents to. The format of this URI must be
429
+ # `gs://<bucket-name>/<object-name>`.
430
+ #
431
+ # Dialogflow performs a write operation for the Cloud Storage object
432
+ # on the caller's behalf, so your request authentication must
433
+ # have write permissions for the object. For more information, see
434
+ # [Dialogflow access
435
+ # control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
436
+ # @!attribute [rw] intents_content_inline
437
+ # @return [::Boolean]
438
+ # Optional. The option to return the serialized intents inline.
439
+ # @!attribute [rw] data_format
440
+ # @return [::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest::DataFormat]
441
+ # Optional. The data format of the exported intents. If not specified, `BLOB`
442
+ # is assumed.
443
+ class ExportIntentsRequest
444
+ include ::Google::Protobuf::MessageExts
445
+ extend ::Google::Protobuf::MessageExts::ClassMethods
446
+
447
+ # Data format of the exported intents.
448
+ module DataFormat
449
+ # Unspecified format. Treated as `BLOB`.
450
+ DATA_FORMAT_UNSPECIFIED = 0
451
+
452
+ # Intents will be exported as raw bytes.
453
+ BLOB = 1
454
+
455
+ # Intents will be exported in JSON format.
456
+ JSON = 2
457
+
458
+ # Intents will be exported in CSV format.
459
+ CSV = 3
460
+ end
461
+ end
462
+
463
+ # The response message for
464
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#export_intents Intents.ExportIntents}.
465
+ # @!attribute [rw] intents_uri
466
+ # @return [::String]
467
+ # The URI to a file containing the exported intents. This field is
468
+ # populated only if `intents_uri` is specified in
469
+ # {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest ExportIntentsRequest}.
470
+ # @!attribute [rw] intents_content
471
+ # @return [::Google::Cloud::Dialogflow::CX::V3::InlineDestination]
472
+ # Uncompressed byte content for intents. This field is populated only if
473
+ # `intents_content_inline` is set to true in
474
+ # {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest ExportIntentsRequest}.
475
+ class ExportIntentsResponse
476
+ include ::Google::Protobuf::MessageExts
477
+ extend ::Google::Protobuf::MessageExts::ClassMethods
478
+ end
479
+
480
+ # Metadata returned for the
481
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#export_intents Intents.ExportIntents}
482
+ # long running operation.
483
+ class ExportIntentsMetadata
484
+ include ::Google::Protobuf::MessageExts
485
+ extend ::Google::Protobuf::MessageExts::ClassMethods
486
+ end
487
+
313
488
  # Represents the options for views of an intent.
314
489
  # An intent can be a sizable object. Therefore, we provide a resource view that
315
490
  # does not return training phrases in the response.
@@ -61,8 +61,10 @@ module Google
61
61
  # @return [::Array<::String>]
62
62
  # Ordered list of
63
63
  # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup `TransitionRouteGroups`}
64
- # associated with the page. Transition route groups must be unique within a
65
- # page.
64
+ # added to the page. Transition route groups must be unique within a page. If
65
+ # the page links both flow-level transition route groups and agent-level
66
+ # transition route groups, the flow-level ones will have higher priority and
67
+ # will be put before the agent-level ones.
66
68
  #
67
69
  # * If multiple transition routes within a page scope refer to the same
68
70
  # intent, then the precedence order is: page's transition route -> page's
@@ -104,6 +106,13 @@ module Google
104
106
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>]
105
107
  # Handlers associated with the page to handle events such as webhook errors,
106
108
  # no match or no input.
109
+ # @!attribute [rw] advanced_settings
110
+ # @return [::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings]
111
+ # Hierarchical advanced settings for this page. The settings exposed at the
112
+ # lower level overrides the settings exposed at the higher level.
113
+ # @!attribute [rw] knowledge_connector_settings
114
+ # @return [::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings]
115
+ # Optional. Knowledge connector configuration.
107
116
  class Page
108
117
  include ::Google::Protobuf::MessageExts
109
118
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -158,6 +167,10 @@ module Google
158
167
  # Note: the parameter content is subject to redaction if either parameter
159
168
  # level redaction or [entity type level
160
169
  # redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
170
+ # @!attribute [rw] advanced_settings
171
+ # @return [::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings]
172
+ # Hierarchical advanced settings for this parameter. The settings exposed
173
+ # at the lower level overrides the settings exposed at the higher level.
161
174
  class Parameter
162
175
  include ::Google::Protobuf::MessageExts
163
176
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -270,6 +283,10 @@ module Google
270
283
  # @!attribute [r] name
271
284
  # @return [::String]
272
285
  # Output only. The unique identifier of this transition route.
286
+ # @!attribute [rw] description
287
+ # @return [::String]
288
+ # Optional. The description of the transition route. The maximum length is
289
+ # 500 characters.
273
290
  # @!attribute [rw] intent
274
291
  # @return [::String]
275
292
  # The unique identifier of an {::Google::Cloud::Dialogflow::CX::V3::Intent Intent}.
@@ -499,6 +516,39 @@ module Google
499
516
  include ::Google::Protobuf::MessageExts
500
517
  extend ::Google::Protobuf::MessageExts::ClassMethods
501
518
  end
519
+
520
+ # The Knowledge Connector settings for this page or flow.
521
+ # This includes information such as the attached Knowledge Bases, and the way
522
+ # to execute fulfillment.
523
+ # @!attribute [rw] enabled
524
+ # @return [::Boolean]
525
+ # Whether Knowledge Connector is enabled or not.
526
+ # @!attribute [rw] trigger_fulfillment
527
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
528
+ # The fulfillment to be triggered.
529
+ #
530
+ # When the answers from the Knowledge Connector are selected by Dialogflow,
531
+ # you can utitlize the request scoped parameter `$request.knowledge.answers`
532
+ # (contains up to the 5 highest confidence answers) and
533
+ # `$request.knowledge.questions` (contains the corresponding questions) to
534
+ # construct the fulfillment.
535
+ # @!attribute [rw] target_page
536
+ # @return [::String]
537
+ # The target page to transition to.
538
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
539
+ # ID>/flows/<Flow ID>/pages/<Page ID>`.
540
+ # @!attribute [rw] target_flow
541
+ # @return [::String]
542
+ # The target flow to transition to.
543
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
544
+ # ID>/flows/<Flow ID>`.
545
+ # @!attribute [rw] data_store_connections
546
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>]
547
+ # Optional. List of related data store connections.
548
+ class KnowledgeConnectorSettings
549
+ include ::Google::Protobuf::MessageExts
550
+ extend ::Google::Protobuf::MessageExts::ClassMethods
551
+ end
502
552
  end
503
553
  end
504
554
  end
@@ -81,6 +81,10 @@ module Google
81
81
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall]
82
82
  # A signal that the client should transfer the phone call connected to
83
83
  # this agent to a third-party endpoint.
84
+ # @!attribute [rw] knowledge_info_card
85
+ # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::KnowledgeInfoCard]
86
+ # Represents info card for knowledge answers, to be better rendered in
87
+ # Dialogflow Messenger.
84
88
  # @!attribute [rw] response_type
85
89
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType]
86
90
  # Response type.
@@ -242,6 +246,16 @@ module Google
242
246
  extend ::Google::Protobuf::MessageExts::ClassMethods
243
247
  end
244
248
 
249
+ # Represents info card response. If the response contains generative
250
+ # knowledge prediction, Dialogflow will return a payload with Infobot
251
+ # Messenger compatible info card.
252
+ #
253
+ # Otherwise, the info card response is skipped.
254
+ class KnowledgeInfoCard
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+ end
258
+
245
259
  # Represents different response types.
246
260
  module ResponseType
247
261
  # Not specified.
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dialogflow
23
+ module CX
24
+ module V3
25
+ # Settings for Generative Safety.
26
+ # @!attribute [rw] banned_phrases
27
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SafetySettings::Phrase>]
28
+ # Banned phrases for generated text.
29
+ class SafetySettings
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+
33
+ # Text input which can be used for prompt or banned phrases.
34
+ # @!attribute [rw] text
35
+ # @return [::String]
36
+ # Required. Text input which can be used for prompt or banned phrases.
37
+ # @!attribute [rw] language_code
38
+ # @return [::String]
39
+ # Required. Language code of the phrase.
40
+ class Phrase
41
+ include ::Google::Protobuf::MessageExts
42
+ extend ::Google::Protobuf::MessageExts::ClassMethods
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -174,6 +174,10 @@ module Google
174
174
  # for Agent Assist traffic), higher value will be ignored and use default.
175
175
  # Setting a value higher than that has no effect. A missing value or
176
176
  # setting to 0 also means we use default TTL.
177
+ # @!attribute [rw] retention_strategy
178
+ # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy]
179
+ # Specifies the retention behavior defined by
180
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy SecuritySettings.RetentionStrategy}.
177
181
  # @!attribute [rw] purge_data_types
178
182
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>]
179
183
  # List of types of data to remove when retention settings triggers purge.
@@ -184,7 +188,7 @@ module Google
184
188
  # [Participants.StreamingAnalyzeContent][].
185
189
  #
186
190
  # If
187
- # [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
191
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings#retention_strategy retention_strategy}
188
192
  # is set to REMOVE_AFTER_CONVERSATION or [audio_export_settings.gcs_bucket][]
189
193
  # is empty, audio export is disabled.
190
194
  #
@@ -202,7 +206,7 @@ module Google
202
206
  # completed.
203
207
  #
204
208
  # If
205
- # [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
209
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings#retention_strategy retention_strategy}
206
210
  # is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter
207
211
  # what you configure here.
208
212
  class SecuritySettings
@@ -279,6 +283,17 @@ module Google
279
283
  REDACT_DISK_STORAGE = 2
280
284
  end
281
285
 
286
+ # Defines how long we retain persisted data that contains sensitive info.
287
+ module RetentionStrategy
288
+ # Retains the persisted data with Dialogflow's internal default 365d TTLs.
289
+ RETENTION_STRATEGY_UNSPECIFIED = 0
290
+
291
+ # Removes data when the conversation ends. If there is no [Conversation][]
292
+ # explicitly established, a default conversation ends when the
293
+ # corresponding Dialogflow session ends.
294
+ REMOVE_AFTER_CONVERSATION = 1
295
+ end
296
+
282
297
  # Type of data we purge after retention settings triggers purge.
283
298
  module PurgeDataType
284
299
  # Unspecified. Do not use.
@@ -234,7 +234,10 @@ module Google
234
234
  # beginning of the stream.
235
235
  # @!attribute [rw] no_speech_timeout
236
236
  # @return [::Google::Protobuf::Duration]
237
- # No speech timeout settings observed at runtime.
237
+ # No speech timeout settings for the stream.
238
+ # @!attribute [rw] endpointing_timeout
239
+ # @return [::Google::Protobuf::Duration]
240
+ # Speech endpointing timeout settings for the stream.
238
241
  # @!attribute [rw] is_input_text
239
242
  # @return [::Boolean]
240
243
  # Whether the streaming terminates with an injected text query.
@@ -678,6 +681,13 @@ module Google
678
681
  # [`analyze_query_text_sentiment`]
679
682
  # [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment],
680
683
  # specified in the request.
684
+ # @!attribute [rw] advanced_settings
685
+ # @return [::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings]
686
+ # Returns the current advanced settings including IVR settings. Even though
687
+ # the operations configured by these settings are performed by Dialogflow,
688
+ # the client may need to perform special logic at the moment. For example, if
689
+ # Dialogflow exports audio to Google Cloud Storage, then the client may need
690
+ # to wait for the resulting object to appear in the bucket before proceeding.
681
691
  class QueryResult
682
692
  include ::Google::Protobuf::MessageExts
683
693
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -85,6 +85,9 @@ module Google
85
85
 
86
86
  # Transition route group.
87
87
  TRANSITION_ROUTE_GROUP = 7
88
+
89
+ # Agent transition route group.
90
+ AGENT_TRANSITION_ROUTE_GROUP = 14
88
91
  end
89
92
 
90
93
  # Severity level.