google-cloud-dialogflow-v2 0.18.0 → 0.20.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 323d660797e6031bec894aa0fad4c8995ba80111a77d4a1e06d2e34b43c6045d
4
- data.tar.gz: 475cf6b836273feb02a5634f18eaeb94c39a21f81096af9cab83e061c3a1631e
3
+ metadata.gz: e651dd3df69299e7dc0e8a64971b658dc1c552c1851ca944ea4e35e3efbf2a67
4
+ data.tar.gz: 81d9ed44d30f4e9f7b977d535b726bfaa83533949a796beea58e39cd21af8f65
5
5
  SHA512:
6
- metadata.gz: 44aa41038a1a2163a3b702c03c1a0196f3a6fb5ed3085f75c72c948f0755e2a91a12b702e623f1df18ad8453566c3d8355a0831a79c5b42ee8815c8e433e66e4
7
- data.tar.gz: 29566f50e2676d466f0fd5d3154184085945aa205abe140470c0a0b43c7573fc62af49d9a9a7957ab1c37e09c75130e8139f716bba2980dd0ff0affd6ee98f03
6
+ metadata.gz: 73f5df15a1547a180cbc49d48832a8547c8939d3f3c9eb78e2e61cc873669f78a2ab57dbf9cf21df7c7e6dca2199b3898b01626d589f2ac4d405f496daa6e379
7
+ data.tar.gz: 64bbc6c7612fc9c0159372602bea7f527cbbfee119ff11fdcef2b5d214a2040316674c84a6850429f5508c044dec1be547355d37fcef9418a74c6d822bf679f5
data/README.md CHANGED
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -47,8 +47,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
47
47
  optional :sample_rate_hertz, :int32, 2
48
48
  optional :synthesize_speech_config, :message, 3, "google.cloud.dialogflow.v2.SynthesizeSpeechConfig"
49
49
  end
50
+ add_message "google.cloud.dialogflow.v2.TelephonyDtmfEvents" do
51
+ repeated :dtmf_events, :enum, 1, "google.cloud.dialogflow.v2.TelephonyDtmf"
52
+ end
50
53
  add_message "google.cloud.dialogflow.v2.SpeechToTextConfig" do
51
54
  optional :speech_model_variant, :enum, 1, "google.cloud.dialogflow.v2.SpeechModelVariant"
55
+ optional :model, :string, 2
52
56
  end
53
57
  add_enum "google.cloud.dialogflow.v2.AudioEncoding" do
54
58
  value :AUDIO_ENCODING_UNSPECIFIED, 0
@@ -80,6 +84,25 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
80
84
  value :OUTPUT_AUDIO_ENCODING_OGG_OPUS, 3
81
85
  value :OUTPUT_AUDIO_ENCODING_MULAW, 5
82
86
  end
87
+ add_enum "google.cloud.dialogflow.v2.TelephonyDtmf" do
88
+ value :TELEPHONY_DTMF_UNSPECIFIED, 0
89
+ value :DTMF_ONE, 1
90
+ value :DTMF_TWO, 2
91
+ value :DTMF_THREE, 3
92
+ value :DTMF_FOUR, 4
93
+ value :DTMF_FIVE, 5
94
+ value :DTMF_SIX, 6
95
+ value :DTMF_SEVEN, 7
96
+ value :DTMF_EIGHT, 8
97
+ value :DTMF_NINE, 9
98
+ value :DTMF_ZERO, 10
99
+ value :DTMF_A, 11
100
+ value :DTMF_B, 12
101
+ value :DTMF_C, 13
102
+ value :DTMF_D, 14
103
+ value :DTMF_STAR, 15
104
+ value :DTMF_POUND, 16
105
+ end
83
106
  end
84
107
  end
85
108
 
@@ -93,11 +116,13 @@ module Google
93
116
  VoiceSelectionParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.VoiceSelectionParams").msgclass
94
117
  SynthesizeSpeechConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SynthesizeSpeechConfig").msgclass
95
118
  OutputAudioConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.OutputAudioConfig").msgclass
119
+ TelephonyDtmfEvents = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.TelephonyDtmfEvents").msgclass
96
120
  SpeechToTextConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SpeechToTextConfig").msgclass
97
121
  AudioEncoding = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AudioEncoding").enummodule
98
122
  SpeechModelVariant = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SpeechModelVariant").enummodule
99
123
  SsmlVoiceGender = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SsmlVoiceGender").enummodule
