google-cloud-dialogflow-cx-v3 0.1.1 → 0.4.0

data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb

@@ -112,7 +112,7 @@ module Google
           # Multiple request messages should be sent in order:
           #
           # 1.  The first message must contain
-          # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
+          #     {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
           #     {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} plus optionally
           #     {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_params query_params}. If the client
           #     wants to receive an audio response, it should also contain
@@ -173,21 +173,29 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # The top-level message returned from the `StreamingDetectIntent` method.
+          # The top-level message returned from the
+          # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent StreamingDetectIntent} method.
           #
-          # Multiple response messages can be returned in order:
+          # Multiple response messages (N) can be returned in order.
           #
-          # 1.  If the input was set to streaming audio, the first one or more messages
-          #     contain `recognition_result`. Each `recognition_result` represents a more
-          #     complete transcript of what the user said. The last `recognition_result`
-          #     has `is_final` set to `true`.
+          # The first (N-1) responses set either the `recognition_result` or
+          # `detect_intent_response` field, depending on the request:
           #
-          # 2.  If `enable_partial_response` is true, the following N messages
-          #     (currently 1 <= N <= 4) contain `detect_intent_response`. The first (N-1)
-          #     `detect_intent_response`s will have `response_type` set to `PARTIAL`.
-          #     The last `detect_intent_response` has `response_type` set to `FINAL`.
-          #     If `response_type` is false, response stream only contains
-          #     the final `detect_intent_response`.
+          # *   If the `StreamingDetectIntentRequest.query_input.audio` field was
+          #     set, and the `StreamingDetectIntentRequest.enable_partial_response`
+          #     field was false, the `recognition_result` field is populated for each
+          #     of the (N-1) responses.
+          #     See the {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult StreamingRecognitionResult} message for details
+          #     about the result message sequence.
+          #
+          # *   If the `StreamingDetectIntentRequest.enable_partial_response` field was
+          #     true, the `detect_intent_response` field is populated for each
+          #     of the (N-1) responses, where 1 <= N <= 4.
+          #     These responses set the {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} field
+          #     to `PARTIAL`.
+          #
+          # For the final Nth response message, the `detect_intent_response` is fully
+          # populated, and {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} is set to `FINAL`.
           # @!attribute [rw] recognition_result
           #   @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult]
           #     The result of speech recognition.
@@ -203,35 +211,39 @@ module Google
           # that is currently being processed or an indication that this is the end
           # of the single requested utterance.
           #
-          # Example:
-          #
-          # 1.  transcript: "tube"
-          #
-          # 2.  transcript: "to be a"
-          #
-          # 3.  transcript: "to be"
-          #
-          # 4.  transcript: "to be or not to be"
-          #     is_final: true
-          #
-          # 5.  transcript: " that's"
-          #
-          # 6.  transcript: " that is"
-          #
-          # 7.  message_type: `END_OF_SINGLE_UTTERANCE`
-          #
-          # 8.  transcript: " that is the question"
-          #     is_final: true
-          #
-          # Only two of the responses contain final results (#4 and #8 indicated by
-          # `is_final: true`). Concatenating these generates the full transcript: "to be
-          # or not to be that is the question".
-          #
-          # In each response we populate:
-          #
-          # *  for `TRANSCRIPT`: `transcript` and possibly `is_final`.
-          #
-          # *  for `END_OF_SINGLE_UTTERANCE`: only `message_type`.
+          # While end-user audio is being processed, Dialogflow sends a series of
+          # results. Each result may contain a `transcript` value. A transcript
+          # represents a portion of the utterance. While the recognizer is processing
+          # audio, transcript values may be interim values or finalized values.
+          # Once a transcript is finalized, the `is_final` value is set to true and
+          # processing continues for the next transcript.
+          #
+          # If `StreamingDetectIntentRequest.query_input.audio.config.single_utterance`
+          # was true, and the recognizer has completed processing audio,
+          # the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the
+          # following (last) result contains the last finalized transcript.
+          #
+          # The complete end-user utterance is determined by concatenating the
+          # finalized transcript values received for the series of results.
+          #
+          # In the following example, single utterance is enabled. In the case where
+          # single utterance is not enabled, result 7 would not occur.
+          #
+          # ```
+          # Num | transcript              | message_type            | is_final
+          # --- | ----------------------- | ----------------------- | --------
+          # 1   | "tube"                  | TRANSCRIPT              | false
+          # 2   | "to be a"               | TRANSCRIPT              | false
+          # 3   | "to be"                 | TRANSCRIPT              | false
+          # 4   | "to be or not to be"    | TRANSCRIPT              | true
+          # 5   | "that's"                | TRANSCRIPT              | false
+          # 6   | "that is                | TRANSCRIPT              | false
+          # 7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
+          # 8   | " that is the question" | TRANSCRIPT              | true
+          # ```
+          #
+          # Concatenating the finalized transcripts with `is_final` set to true,
+          # the complete utterance becomes "to be or not to be that is the question".
           # @!attribute [rw] message_type
           #   @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult::MessageType]
           #     Type of the result message.
