google-cloud-dialogflow-v2 0.19.0 → 0.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +12 -8
  4. data/lib/google/cloud/dialogflow/v2/agents/client.rb +16 -12
  5. data/lib/google/cloud/dialogflow/v2/agents.rb +1 -1
  6. data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +7 -0
  7. data/lib/google/cloud/dialogflow/v2/answer_record_services_pb.rb +2 -1
  8. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +2 -1
  9. data/lib/google/cloud/dialogflow/v2/answer_records.rb +3 -2
  10. data/lib/google/cloud/dialogflow/v2/contexts.rb +1 -1
  11. data/lib/google/cloud/dialogflow/v2/conversation_dataset_services_pb.rb +10 -5
  12. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +12 -7
  13. data/lib/google/cloud/dialogflow/v2/conversation_datasets.rb +1 -1
  14. data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +1 -0
  15. data/lib/google/cloud/dialogflow/v2/conversation_model_services_pb.rb +10 -5
  16. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +10 -5
  17. data/lib/google/cloud/dialogflow/v2/conversation_models.rb +1 -1
  18. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +18 -0
  19. data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +14 -7
  20. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +14 -7
  21. data/lib/google/cloud/dialogflow/v2/conversation_profiles.rb +3 -2
  22. data/lib/google/cloud/dialogflow/v2/conversation_services_pb.rb +14 -6
  23. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +119 -8
  24. data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +45 -0
  25. data/lib/google/cloud/dialogflow/v2/conversations.rb +3 -2
  26. data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +16 -8
  27. data/lib/google/cloud/dialogflow/v2/documents/client.rb +20 -12
  28. data/lib/google/cloud/dialogflow/v2/documents.rb +3 -2
  29. data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +2 -1
  30. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +2 -1
  31. data/lib/google/cloud/dialogflow/v2/entity_types.rb +1 -1
  32. data/lib/google/cloud/dialogflow/v2/environments/client.rb +4 -4
  33. data/lib/google/cloud/dialogflow/v2/environments.rb +1 -1
  34. data/lib/google/cloud/dialogflow/v2/fulfillments.rb +1 -1
  35. data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +2 -1
  36. data/lib/google/cloud/dialogflow/v2/intents/client.rb +2 -1
  37. data/lib/google/cloud/dialogflow/v2/intents.rb +1 -1
  38. data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb +2 -1
  39. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +2 -1
  40. data/lib/google/cloud/dialogflow/v2/knowledge_bases.rb +3 -2
  41. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +1 -0
  42. data/lib/google/cloud/dialogflow/v2/participants/client.rb +3 -2
  43. data/lib/google/cloud/dialogflow/v2/participants.rb +1 -1
  44. data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +2 -1
  45. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +2 -1
  46. data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +3 -2
  47. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +8 -6
  48. data/lib/google/cloud/dialogflow/v2/sessions.rb +1 -1
  49. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  50. data/lib/google/cloud/dialogflow/v2/versions/client.rb +2 -2
  51. data/lib/google/cloud/dialogflow/v2/versions.rb +1 -1
  52. data/lib/google/cloud/dialogflow/v2.rb +2 -2
  53. data/proto_docs/google/api/client.rb +318 -0
  54. data/proto_docs/google/api/launch_stage.rb +71 -0
  55. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +26 -15
  56. data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +34 -9
  57. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +28 -18
  58. data/proto_docs/google/cloud/dialogflow/v2/context.rb +14 -7
  59. data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +99 -14
  60. data/proto_docs/google/cloud/dialogflow/v2/conversation_dataset.rb +15 -10
  61. data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +41 -14
  62. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +28 -15
  63. data/proto_docs/google/cloud/dialogflow/v2/document.rb +26 -15
  64. data/proto_docs/google/cloud/dialogflow/v2/entity_type.rb +30 -15
  65. data/proto_docs/google/cloud/dialogflow/v2/environment.rb +37 -29
  66. data/proto_docs/google/cloud/dialogflow/v2/fulfillment.rb +12 -7
  67. data/proto_docs/google/cloud/dialogflow/v2/intent.rb +33 -17
  68. data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +12 -6
  69. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +110 -59
  70. data/proto_docs/google/cloud/dialogflow/v2/session.rb +63 -46
  71. data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb +15 -8
  72. data/proto_docs/google/cloud/dialogflow/v2/version.rb +20 -14
  73. data/proto_docs/google/cloud/dialogflow/v2/webhook.rb +20 -13
  74. data/proto_docs/google/rpc/status.rb +4 -2
  75. metadata +7 -5
@@ -28,7 +28,8 @@ module Google
28
28
  ##
29
29
  # Client for the Conversations service.
30
30
  #
31
- # Service for managing {::Google::Cloud::Dialogflow::V2::Conversation Conversations}.
31
+ # Service for managing
32
+ # {::Google::Cloud::Dialogflow::V2::Conversation Conversations}.
32
33
  #
33
34
  class Client
34
35
  include Paths
@@ -177,11 +178,14 @@ module Google
177
178
  # For Assist Stage, there's no dialogflow agent responding to user queries.
178
179
  # But we will provide suggestions which are generated from conversation.
179
180
  #
180
- # If {::Google::Cloud::Dialogflow::V2::Conversation#conversation_profile Conversation.conversation_profile} is configured for a dialogflow
181
- # agent, conversation will start from `Automated Agent Stage`, otherwise, it
182
- # will start from `Assist Stage`. And during `Automated Agent Stage`, once an
183
- # {::Google::Cloud::Dialogflow::V2::Intent Intent} with {::Google::Cloud::Dialogflow::V2::Intent#live_agent_handoff Intent.live_agent_handoff} is triggered, conversation
184
- # will transfer to Assist Stage.
181
+ # If
182
+ # {::Google::Cloud::Dialogflow::V2::Conversation#conversation_profile Conversation.conversation_profile}
183
+ # is configured for a dialogflow agent, conversation will start from
184
+ # `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And
185
+ # during `Automated Agent Stage`, once an
186
+ # {::Google::Cloud::Dialogflow::V2::Intent Intent} with
187
+ # {::Google::Cloud::Dialogflow::V2::Intent#live_agent_handoff Intent.live_agent_handoff}
188
+ # is triggered, conversation will transfer to Assist Stage.
185
189
  #
186
190
  # @overload create_conversation(request, options = nil)
187
191
  # Pass arguments to `create_conversation` via a request object, either of type
@@ -204,8 +208,8 @@ module Google
204
208
  # @param conversation [::Google::Cloud::Dialogflow::V2::Conversation, ::Hash]
205
209
  # Required. The conversation to create.
206
210
  # @param conversation_id [::String]
207
- # Optional. Identifier of the conversation. Generally it's auto generated by Google.
208
- # Only set it if you cannot wait for the response to return a
211
+ # Optional. Identifier of the conversation. Generally it's auto generated by
212
+ # Google. Only set it if you cannot wait for the response to return a
209
213
  # auto-generated one to you.
210
214
  #
211
215
  # The conversation ID must be compliant with the regression fomula
@@ -682,6 +686,106 @@ module Google
682
686
  raise ::Google::Cloud::Error.from_error(e)
683
687
  end
684
688
 
689
+ ##
690
+ # Suggests summary for a conversation based on specific historical messages.
691
+ # The range of the messages to be used for summary can be specified in the
692
+ # request.
693
+ #
694
+ # @overload suggest_conversation_summary(request, options = nil)
695
+ # Pass arguments to `suggest_conversation_summary` via a request object, either of type
696
+ # {::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryRequest} or an equivalent Hash.
697
+ #
698
+ # @param request [::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryRequest, ::Hash]
699
+ # A request object representing the call parameters. Required. To specify no
700
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
701
+ # @param options [::Gapic::CallOptions, ::Hash]
702
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
703
+ #
704
+ # @overload suggest_conversation_summary(conversation: nil, latest_message: nil, context_size: nil)
705
+ # Pass arguments to `suggest_conversation_summary` via keyword arguments. Note that at
706
+ # least one keyword argument is required. To specify no parameters, or to keep all
707
+ # the default parameter values, pass an empty Hash as a request object (see above).
708
+ #
709
+ # @param conversation [::String]
710
+ # Required. The conversation to fetch suggestion for.
711
+ # Format: `projects/<Project ID>/locations/<Location
712
+ # ID>/conversations/<Conversation ID>`.
713
+ # @param latest_message [::String]
714
+ # The name of the latest conversation message used as context for
715
+ # compiling suggestion. If empty, the latest message of the conversation will
716
+ # be used.
717
+ #
718
+ # Format: `projects/<Project ID>/locations/<Location
719
+ # ID>/conversations/<Conversation ID>/messages/<Message ID>`.
720
+ # @param context_size [::Integer]
721
+ # Max number of messages prior to and including
722
+ # [latest_message] to use as context when compiling the
723
+ # suggestion. By default 500 and at most 1000.
724
+ #
725
+ # @yield [response, operation] Access the result along with the RPC operation
726
+ # @yieldparam response [::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse]
727
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
728
+ #
729
+ # @return [::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse]
730
+ #
731
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
732
+ #
733
+ # @example Basic example
734
+ # require "google/cloud/dialogflow/v2"
735
+ #
736
+ # # Create a client object. The client can be reused for multiple calls.
737
+ # client = Google::Cloud::Dialogflow::V2::Conversations::Client.new
738
+ #
739
+ # # Create a request. To set request fields, pass in keyword arguments.
740
+ # request = Google::Cloud::Dialogflow::V2::SuggestConversationSummaryRequest.new
741
+ #
742
+ # # Call the suggest_conversation_summary method.
743
+ # result = client.suggest_conversation_summary request
744
+ #
745
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse.
746
+ # p result
747
+ #
748
+ def suggest_conversation_summary request, options = nil
749
+ raise ::ArgumentError, "request must be provided" if request.nil?
750
+
751
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryRequest
752
+
753
+ # Converts hash and nil to an options object
754
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
755
+
756
+ # Customize the options with defaults
757
+ metadata = @config.rpcs.suggest_conversation_summary.metadata.to_h
758
+
759
+ # Set x-goog-api-client and x-goog-user-project headers
760
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
761
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
762
+ gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
763
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
764
+
765
+ header_params = {}
766
+ if request.conversation
767
+ header_params["conversation"] = request.conversation
768
+ end
769
+
770
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
771
+ metadata[:"x-goog-request-params"] ||= request_params_header
772
+
773
+ options.apply_defaults timeout: @config.rpcs.suggest_conversation_summary.timeout,
774
+ metadata: metadata,
775
+ retry_policy: @config.rpcs.suggest_conversation_summary.retry_policy
776
+
777
+ options.apply_defaults timeout: @config.timeout,
778
+ metadata: @config.metadata,
779
+ retry_policy: @config.retry_policy
780
+
781
+ @conversations_stub.call_rpc :suggest_conversation_summary, request, options: options do |response, operation|
782
+ yield response, operation if block_given?
783
+ return response
784
+ end
785
+ rescue ::GRPC::BadStatus => e
786
+ raise ::Google::Cloud::Error.from_error(e)
787
+ end
788
+
685
789
  ##
686
790
  # Configuration class for the Conversations API.
687
791
  #
@@ -842,6 +946,11 @@ module Google
842
946
  # @return [::Gapic::Config::Method]
843
947
  #
844
948
  attr_reader :list_messages
949
+ ##
950
+ # RPC-specific configuration for `suggest_conversation_summary`
951
+ # @return [::Gapic::Config::Method]
952
+ #
953
+ attr_reader :suggest_conversation_summary
845
954
 
846
955
  # @private
847
956
  def initialize parent_rpcs = nil
@@ -855,6 +964,8 @@ module Google
855
964
  @complete_conversation = ::Gapic::Config::Method.new complete_conversation_config
856
965
  list_messages_config = parent_rpcs.list_messages if parent_rpcs.respond_to? :list_messages
857
966
  @list_messages = ::Gapic::Config::Method.new list_messages_config
967
+ suggest_conversation_summary_config = parent_rpcs.suggest_conversation_summary if parent_rpcs.respond_to? :suggest_conversation_summary
968
+ @suggest_conversation_summary = ::Gapic::Config::Method.new suggest_conversation_summary_config
858
969
 
859
970
  yield self if block_given?
860
971
  end
@@ -123,6 +123,51 @@ module Google
123
123
  "projects/#{project}/locations/#{location}"
124
124
  end
125
125
 
126
+ ##
127
+ # Create a fully-qualified Message resource string.
128
+ #
129
+ # @overload message_path(project:, conversation:, message:)
130
+ # The resource will be in the following format:
131
+ #
132
+ # `projects/{project}/conversations/{conversation}/messages/{message}`
133
+ #
134
+ # @param project [String]
135
+ # @param conversation [String]
136
+ # @param message [String]
137
+ #
138
+ # @overload message_path(project:, location:, conversation:, message:)
139
+ # The resource will be in the following format:
140
+ #
141
+ # `projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}`
142
+ #
143
+ # @param project [String]
144
+ # @param location [String]
145
+ # @param conversation [String]
146
+ # @param message [String]
147
+ #
148
+ # @return [::String]
149
+ def message_path **args
150
+ resources = {
151
+ "conversation:message:project" => (proc do |project:, conversation:, message:|
152
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
153
+ raise ::ArgumentError, "conversation cannot contain /" if conversation.to_s.include? "/"
154
+
155
+ "projects/#{project}/conversations/#{conversation}/messages/#{message}"
156
+ end),
157
+ "conversation:location:message:project" => (proc do |project:, location:, conversation:, message:|
158
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
159
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
160
+ raise ::ArgumentError, "conversation cannot contain /" if conversation.to_s.include? "/"
161
+
162
+ "projects/#{project}/locations/#{location}/conversations/#{conversation}/messages/#{message}"
163
+ end)
164
+ }
165
+
166
+ resource = resources[args.keys.sort.join(":")]
167
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
168
+ resource.call(**args)
169
+ end
170
+
126
171
  ##
127
172
  # Create a fully-qualified Project resource string.
128
173
  #
@@ -31,9 +31,10 @@ module Google
31
31
  module Dialogflow
32
32
  module V2
33
33
  ##
34
- # Service for managing {::Google::Cloud::Dialogflow::V2::Conversation Conversations}.
34
+ # Service for managing
35
+ # {::Google::Cloud::Dialogflow::V2::Conversation Conversations}.
35
36
  #
36
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
37
38
  #
38
39
  # require "google/cloud/dialogflow/v2/conversations"
39
40
  # client = ::Google::Cloud::Dialogflow::V2::Conversations::Client.new
@@ -24,7 +24,8 @@ module Google
24
24
  module Dialogflow
25
25
  module V2
26
26
  module Documents
27
- # Service for managing knowledge [Documents][google.cloud.dialogflow.v2.Document].
27
+ # Service for managing knowledge
28
+ # [Documents][google.cloud.dialogflow.v2.Document].
28
29
  class Service
29
30
 
30
31
  include ::GRPC::GenericService
@@ -43,7 +44,8 @@ module Google
43
44
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
44
45
  # The returned `Operation` type has the following method-specific fields:
45
46
  #
46
- # - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
47
+ # - `metadata`:
48
+ # [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
47
49
  # - `response`: [Document][google.cloud.dialogflow.v2.Document]
48
50
  rpc :CreateDocument, ::Google::Cloud::Dialogflow::V2::CreateDocumentRequest, ::Google::Longrunning::Operation
49
51
  # Creates documents by importing data from external sources.
@@ -54,8 +56,10 @@ module Google
54
56
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
55
57
  # The returned `Operation` type has the following method-specific fields:
56
58
  #
57
- # - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
58
- # - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
59
+ # - `metadata`:
60
+ # [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
61
+ # - `response`:
62
+ # [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
59
63
  rpc :ImportDocuments, ::Google::Cloud::Dialogflow::V2::ImportDocumentsRequest, ::Google::Longrunning::Operation
60
64
  # Deletes the specified document.
61
65
  #
@@ -63,7 +67,8 @@ module Google
63
67
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
64
68
  # The returned `Operation` type has the following method-specific fields:
65
69
  #
66
- # - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
70
+ # - `metadata`:
71
+ # [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
67
72
  # - `response`: An [Empty
68
73
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
69
74
  rpc :DeleteDocument, ::Google::Cloud::Dialogflow::V2::DeleteDocumentRequest, ::Google::Longrunning::Operation
@@ -73,7 +78,8 @@ module Google
73
78
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
74
79
  # The returned `Operation` type has the following method-specific fields:
75
80
  #
76
- # - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
81
+ # - `metadata`:
82
+ # [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
77
83
  # - `response`: [Document][google.cloud.dialogflow.v2.Document]
78
84
  rpc :UpdateDocument, ::Google::Cloud::Dialogflow::V2::UpdateDocumentRequest, ::Google::Longrunning::Operation
79
85
  # Reloads the specified document from its specified source, content_uri or
@@ -85,7 +91,8 @@ module Google
85
91
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
86
92
  # The returned `Operation` type has the following method-specific fields:
87
93
  #
88
- # - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
94
+ # - `metadata`:
95
+ # [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
89
96
  # - `response`: [Document][google.cloud.dialogflow.v2.Document]
90
97
  #
91
98
  # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
@@ -98,7 +105,8 @@ module Google
98
105
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
99
106
  # The returned `Operation` type has the following method-specific fields:
100
107
  #
101
- # - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
108
+ # - `metadata`:
109
+ # [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
102
110
  # - `response`: [Document][google.cloud.dialogflow.v2.Document]
103
111
  rpc :ExportDocument, ::Google::Cloud::Dialogflow::V2::ExportDocumentRequest, ::Google::Longrunning::Operation
104
112
  end
@@ -28,7 +28,8 @@ module Google
28
28
  ##
29
29
  # Client for the Documents service.
30
30
  #
31
- # Service for managing knowledge {::Google::Cloud::Dialogflow::V2::Document Documents}.
31
+ # Service for managing knowledge
32
+ # {::Google::Cloud::Dialogflow::V2::Document Documents}.
32
33
  #
33
34
  class Client
34
35
  include Paths
@@ -391,7 +392,8 @@ module Google
391
392
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
392
393
  # The returned `Operation` type has the following method-specific fields:
393
394
  #
394
- # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
395
+ # - `metadata`:
396
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
395
397
  # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
396
398
  #
397
399
  # @overload create_document(request, options = nil)
@@ -497,8 +499,10 @@ module Google
497
499
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
498
500
  # The returned `Operation` type has the following method-specific fields:
499
501
  #
500
- # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
501
- # - `response`: {::Google::Cloud::Dialogflow::V2::ImportDocumentsResponse ImportDocumentsResponse}
502
+ # - `metadata`:
503
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
504
+ # - `response`:
505
+ # {::Google::Cloud::Dialogflow::V2::ImportDocumentsResponse ImportDocumentsResponse}
502
506
  #
503
507
  # @overload import_documents(request, options = nil)
504
508
  # Pass arguments to `import_documents` via a request object, either of type
@@ -611,7 +615,8 @@ module Google
611
615
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
612
616
  # The returned `Operation` type has the following method-specific fields:
613
617
  #
614
- # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
618
+ # - `metadata`:
619
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
615
620
  # - `response`: An [Empty
616
621
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
617
622
  #
@@ -714,7 +719,8 @@ module Google
714
719
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
715
720
  # The returned `Operation` type has the following method-specific fields:
716
721
  #
717
- # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
722
+ # - `metadata`:
723
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
718
724
  # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
719
725
  #
720
726
  # @overload update_document(request, options = nil)
@@ -821,7 +827,8 @@ module Google
821
827
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
822
828
  # The returned `Operation` type has the following method-specific fields:
823
829
  #
824
- # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
830
+ # - `metadata`:
831
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
825
832
  # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
826
833
  #
827
834
  # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
@@ -847,8 +854,8 @@ module Google
847
854
  # Format: `projects/<Project ID>/locations/<Location
848
855
  # ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
849
856
  # @param content_uri [::String]
850
- # Optional. The path of gcs source file for reloading document content. For now,
851
- # only gcs uri is supported.
857
+ # Optional. The path of gcs source file for reloading document content. For
858
+ # now, only gcs uri is supported.
852
859
  #
853
860
  # For documents stored in Google Cloud Storage, these URIs must have
854
861
  # the form `gs://<bucket-name>/<object-name>`.
@@ -856,8 +863,8 @@ module Google
856
863
  # Optional. Whether to import custom metadata from Google Cloud Storage.
857
864
  # Only valid when the document source is Google Cloud Storage URI.
858
865
  # @param smart_messaging_partial_update [::Boolean]
859
- # Optional. When enabled, the reload request is to apply partial update to the smart
860
- # messaging allowlist.
866
+ # Optional. When enabled, the reload request is to apply partial update to
867
+ # the smart messaging allowlist.
861
868
  #
862
869
  # @yield [response, operation] Access the result along with the RPC operation
863
870
  # @yieldparam response [::Gapic::Operation]
@@ -939,7 +946,8 @@ module Google
939
946
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
940
947
  # The returned `Operation` type has the following method-specific fields:
941
948
  #
942
- # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
949
+ # - `metadata`:
950
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
943
951
  # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
944
952
  #
945
953
  # @overload export_document(request, options = nil)
@@ -32,9 +32,10 @@ module Google
32
32
  module Dialogflow
33
33
  module V2
34
34
  ##
35
- # Service for managing knowledge {::Google::Cloud::Dialogflow::V2::Document Documents}.
35
+ # Service for managing knowledge
36
+ # {::Google::Cloud::Dialogflow::V2::Document Documents}.
36
37
  #
37
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
38
39
  #
39
40
  # require "google/cloud/dialogflow/v2/documents"
40
41
  # client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new
@@ -63,7 +63,8 @@ module Google
63
63
  #
64
64
  # - `metadata`: An empty [Struct
65
65
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
66
- # - `response`: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse]
66
+ # - `response`:
67
+ # [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse]
67
68
  #
68
69
  # Note: You should always train an agent prior to sending it queries. See the
69
70
  # [training
@@ -666,7 +666,8 @@ module Google
666
666
  #
667
667
  # - `metadata`: An empty [Struct
668
668
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
669
- # - `response`: {::Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesResponse BatchUpdateEntityTypesResponse}
669
+ # - `response`:
670
+ # {::Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesResponse BatchUpdateEntityTypesResponse}
670
671
  #
671
672
  # Note: You should always train an agent prior to sending it queries. See the
672
673
  # [training
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing {::Google::Cloud::Dialogflow::V2::EntityType EntityTypes}.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/v2/entity_types"
40
40
  # client = ::Google::Cloud::Dialogflow::V2::EntityTypes::Client.new
@@ -188,8 +188,8 @@ module Google
188
188
  # - `projects/<Project ID>/agent`
189
189
  # - `projects/<Project ID>/locations/<Location ID>/agent`
190
190
  # @param page_size [::Integer]
191
- # Optional. The maximum number of items to return in a single page. By default 100 and
192
- # at most 1000.
191
+ # Optional. The maximum number of items to return in a single page. By
192
+ # default 100 and at most 1000.
193
193
  # @param page_token [::String]
194
194
  # Optional. The next_page_token value returned from a previous list request.
195
195
  #
@@ -672,8 +672,8 @@ module Google
672
672
  #
673
673
  # The environment ID for the default environment is `-`.
674
674
  # @param page_size [::Integer]
675
- # Optional. The maximum number of items to return in a single page. By default 100 and
676
- # at most 1000.
675
+ # Optional. The maximum number of items to return in a single page. By
676
+ # default 100 and at most 1000.
677
677
  # @param page_token [::String]
678
678
  # Optional. The next_page_token value returned from a previous list request.
679
679
  #
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for managing {::Google::Cloud::Dialogflow::V2::Environment Environments}.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/dialogflow/v2/environments"
39
39
  # client = ::Google::Cloud::Dialogflow::V2::Environments::Client.new
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for managing {::Google::Cloud::Dialogflow::V2::Fulfillment Fulfillments}.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/dialogflow/v2/fulfillments"
39
39
  # client = ::Google::Cloud::Dialogflow::V2::Fulfillments::Client.new
@@ -63,7 +63,8 @@ module Google
63
63
  #
64
64
  # - `metadata`: An empty [Struct
65
65
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
66
- # - `response`: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]
66
+ # - `response`:
67
+ # [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]
67
68
  #
68
69
  # Note: You should always train an agent prior to sending it queries. See the
69
70
  # [training
@@ -683,7 +683,8 @@ module Google
683
683
  #
684
684
  # - `metadata`: An empty [Struct
685
685
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
686
- # - `response`: {::Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse BatchUpdateIntentsResponse}
686
+ # - `response`:
687
+ # {::Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse BatchUpdateIntentsResponse}
687
688
  #
688
689
  # Note: You should always train an agent prior to sending it queries. See the
689
690
  # [training
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing {::Google::Cloud::Dialogflow::V2::Intent Intents}.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/v2/intents"
40
40
  # client = ::Google::Cloud::Dialogflow::V2::Intents::Client.new
@@ -24,7 +24,8 @@ module Google
24
24
  module Dialogflow
25
25
  module V2
26
26
  module KnowledgeBases
27
- # Service for managing [KnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBase].
27
+ # Service for managing
28
+ # [KnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBase].
28
29
  class Service
29
30
 
30
31
  include ::GRPC::GenericService
@@ -28,7 +28,8 @@ module Google
28
28
  ##
29
29
  # Client for the KnowledgeBases service.
30
30
  #
31
- # Service for managing {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBases}.
31
+ # Service for managing
32
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBases}.
32
33
  #
33
34
  class Client
34
35
  include Paths
@@ -31,9 +31,10 @@ module Google
31
31
  module Dialogflow
32
32
  module V2
33
33
  ##
34
- # Service for managing {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBases}.
34
+ # Service for managing
35
+ # {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBases}.
35
36
  #
36
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
37
38
  #
38
39
  # require "google/cloud/dialogflow/v2/knowledge_bases"
39
40
  # client = ::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
@@ -152,6 +152,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
152
152
  optional :detect_intent_response, :message, 1, "google.cloud.dialogflow.v2.DetectIntentResponse"
153
153
  optional :automated_agent_reply_type, :enum, 7, "google.cloud.dialogflow.v2.AutomatedAgentReply.AutomatedAgentReplyType"
154
154
  optional :allow_cancellation, :bool, 8
155
+ optional :cx_current_page, :string, 11
155
156
  end
156
157
  add_enum "google.cloud.dialogflow.v2.AutomatedAgentReply.AutomatedAgentReplyType" do
157
158
  value :AUTOMATED_AGENT_REPLY_TYPE_UNSPECIFIED, 0
@@ -772,8 +772,9 @@ module Google
772
772
  # ID>/conversations/<Conversation ID>/messages/<Message ID>`.
773
773
  # @param context_size [::Integer]
774
774
  # Optional. Max number of messages prior to and including
775
- # {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message} to use as context
776
- # when compiling the suggestion. By default 20 and at most 50.
775
+ # {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message}
776
+ # to use as context when compiling the suggestion. By default 20 and at
777
+ # most 50.
777
778
  # @param assist_query_params [::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash]
778
779
  # Parameters for a human assist query.
779
780
  #
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for managing {::Google::Cloud::Dialogflow::V2::Participant Participants}.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/dialogflow/v2/participants"
39
39
  # client = ::Google::Cloud::Dialogflow::V2::Participants::Client.new
@@ -24,7 +24,8 @@ module Google
24
24
  module Dialogflow
25
25
  module V2
26
26
  module SessionEntityTypes
27
- # Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityType].
27
+ # Service for managing
28
+ # [SessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityType].
28
29
  class Service
29
30
 
30
31
  include ::GRPC::GenericService
@@ -28,7 +28,8 @@ module Google
28
28
  ##
29
29
  # Client for the SessionEntityTypes service.
30
30
  #
31
- # Service for managing {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityTypes}.
31
+ # Service for managing
32
+ # {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityTypes}.
32
33
  #
33
34
  class Client
34
35
  include Paths
@@ -31,9 +31,10 @@ module Google
31
31
  module Dialogflow
32
32
  module V2
33
33
  ##
34
- # Service for managing {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityTypes}.
34
+ # Service for managing
35
+ # {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityTypes}.
35
36
  #
36
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
37
38
  #
38
39
  # require "google/cloud/dialogflow/v2/session_entity_types"
39
40
  # client = ::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new