100
124
  OutputAudioEncoding = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.OutputAudioEncoding").enummodule
125
+ TelephonyDtmf = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.TelephonyDtmf").enummodule
101
126
  end
102
127
  end
103
128
  end
@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
20
20
  optional :name, :string, 1
21
21
  optional :role, :enum, 2, "google.cloud.dialogflow.v2.Participant.Role"
22
22
  optional :sip_recording_media_label, :string, 6
23
+ optional :obfuscated_external_user_id, :string, 7
23
24
  map :documents_metadata_filters, :string, :string, 8
24
25
  end
25
26
  add_enum "google.cloud.dialogflow.v2.Participant.Role" do
@@ -83,6 +84,33 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
83
84
  repeated :end_user_suggestion_results, :message, 7, "google.cloud.dialogflow.v2.SuggestionResult"
84
85
  optional :dtmf_parameters, :message, 9, "google.cloud.dialogflow.v2.DtmfParameters"
85
86
  end
87
+ add_message "google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest" do
88
+ optional :participant, :string, 1
89
+ optional :reply_audio_config, :message, 4, "google.cloud.dialogflow.v2.OutputAudioConfig"
90
+ optional :query_params, :message, 7, "google.cloud.dialogflow.v2.QueryParameters"
91
+ optional :assist_query_params, :message, 8, "google.cloud.dialogflow.v2.AssistQueryParameters"
92
+ optional :cx_parameters, :message, 13, "google.protobuf.Struct"
93
+ optional :enable_partial_automated_agent_reply, :bool, 12
94
+ oneof :config do
95
+ optional :audio_config, :message, 2, "google.cloud.dialogflow.v2.InputAudioConfig"
96
+ optional :text_config, :message, 3, "google.cloud.dialogflow.v2.InputTextConfig"
97
+ end
98
+ oneof :input do
99
+ optional :input_audio, :bytes, 5
100
+ optional :input_text, :string, 6
101
+ optional :input_dtmf, :message, 9, "google.cloud.dialogflow.v2.TelephonyDtmfEvents"
102
+ end
103
+ end
104
+ add_message "google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse" do
105
+ optional :recognition_result, :message, 1, "google.cloud.dialogflow.v2.StreamingRecognitionResult"
106
+ optional :reply_text, :string, 2
107
+ optional :reply_audio, :message, 3, "google.cloud.dialogflow.v2.OutputAudio"
108
+ optional :automated_agent_reply, :message, 4, "google.cloud.dialogflow.v2.AutomatedAgentReply"
109
+ optional :message, :message, 6, "google.cloud.dialogflow.v2.Message"
110
+ repeated :human_agent_suggestion_results, :message, 7, "google.cloud.dialogflow.v2.SuggestionResult"
111
+ repeated :end_user_suggestion_results, :message, 8, "google.cloud.dialogflow.v2.SuggestionResult"
112
+ optional :dtmf_parameters, :message, 10, "google.cloud.dialogflow.v2.DtmfParameters"
113
+ end
86
114
  add_message "google.cloud.dialogflow.v2.SuggestArticlesRequest" do
87
115
  optional :parent, :string, 1
88
116
  optional :latest_message, :string, 2
@@ -124,6 +152,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
124
152
  optional :detect_intent_response, :message, 1, "google.cloud.dialogflow.v2.DetectIntentResponse"
125
153
  optional :automated_agent_reply_type, :enum, 7, "google.cloud.dialogflow.v2.AutomatedAgentReply.AutomatedAgentReplyType"
126
154
  optional :allow_cancellation, :bool, 8
155
+ optional :cx_current_page, :string, 11
127
156
  end
128
157
  add_enum "google.cloud.dialogflow.v2.AutomatedAgentReply.AutomatedAgentReplyType" do
129
158
  value :AUTOMATED_AGENT_REPLY_TYPE_UNSPECIFIED, 0
@@ -159,6 +188,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
159
188
  optional :suggest_smart_replies_response, :message, 4, "google.cloud.dialogflow.v2.SuggestSmartRepliesResponse"
160
189
  end
161
190
  end
191
+ add_message "google.cloud.dialogflow.v2.InputTextConfig" do
192
+ optional :language_code, :string, 1
193
+ end
162
194
  add_message "google.cloud.dialogflow.v2.AnnotatedMessagePart" do
163
195
  optional :text, :string, 1
164
196
  optional :entity_type, :string, 2
@@ -189,6 +221,8 @@ module Google
189
221
  AnalyzeContentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AnalyzeContentRequest").msgclass
190
222
  DtmfParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.DtmfParameters").msgclass
191
223
  AnalyzeContentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AnalyzeContentResponse").msgclass
224
+ StreamingAnalyzeContentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest").msgclass
225
+ StreamingAnalyzeContentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse").msgclass
192
226
  SuggestArticlesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestArticlesRequest").msgclass
193
227
  SuggestArticlesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestArticlesResponse").msgclass
194
228
  SuggestFaqAnswersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestFaqAnswersRequest").msgclass
@@ -202,6 +236,7 @@ module Google
202
236
  FaqAnswer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.FaqAnswer").msgclass
203
237
  SmartReplyAnswer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SmartReplyAnswer").msgclass
204
238
  SuggestionResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestionResult").msgclass
239
+ InputTextConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.InputTextConfig").msgclass
205
240
  AnnotatedMessagePart = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AnnotatedMessagePart").msgclass
206
241
  MessageAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.MessageAnnotation").msgclass
207
242
  AssistQueryParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AssistQueryParameters").msgclass
@@ -48,6 +48,22 @@ module Google
48
48
  # sent to virtual agents. See [Versions and
49
49
  # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
50
50
  rpc :AnalyzeContent, ::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest, ::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse
51
+ # Adds a text (chat, for example), or audio (phone recording, for example)
52
+ # message from a participant into the conversation.
53
+ # Note: This method is only available through the gRPC API (not REST).
54
+ #
55
+ # The top-level message sent to the client by the server is
56
+ # `StreamingAnalyzeContentResponse`. Multiple response messages can be
57
+ # returned in order. The first one or more messages contain the
58
+ # `recognition_result` field. Each result represents a more complete
59
+ # transcript of what the user said. The next message contains the
60
+ # `reply_text` field and potentially the `reply_audio` field. The message can
61
+ # also contain the `automated_agent_reply` field.
62
+ #
63
+ # Note: Always use agent versions for production traffic
64
+ # sent to virtual agents. See [Versions and
65
+ # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
66
+ rpc :StreamingAnalyzeContent, stream(::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest), stream(::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse)
51
67
  # Gets suggested articles for a participant based on specific historical
52
68
  # messages.
53
69
  rpc :SuggestArticles, ::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest, ::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse
@@ -75,6 +75,8 @@ module Google
75
75
  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
76
76
  }
77
77
 
78
+ default_config.rpcs.streaming_analyze_content.timeout = 220.0
79
+
78
80
  default_config
79
81
  end
80
82
  yield @configure if block_given?
@@ -647,6 +649,98 @@ module Google
647
649
  raise ::Google::Cloud::Error.from_error(e)
648
650
  end
649
651
 
652
+ ##
653
+ # Adds a text (chat, for example), or audio (phone recording, for example)
654
+ # message from a participant into the conversation.
655
+ # Note: This method is only available through the gRPC API (not REST).
656
+ #
657
+ # The top-level message sent to the client by the server is
658
+ # `StreamingAnalyzeContentResponse`. Multiple response messages can be
659
+ # returned in order. The first one or more messages contain the
660
+ # `recognition_result` field. Each result represents a more complete
661
+ # transcript of what the user said. The next message contains the
662
+ # `reply_text` field and potentially the `reply_audio` field. The message can
663
+ # also contain the `automated_agent_reply` field.
664
+ #
665
+ # Note: Always use agent versions for production traffic
666
+ # sent to virtual agents. See [Versions and
667
+ # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
668
+ #
669
+ # @param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest, ::Hash>]
670
+ # An enumerable of {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest} instances.
671
+ # @param options [::Gapic::CallOptions, ::Hash]
672
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
673
+ #
674
+ # @yield [response, operation] Access the result along with the RPC operation
675
+ # @yieldparam response [::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse>]
676
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
677
+ #
678
+ # @return [::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse>]
679
+ #
680
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
681
+ #
682
+ # @example Basic example
683
+ # require "google/cloud/dialogflow/v2"
684
+ #
685
+ # # Create a client object. The client can be reused for multiple calls.
686
+ # client = Google::Cloud::Dialogflow::V2::Participants::Client.new
687
+ #
688
+ # # Create an input stream
689
+ # input = Gapic::StreamInput.new
690
+ #
691
+ # # Call the streaming_analyze_content method to start streaming.
692
+ # output = client.streaming_analyze_content input
693
+ #
694
+ # # Send requests on the stream. For each request, pass in keyword
695
+ # # arguments to set fields. Be sure to close the stream when done.
696
+ # input << Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest.new
697
+ # input << Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest.new
698
+ # input.close
699
+ #
700
+ # # Handle streamed responses. These may be interleaved with inputs.
701
+ # # Each response is of type ::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse.
702
+ # output.each do |response|
703
+ # p response
704
+ # end
705
+ #
706
+ def streaming_analyze_content request, options = nil
707
+ unless request.is_a? ::Enumerable
708
+ raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
709
+ request = request.to_enum
710
+ end
711
+
712
+ request = request.lazy.map do |req|
713
+ ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest
714
+ end
715
+
716
+ # Converts hash and nil to an options object
717
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
718
+
719
+ # Customize the options with defaults
720
+ metadata = @config.rpcs.streaming_analyze_content.metadata.to_h
721
+
722
+ # Set x-goog-api-client and x-goog-user-project headers
723
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
724
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
725
+ gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
726
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
727
+
728
+ options.apply_defaults timeout: @config.rpcs.streaming_analyze_content.timeout,
729
+ metadata: metadata,
730
+ retry_policy: @config.rpcs.streaming_analyze_content.retry_policy
731
+
732
+ options.apply_defaults timeout: @config.timeout,
733
+ metadata: @config.metadata,
734
+ retry_policy: @config.retry_policy
735
+
736
+ @participants_stub.call_rpc :streaming_analyze_content, request, options: options do |response, operation|
737
+ yield response, operation if block_given?
738
+ return response
739
+ end
740
+ rescue ::GRPC::BadStatus => e
741
+ raise ::Google::Cloud::Error.from_error(e)
742
+ end
743
+
650
744
  ##
651
745
  # Gets suggested articles for a participant based on specific historical
652
746
  # messages.
@@ -1110,6 +1204,11 @@ module Google
1110
1204
  #
1111
1205
  attr_reader :analyze_content
1112
1206
  ##
1207
+ # RPC-specific configuration for `streaming_analyze_content`
1208
+ # @return [::Gapic::Config::Method]
1209
+ #
1210
+ attr_reader :streaming_analyze_content
1211
+ ##
1113
1212
  # RPC-specific configuration for `suggest_articles`
1114
1213
  # @return [::Gapic::Config::Method]
1115
1214
  #
@@ -1137,6 +1236,8 @@ module Google
1137
1236
  @update_participant = ::Gapic::Config::Method.new update_participant_config
1138
1237
  analyze_content_config = parent_rpcs.analyze_content if parent_rpcs.respond_to? :analyze_content
1139
1238
  @analyze_content = ::Gapic::Config::Method.new analyze_content_config
1239
+ streaming_analyze_content_config = parent_rpcs.streaming_analyze_content if parent_rpcs.respond_to? :streaming_analyze_content
1240
+ @streaming_analyze_content = ::Gapic::Config::Method.new streaming_analyze_content_config
1140
1241
  suggest_articles_config = parent_rpcs.suggest_articles if parent_rpcs.respond_to? :suggest_articles
1141
1242
  @suggest_articles = ::Gapic::Config::Method.new suggest_articles_config
1142
1243
  suggest_faq_answers_config = parent_rpcs.suggest_faq_answers if parent_rpcs.respond_to? :suggest_faq_answers
@@ -322,7 +322,7 @@ module Google
322
322
  # If you might use
323
323
  # [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa)
324
324
  # or other CCAI products now or in the future, consider using
325
- # [StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
325
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content StreamingAnalyzeContent}
326
326
  # instead of `StreamingDetectIntent`. `StreamingAnalyzeContent` has
327
327
  # additional functionality for Agent Assist and other CCAI products.
328
328
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dialogflow
23
23
  module V2
24
- VERSION = "0.18.0"
24
+ VERSION = "0.20.0"
25
25
  end
26
26
  end
27
27
  end
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Api
22
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -156,7 +156,7 @@ module Google
156
156
  # @!attribute [rw] disable_no_speech_recognized_event
157
157
  # @return [::Boolean]
158
158
  # Only used in {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} and
159
- # [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent].
159
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}.
160
160
  # If `false` and recognition doesn't return any result, trigger
161
161
  # `NO_SPEECH_RECOGNIZED` event to Dialogflow agent.
162
162
  class InputAudioConfig
@@ -238,16 +238,34 @@ module Google
238
238
  extend ::Google::Protobuf::MessageExts::ClassMethods
239
239
  end
240
240
 
241
+ # A wrapper of repeated TelephonyDtmf digits.
242
+ # @!attribute [rw] dtmf_events
243
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::TelephonyDtmf>]
244
+ # A sequence of TelephonyDtmf digits.
245
+ class TelephonyDtmfEvents
246
+ include ::Google::Protobuf::MessageExts
247
+ extend ::Google::Protobuf::MessageExts::ClassMethods
248
+ end
249
+
241
250
  # Configures speech transcription for {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile}.
242
251
  # @!attribute [rw] speech_model_variant
243
252
  # @return [::Google::Cloud::Dialogflow::V2::SpeechModelVariant]
244
253
  # The speech model used in speech to text.
245
254
  # `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
246
255
  # `USE_ENHANCED`. It can be overridden in {::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest AnalyzeContentRequest} and
247
- # [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest] request.
256
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest StreamingAnalyzeContentRequest} request.
248
257
  # If enhanced model variant is specified and an enhanced
249
258
  # version of the specified model for the language does not exist, then it
250
259
  # would emit an error.
260
+ # @!attribute [rw] model
261
+ # @return [::String]
262
+ # Which Speech model to select. Select the model best suited to your domain
263
+ # to get best results. If a model is not explicitly specified, then a default
264
+ # model is used.
265
+ # Refer to
266
+ # [Cloud Speech API
267
+ # documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)
268
+ # for more details.
251
269
  class SpeechToTextConfig
252
270
  include ::Google::Protobuf::MessageExts
253
271
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -386,6 +404,61 @@ module Google
386
404
  # 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
387
405
  OUTPUT_AUDIO_ENCODING_MULAW = 5
388
406
  end
407
+
408
+ # [DTMF](https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling)
409
+ # digit in Telephony Gateway.
410
+ module TelephonyDtmf
411
+ # Not specified. This value may be used to indicate an absent digit.
412
+ TELEPHONY_DTMF_UNSPECIFIED = 0
413
+
414
+ # Number: '1'.
415
+ DTMF_ONE = 1
416
+
417
+ # Number: '2'.
418
+ DTMF_TWO = 2
419
+
420
+ # Number: '3'.
421
+ DTMF_THREE = 3
422
+
423
+ # Number: '4'.
424
+ DTMF_FOUR = 4
425
+
426
+ # Number: '5'.
427
+ DTMF_FIVE = 5
428
+
429
+ # Number: '6'.
430
+ DTMF_SIX = 6
431
+
432
+ # Number: '7'.
433
+ DTMF_SEVEN = 7
434
+
435
+ # Number: '8'.
436
+ DTMF_EIGHT = 8
437
+
438
+ # Number: '9'.
439
+ DTMF_NINE = 9
440
+
441
+ # Number: '0'.
442
+ DTMF_ZERO = 10
443
+
444
+ # Letter: 'A'.
445
+ DTMF_A = 11
446
+
447
+ # Letter: 'B'.
448
+ DTMF_B = 12
449
+
450
+ # Letter: 'C'.
451
+ DTMF_C = 13
452
+
453
+ # Letter: 'D'.
454
+ DTMF_D = 14
455
+
456
+ # Asterisk/star: '*'.
457
+ DTMF_STAR = 15
458
+
459
+ # Pound/diamond/hash/square/gate/octothorpe: '#'.
460
+ DTMF_POUND = 16
461
+ end
389
462
  end
390
463
  end
391
464
  end
@@ -418,8 +418,8 @@ module Google
418
418
  # and identifies the prevailing subjective opinion, especially to determine
419
419
  # a user's attitude as positive, negative, or neutral:
420
420
  # https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
421
- # For [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent] method, result will be in
422
- # [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
421
+ # For {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent} method, result will be in
422
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
423
423
  # For {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} method, result will be in
424
424
  # {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
425
425
  # For {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages} method, result will be in
@@ -36,6 +36,36 @@ module Google
36
36
  # Optional. Label applied to streams representing this participant in SIPREC
37
37
  # XML metadata and SDP. This is used to assign transcriptions from that
38
38
  # media stream to this participant. This field can be updated.
39
+ # @!attribute [rw] obfuscated_external_user_id
40
+ # @return [::String]
41
+ # Optional. Obfuscated user id that should be associated with the created participant.
42
+ #
43
+ # You can specify a user id as follows:
44
+ #
45
+ # 1. If you set this field in
46
+ # {::Google::Cloud::Dialogflow::V2::CreateParticipantRequest#participant CreateParticipantRequest} or
47
+ # {::Google::Cloud::Dialogflow::V2::UpdateParticipantRequest#participant UpdateParticipantRequest},
48
+ # Dialogflow adds the obfuscated user id with the participant.
49
+ #
50
+ # 2. If you set this field in
51
+ # [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id] or
52
+ # [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
53
+ # Dialogflow will update {::Google::Cloud::Dialogflow::V2::Participant#obfuscated_external_user_id Participant.obfuscated_external_user_id}.
54
+ #
55
+ # Dialogflow returns an error if you try to add a user id for a
56
+ # non-{::Google::Cloud::Dialogflow::V2::Participant::Role::END_USER END_USER} participant.
57
+ #
58
+ # Dialogflow uses this user id for billing and measurement purposes. For
59
+ # example, Dialogflow determines whether a user in one conversation returned
60
+ # in a later conversation.
61
+ #
62
+ # Note:
63
+ #
64
+ # * Please never pass raw user ids to Dialogflow. Always obfuscate your user
65
+ # id first.
66
+ # * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a
67
+ # hash function like SHA-512.
68
+ # * The length of the user id must be <= 256 characters.
39
69
  # @!attribute [rw] documents_metadata_filters
40
70
  # @return [::Google::Protobuf::Map{::String => ::String}]
41
71
  # Optional. Key-value filters on the metadata of documents returned by article
@@ -298,6 +328,166 @@ module Google
298
328
  extend ::Google::Protobuf::MessageExts::ClassMethods
299
329
  end
300
330
 
331
+ # The top-level message sent by the client to the
332
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent} method.
333
+ #
334
+ # Multiple request messages should be sent in order:
335
+ #
336
+ # 1. The first message must contain
337
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#participant participant},
338
+ # [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] and optionally
339
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#query_params query_params}. If you want
340
+ # to receive an audio response, it should also contain
341
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#reply_audio_config reply_audio_config}.
342
+ # The message must not contain
343
+ # [input][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input].
344
+ #
345
+ # 2. If [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message
346
+ # was set to {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#audio_config audio_config},
347
+ # all subsequent messages must contain
348
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#input_audio input_audio} to continue
349
+ # with Speech recognition.
350
+ # However, note that:
351
+ #
352
+ # * Dialogflow will bill you for the audio so far.
353
+ # * Dialogflow discards all Speech recognition results in favor of the
354
+ # text input.
355
+ #
356
+ # 3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message was set
357
+ # to {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#text_config StreamingAnalyzeContentRequest.text_config}, then the second message
358
+ # must contain only {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#input_text input_text}.
359
+ # Moreover, you must not send more than two messages.
360
+ #
361
+ # After you sent all input, you must half-close or abort the request stream.
362
+ # @!attribute [rw] participant
363
+ # @return [::String]
364
+ # Required. The name of the participant this text comes from.
365
+ # Format: `projects/<Project ID>/locations/<Location
366
+ # ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
367
+ # @!attribute [rw] audio_config
368
+ # @return [::Google::Cloud::Dialogflow::V2::InputAudioConfig]
369
+ # Instructs the speech recognizer how to process the speech audio.
370
+ # @!attribute [rw] text_config
371
+ # @return [::Google::Cloud::Dialogflow::V2::InputTextConfig]
372
+ # The natural language text to be processed.
373
+ # @!attribute [rw] reply_audio_config
374
+ # @return [::Google::Cloud::Dialogflow::V2::OutputAudioConfig]
375
+ # Speech synthesis configuration.
376
+ # The speech synthesis settings for a virtual agent that may be configured
377
+ # for the associated conversation profile are not used when calling
378
+ # StreamingAnalyzeContent. If this configuration is not supplied, speech
379
+ # synthesis is disabled.
380
+ # @!attribute [rw] input_audio
381
+ # @return [::String]
382
+ # The input audio content to be recognized. Must be sent if `audio_config`
383
+ # is set in the first message. The complete audio over all streaming
384
+ # messages must not exceed 1 minute.
385
+ # @!attribute [rw] input_text
386
+ # @return [::String]
387
+ # The UTF-8 encoded natural language text to be processed. Must be sent if
388
+ # `text_config` is set in the first message. Text length must not exceed
389
+ # 256 bytes for virtual agent interactions. The `input_text` field can be
390
+ # only sent once.
391
+ # @!attribute [rw] input_dtmf
392
+ # @return [::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents]
393
+ # The DTMF digits used to invoke intent and fill in parameter value.
394
+ #
395
+ # This input is ignored if the previous response indicated that DTMF input
396
+ # is not accepted.
397
+ # @!attribute [rw] query_params
398
+ # @return [::Google::Cloud::Dialogflow::V2::QueryParameters]
399
+ # Parameters for a Dialogflow virtual-agent query.
400
+ # @!attribute [rw] assist_query_params
401
+ # @return [::Google::Cloud::Dialogflow::V2::AssistQueryParameters]
402
+ # Parameters for a human assist query.
403
+ # @!attribute [rw] cx_parameters
404
+ # @return [::Google::Protobuf::Struct]
405
+ # Additional parameters to be put into Dialogflow CX session parameters. To
406
+ # remove a parameter from the session, clients should explicitly set the
407
+ # parameter value to null.
408
+ #
409
+ # Note: this field should only be used if you are connecting to a Dialogflow
410
+ # CX agent.
411
+ # @!attribute [rw] enable_partial_automated_agent_reply
412
+ # @return [::Boolean]
413
+ # Enable partial virtual agent responses. If this flag is not enabled,
414
+ # response stream still contains only one final response even if some
415
+ # `Fulfillment`s in Dialogflow virtual agent have been configured to return
416
+ # partial responses.
417
+ class StreamingAnalyzeContentRequest
418
+ include ::Google::Protobuf::MessageExts
419
+ extend ::Google::Protobuf::MessageExts::ClassMethods
420
+ end
421
+
422
+ # The top-level message returned from the `StreamingAnalyzeContent` method.
423
+ #
424
+ # Multiple response messages can be returned in order:
425
+ #
426
+ # 1. If the input was set to streaming audio, the first one or more messages
427
+ # contain `recognition_result`. Each `recognition_result` represents a more
428
+ # complete transcript of what the user said. The last `recognition_result`
429
+ # has `is_final` set to `true`.
430
+ #
431
+ # 2. In virtual agent stage: if `enable_partial_automated_agent_reply` is
432
+ # true, the following N (currently 1 <= N <= 4) messages
433
+ # contain `automated_agent_reply` and optionally `reply_audio`
434
+ # returned by the virtual agent. The first (N-1)
435
+ # `automated_agent_reply`s will have `automated_agent_reply_type` set to
436
+ # `PARTIAL`. The last `automated_agent_reply` has
437
+ # `automated_agent_reply_type` set to `FINAL`.
438
+ # If `enable_partial_automated_agent_reply` is not enabled, response stream
439
+ # only contains the final reply.
440
+ #
441
+ # In human assist stage: the following N (N >= 1) messages contain
442
+ # `human_agent_suggestion_results`, `end_user_suggestion_results` or
443
+ # `message`.
444
+ # @!attribute [rw] recognition_result
445
+ # @return [::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult]
446
+ # The result of speech recognition.
447
+ # @!attribute [rw] reply_text
448
+ # @return [::String]
449
+ # The output text content.
450
+ # This field is set if an automated agent responded with a text for the user.
451
+ # @!attribute [rw] reply_audio
452
+ # @return [::Google::Cloud::Dialogflow::V2::OutputAudio]
453
+ # The audio data bytes encoded as specified in the request.
454
+ # This field is set if:
455
+ #
456
+ # - The `reply_audio_config` field is specified in the request.
457
+ # - The automated agent, which this output comes from, responded with audio.
458
+ # In such case, the `reply_audio.config` field contains settings used to
459
+ # synthesize the speech.
460
+ #
461
+ # In some scenarios, multiple output audio fields may be present in the
462
+ # response structure. In these cases, only the top-most-level audio output
463
+ # has content.
464
+ # @!attribute [rw] automated_agent_reply
465
+ # @return [::Google::Cloud::Dialogflow::V2::AutomatedAgentReply]
466
+ # Only set if a Dialogflow automated agent has responded.
467
+ # Note that: [AutomatedAgentReply.detect_intent_response.output_audio][]
468
+ # and [AutomatedAgentReply.detect_intent_response.output_audio_config][]
469
+ # are always empty, use {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#reply_audio reply_audio} instead.
470
+ # @!attribute [rw] message
471
+ # @return [::Google::Cloud::Dialogflow::V2::Message]
472
+ # Message analyzed by CCAI.
473
+ # @!attribute [rw] human_agent_suggestion_results
474
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
475
+ # The suggestions for most recent human agent. The order is the same as
476
+ # {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs} of
477
+ # {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#human_agent_suggestion_config HumanAgentAssistantConfig.human_agent_suggestion_config}.
478
+ # @!attribute [rw] end_user_suggestion_results
479
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
480
+ # The suggestions for end user. The order is the same as
481
+ # {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs} of
482
+ # {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#end_user_suggestion_config HumanAgentAssistantConfig.end_user_suggestion_config}.
483
+ # @!attribute [rw] dtmf_parameters
484
+ # @return [::Google::Cloud::Dialogflow::V2::DtmfParameters]
485
+ # Indicates the parameters of DTMF.
486
+ class StreamingAnalyzeContentResponse
487
+ include ::Google::Protobuf::MessageExts
488
+ extend ::Google::Protobuf::MessageExts::ClassMethods
489
+ end
490
+
301
491
  # The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
302
492
  # @!attribute [rw] parent
303
493
  # @return [::String]
@@ -474,6 +664,11 @@ module Google
474
664
  # Indicates whether the partial automated agent reply is interruptible when a
475
665
  # later reply message arrives. e.g. if the agent specified some music as
476
666
  # partial response, it can be cancelled.
667
+ # @!attribute [rw] cx_current_page
668
+ # @return [::String]
669
+ # The unique identifier of the current Dialogflow CX conversation page.
670
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
671
+ # ID>/flows/<Flow ID>/pages/<Page ID>`.
477
672
  class AutomatedAgentReply
478
673
  include ::Google::Protobuf::MessageExts
479
674
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -613,6 +808,17 @@ module Google
613
808
  extend ::Google::Protobuf::MessageExts::ClassMethods
614
809
  end
615
810
 
811
+ # Defines the language used in the input text.
812
+ # @!attribute [rw] language_code
813
+ # @return [::String]
814
+ # Required. The language of this conversational query. See [Language
815
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language)
816
+ # for a list of the currently supported language codes.
817
+ class InputTextConfig
818
+ include ::Google::Protobuf::MessageExts
819
+ extend ::Google::Protobuf::MessageExts::ClassMethods
820
+ end
821
+
616
822
  # Represents a part of a message possibly annotated with an entity. The part
617
823
  # can be an entity or purely a part of the message between two entities or
618
824
  # message start/end.
@@ -623,7 +623,7 @@ module Google
623
623
  # [Participants.StreamingDetectIntent][], it needs to be configured in
624
624
  # {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_params StreamingDetectIntentRequest.query_params}.
625
625
  # And for {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} and
626
- # [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent], it needs to be configured in
626
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}, it needs to be configured in
627
627
  # {::Google::Cloud::Dialogflow::V2::ConversationProfile#human_agent_assistant_config ConversationProfile.human_agent_assistant_config}
628
628
  # @!attribute [rw] query_text_sentiment
629
629
  # @return [::Google::Cloud::Dialogflow::V2::Sentiment]
@@ -634,7 +634,9 @@ module Google
634
634
  end
635
635
 
636
636
  # The sentiment, such as positive/negative feeling or association, for a unit
637
- # of analysis, such as the query text.
637
+ # of analysis, such as the query text. See:
638
+ # https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values
639
+ # for how to interpret the result.
638
640
  # @!attribute [rw] score
639
641
  # @return [::Float]
640
642
  # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.18.0
4
+ version: 0.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-10-03 00:00:00.000000000 Z
11
+ date: 2022-12-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -312,7 +312,9 @@ files:
312
312
  - lib/google/cloud/dialogflow/v2/versions/paths.rb
313
313
  - lib/google/cloud/dialogflow/v2/webhook_pb.rb
314
314
  - proto_docs/README.md
315
+ - proto_docs/google/api/client.rb
315
316
  - proto_docs/google/api/field_behavior.rb
317
+ - proto_docs/google/api/launch_stage.rb
316
318
  - proto_docs/google/api/resource.rb
317
319
  - proto_docs/google/cloud/dialogflow/v2/agent.rb
318
320
  - proto_docs/google/cloud/dialogflow/v2/answer_record.rb