@@ -463,6 +475,10 @@ module Google
           #   @return [::String]
           #     If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will contain
           #     the name of the event.
+          # @!attribute [rw] dtmf
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::DtmfInput]
+          #     If a [DTMF][DTMFInput] was provided as input, this field will contain
+          #     a copy of the [DTMFInput][].
           # @!attribute [rw] language_code
           #   @return [::String]
           #     The language that was triggered during intent detection.

data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb

@@ -666,6 +666,7 @@ module Google
 
           # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#export_test_cases TestCases.ExportTestCases} long running
           # operation.
+          # This message currently has no fields.
           class ExportTestCasesMetadata
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb

@@ -175,6 +175,49 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#compare_versions Versions.CompareVersions}.
+          # @!attribute [rw] base_version
+          #   @return [::String]
+          #     Required. Name of the base flow version to compare with the target version. Use
+          #     version ID `0` to indicate the draft version of the specified flow.
+          #
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/
+          #     <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
+          # @!attribute [rw] target_version
+          #   @return [::String]
+          #     Required. Name of the target flow version to compare with the
+          #     base version. Use version ID `0` to indicate the draft version of the
+          #     specified flow. Format: `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to compare the flow versions for.
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/docs/reference/language) are
+          #     supported. Note: languages must be enabled in the agent before they can be
+          #     used.
+          class CompareVersionsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#compare_versions Versions.CompareVersions}.
+          # @!attribute [rw] base_version_content_json
+          #   @return [::String]
+          #     JSON representation of the base version content.
+          # @!attribute [rw] target_version_content_json
+          #   @return [::String]
+          #     JSON representation of the target version content.
+          # @!attribute [rw] compare_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp when the two version compares.
+          class CompareVersionsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb

@@ -69,6 +69,19 @@ module Google
             #   @return [::Google::Protobuf::Map{::String => ::String}]
             #     The HTTP request headers to send together with webhook
             #     requests.
+            # @!attribute [rw] allowed_ca_certs
+            #   @return [::Array<::String>]
+            #     Optional. Specifies a list of allowed custom CA certificates (in DER format) for
+            #     HTTPS verification. This overrides the default SSL trust store. If this
+            #     is empty or unspecified, Dialogflow will use Google's default trust store
+            #     to verify certificates.
+            #     N.B. Make sure the HTTPS server certificates are signed with "subject alt
+            #     name". For instance a certificate can be self-signed using the following
+            #     command,
+            #        openssl x509 -req -days 200 -in example.com.csr \
+            #          -signkey example.com.key \
+            #          -out example.com.crt \
+            #          -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
             class GenericWebService
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dialogflow-cx-v3
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -185,6 +185,18 @@ files:
 - lib/google/cloud/dialogflow/cx/v3/agents/operations.rb
 - lib/google/cloud/dialogflow/cx/v3/agents/paths.rb
 - lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/changelog_services_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/changelogs.rb
+- lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb
+- lib/google/cloud/dialogflow/cx/v3/changelogs/credentials.rb
+- lib/google/cloud/dialogflow/cx/v3/changelogs/paths.rb
+- lib/google/cloud/dialogflow/cx/v3/deployment_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/deployments.rb
+- lib/google/cloud/dialogflow/cx/v3/deployments/client.rb
+- lib/google/cloud/dialogflow/cx/v3/deployments/credentials.rb
+- lib/google/cloud/dialogflow/cx/v3/deployments/paths.rb
 - lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/entity_types.rb
@@ -277,6 +289,8 @@ files:
 - proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/agent.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb
+- proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb
+- proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/environment.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb