google-cloud-dialogflow 0.2.3 → 0.3.0

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,9 +28,10 @@ module Google
         # @!attribute [rw] default_language_code
         #   @return [String]
         #     Required. The default language of the agent as a language tag. See
-        #     [Language Support](https://dialogflow.com/docs/reference/language) for a
-        #     list of the currently supported language codes.
-        #     This field cannot be set by the `Update` method.
+        #     [Language
+        #     Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     for a list of the currently supported language codes. This field cannot be
+        #     set by the `Update` method.
         # @!attribute [rw] supported_language_codes
         #   @return [Array<String>]
         #     Optional. The list of all languages supported by this agent (except for the
@@ -48,7 +49,9 @@ module Google
         #   @return [String]
         #     Optional. The URI of the agent's avatar.
         #     Avatars are used throughout the Dialogflow console and in the self-hosted
-        #     [Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.
+        #     [Web
+        #     Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo)
+        #     integration.
         # @!attribute [rw] enable_logging
         #   @return [true, false]
         #     Optional. Determines whether this agent should log conversation queries.
@@ -60,7 +63,7 @@ module Google
         #     Optional. To filter out false positive results and still get variety in
         #     matched natural language inputs for your agent, you can tune the machine
         #     learning classification threshold. If the returned score value is less than
-        #     the threshold value, then a fallback intent is be triggered or, if there
+        #     the threshold value, then a fallback intent will be triggered or, if there
         #     are no fallback intents defined, no intent will be triggered. The score
         #     values range from 0.0 (completely uncertain) to 1.0 (completely certain).
         #     If set to 0.0, the default of 0.3 is used.
@@ -126,9 +129,11 @@ module Google
         #     Format: `projects/<Project ID>`.
         # @!attribute [rw] agent_uri
         #   @return [String]
-        #     Optional. The Google Cloud Storage URI to export the agent to.
-        #     Note: The URI must start with
-        #     "gs://". If left unspecified, the serialized agent is returned inline.
+        #     Optional. The
+        #     [Google Cloud Storage](https://cloud.google.com/storage/docs/)
+        #     URI to export the agent to.
+        #     The format of this URI must be `gs://<bucket-name>/<object-name>`.
+        #     If left unspecified, the serialized agent is returned inline.
         class ExportAgentRequest; end
 
         # The response message for {Google::Cloud::Dialogflow::V2::Agents::ExportAgent Agents::ExportAgent}.
@@ -141,17 +146,17 @@ module Google
         #     The exported agent.
         #
         #     Example for how to export an agent to a zip file via a command line:
-        #
-        #     curl \
-        #       'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:export'\
+        #     <pre>curl \
+        #       'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\
         #       -X POST \
-        #       -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
+        #       -H 'Authorization: Bearer '$(gcloud auth application-default
+        #       print-access-token) \
         #       -H 'Accept: application/json' \
         #       -H 'Content-Type: application/json' \
         #       --compressed \
         #       --data-binary '{}' \
         #     | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".*/\1/' \
-        #     | base64 --decode > <agent zip file>
+        #     | base64 --decode > &lt;agent zip file&gt;</pre>
         class ExportAgentResponse; end
 
         # The request message for {Google::Cloud::Dialogflow::V2::Agents::ImportAgent Agents::ImportAgent}.
@@ -168,17 +173,17 @@ module Google
         #     The agent to import.
         #
         #     Example for how to import an agent via the command line:
-        #
-        #     curl \
-        #       'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:import\
+        #     <pre>curl \
+        #       'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:import\
         #        -X POST \
-        #        -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
+        #        -H 'Authorization: Bearer '$(gcloud auth application-default
+        #        print-access-token) \
         #        -H 'Accept: application/json' \
         #        -H 'Content-Type: application/json' \
         #        --compressed \
         #        --data-binary "{
-        #           'agentContent': '$(cat <agent zip file> | base64 -w 0)'
-        #        }"
+        #           'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)'
+        #        }"</pre>
         class ImportAgentRequest; end
 
         # The request message for {Google::Cloud::Dialogflow::V2::Agents::RestoreAgent Agents::RestoreAgent}.
@@ -195,17 +200,17 @@ module Google
         #     The agent to restore.
         #
         #     Example for how to restore an agent via the command line:
-        #
-        #     curl \
-        #       'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:restore\
+        #     <pre>curl \
+        #       'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:restore\
         #        -X POST \
-        #        -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
+        #        -H 'Authorization: Bearer '$(gcloud auth application-default
+        #        print-access-token) \
         #        -H 'Accept: application/json' \
         #        -H 'Content-Type: application/json' \
         #        --compressed \
         #        --data-binary "{
-        #            'agentContent': '$(cat <agent zip file> | base64 -w 0)'
-        #        }" \
+        #            'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)'
+        #        }"</pre>
         class RestoreAgentRequest; end
       end
     end

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/audio_config.rb

@@ -0,0 +1,120 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        # Description of which voice to use for speech synthesis.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Optional. The name of the voice. If not set, the service will choose a
+        #     voice based on the other parameters such as language_code and gender.
+        # @!attribute [rw] ssml_gender
+        #   @return [Google::Cloud::Dialogflow::V2::SsmlVoiceGender]
+        #     Optional. The preferred gender of the voice. If not set, the service will
+        #     choose a voice based on the other parameters such as language_code and
+        #     name. Note that this is only a preference, not requirement. If a
+        #     voice of the appropriate gender is not available, the synthesizer should
+        #     substitute a voice with a different gender rather than failing the request.
+        class VoiceSelectionParams; end
+
+        # Configuration of how speech should be synthesized.
+        # @!attribute [rw] speaking_rate
+        #   @return [Float]
+        #     Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal
+        #     native speed supported by the specific voice. 2.0 is twice as fast, and
+        #     0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any
+        #     other values < 0.25 or > 4.0 will return an error.
+        # @!attribute [rw] pitch
+        #   @return [Float]
+        #     Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20
+        #     semitones from the original pitch. -20 means decrease 20 semitones from the
+        #     original pitch.
+        # @!attribute [rw] volume_gain_db
+        #   @return [Float]
+        #     Optional. Volume gain (in dB) of the normal native volume supported by the
+        #     specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of
+        #     0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)
+        #     will play at approximately half the amplitude of the normal native signal
+        #     amplitude. A value of +6.0 (dB) will play at approximately twice the
+        #     amplitude of the normal native signal amplitude. We strongly recommend not
+        #     to exceed +10 (dB) as there's usually no effective increase in loudness for
+        #     any value greater than that.
+        # @!attribute [rw] effects_profile_id
+        #   @return [Array<String>]
+        #     Optional. An identifier which selects 'audio effects' profiles that are
+        #     applied on (post synthesized) text to speech. Effects are applied on top of
+        #     each other in the order they are given.
+        # @!attribute [rw] voice
+        #   @return [Google::Cloud::Dialogflow::V2::VoiceSelectionParams]
+        #     Optional. The desired voice of the synthesized audio.
+        class SynthesizeSpeechConfig; end
+
+        # Instructs the speech synthesizer how to generate the output audio content.
+        # @!attribute [rw] audio_encoding
+        #   @return [Google::Cloud::Dialogflow::V2::OutputAudioEncoding]
+        #     Required. Audio encoding of the synthesized audio content.
+        # @!attribute [rw] sample_rate_hertz
+        #   @return [Integer]
+        #     Optional. The synthesis sample rate (in hertz) for this audio. If not
+        #     provided, then the synthesizer will use the default sample rate based on
+        #     the audio encoding. If this is different from the voice's natural sample
+        #     rate, then the synthesizer will honor this request by converting to the
+        #     desired sample rate (which might result in worse audio quality).
+        # @!attribute [rw] synthesize_speech_config
+        #   @return [Google::Cloud::Dialogflow::V2::SynthesizeSpeechConfig]
+        #     Optional. Configuration of how speech should be synthesized.
+        class OutputAudioConfig; end
+
+        # Audio encoding of the output audio format in Text-To-Speech.
+        module OutputAudioEncoding
+          # Not specified.
+          OUTPUT_AUDIO_ENCODING_UNSPECIFIED = 0
+
+          # Uncompressed 16-bit signed little-endian samples (Linear PCM).
+          # Audio content returned as LINEAR16 also contains a WAV header.
+          OUTPUT_AUDIO_ENCODING_LINEAR_16 = 1
+
+          # MP3 audio.
+          OUTPUT_AUDIO_ENCODING_MP3 = 2
+
+          # Opus encoded audio wrapped in an ogg container. The result will be a
+          # file which can be played natively on Android, and in browsers (at least
+          # Chrome and Firefox). The quality of the encoding is considerably higher
+          # than MP3 while using approximately the same bitrate.
+          OUTPUT_AUDIO_ENCODING_OGG_OPUS = 3
+        end
+
+        # Gender of the voice as described in
+        # [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).
+        module SsmlVoiceGender
+          # An unspecified gender, which means that the client doesn't care which
+          # gender the selected voice will have.
+          SSML_VOICE_GENDER_UNSPECIFIED = 0
+
+          # A male voice.
+          SSML_VOICE_GENDER_MALE = 1
+
+          # A female voice.
+          SSML_VOICE_GENDER_FEMALE = 2
+
+          # A gender-neutral voice.
+          SSML_VOICE_GENDER_NEUTRAL = 3
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/context.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,17 +22,21 @@ module Google
         #   @return [String]
         #     Required. The unique identifier of the context. Format:
         #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+        #
+        #     The `Context ID` is always converted to lowercase, may only contain
+        #     characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
         # @!attribute [rw] lifespan_count
         #   @return [Integer]
         #     Optional. The number of conversational query requests after which the
         #     context expires. If set to `0` (the default) the context expires
-        #     immediately. Contexts expire automatically after 10 minutes even if there
+        #     immediately. Contexts expire automatically after 20 minutes if there
         #     are no matching queries.
         # @!attribute [rw] parameters
         #   @return [Google::Protobuf::Struct]
         #     Optional. The collection of parameters associated with this context.
-        #     Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for
-        #     syntax.
+        #     Refer to [this
+        #     doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
+        #     for syntax.
         class Context; end
 
         # The request message for {Google::Cloud::Dialogflow::V2::Contexts::ListContexts Contexts::ListContexts}.

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,13 +22,13 @@ module Google
         # language queries.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required for all methods except `create` (`create` populates the name
-        #     automatically.
-        #     The unique identifier of the entity type. Format:
-        #     `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
+        #     The unique identifier of the entity type.
+        #     Required for {Google::Cloud::Dialogflow::V2::EntityTypes::UpdateEntityType EntityTypes::UpdateEntityType} and
+        #     {Google::Cloud::Dialogflow::V2::EntityTypes::BatchUpdateEntityTypes EntityTypes::BatchUpdateEntityTypes} methods.
+        #     Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
         # @!attribute [rw] display_name
         #   @return [String]
-        #     Required. The name of the entity.
+        #     Required. The name of the entity type.
         # @!attribute [rw] kind
         #   @return [Google::Cloud::Dialogflow::V2::EntityType::Kind]
         #     Required. Indicates the kind of entity type.
@@ -38,23 +38,46 @@ module Google
         #     expanded.
         # @!attribute [rw] entities
         #   @return [Array<Google::Cloud::Dialogflow::V2::EntityType::Entity>]
-        #     Optional. The collection of entities associated with the entity type.
+        #     Optional. The collection of entity entries associated with the entity type.
         class EntityType
-          # Optional. Represents an entity.
+          # An **entity entry** for an associated entity type.
           # @!attribute [rw] value
           #   @return [String]
-          #     Required.
+          #     Required. The primary value associated with this entity entry.
+          #     For example, if the entity type is *vegetable*, the value could be
+          #     *scallions*.
+          #
           #     For `KIND_MAP` entity types:
-          #       A canonical name to be used in place of synonyms.
+          #
+          #     * A canonical value to be used in place of synonyms.
+          #
           #     For `KIND_LIST` entity types:
-          #       A string that can contain references to other entity types (with or
+          #
+          #     * A string that can contain references to other entity types (with or
           #       without aliases).
           # @!attribute [rw] synonyms
           #   @return [Array<String>]
-          #     Required. A collection of synonyms. For `KIND_LIST` entity types this
-          #     must contain exactly one synonym equal to `value`.
+          #     Required. A collection of value synonyms. For example, if the entity type
+          #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
+          #     onions*.
+          #
+          #     For `KIND_LIST` entity types:
+          #
+          #     * This collection must contain exactly one synonym equal to `value`.
           class Entity; end
 
+          # Represents different entity type expansion modes. Automated expansion
+          # allows an agent to recognize values that have not been explicitly listed in
+          # the entity (for example, new kinds of shopping list items).
+          module AutoExpansionMode
+            # Auto expansion disabled for the entity.
+            AUTO_EXPANSION_MODE_UNSPECIFIED = 0
+
+            # Allows an agent to recognize values that have not been explicitly
+            # listed in the entity.
+            AUTO_EXPANSION_MODE_DEFAULT = 1
+          end
+
           # Represents kinds of entities.
           module Kind
             # Not specified. This value should be never used.
@@ -69,18 +92,6 @@ module Google
             # types (with or without aliases).
             KIND_LIST = 2
           end
-
-          # Represents different entity type expansion modes. Automated expansion
-          # allows an agent to recognize values that have not been explicitly listed in
-          # the entity (for example, new kinds of shopping list items).
-          module AutoExpansionMode
-            # Auto expansion disabled for the entity.
-            AUTO_EXPANSION_MODE_UNSPECIFIED = 0
-
-            # Allows an agent to recognize values that have not been explicitly
-            # listed in the entity.
-            AUTO_EXPANSION_MODE_DEFAULT = 1
-          end
         end
 
         # The request message for {Google::Cloud::Dialogflow::V2::EntityTypes::ListEntityTypes EntityTypes::ListEntityTypes}.
@@ -92,9 +103,10 @@ module Google
         #   @return [String]
         #     Optional. The language to list entity synonyms for. If not specified,
         #     the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         # @!attribute [rw] page_size
         #   @return [Integer]
         #     Optional. The maximum number of items to return in a single page. By
@@ -124,9 +136,10 @@ module Google
         #   @return [String]
         #     Optional. The language to retrieve entity synonyms for. If not specified,
         #     the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         class GetEntityTypeRequest; end
 
         # The request message for {Google::Cloud::Dialogflow::V2::EntityTypes::CreateEntityType EntityTypes::CreateEntityType}.
@@ -141,23 +154,24 @@ module Google
         #   @return [String]
         #     Optional. The language of entity synonyms defined in `entity_type`. If not
         #     specified, the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         class CreateEntityTypeRequest; end
 
         # The request message for {Google::Cloud::Dialogflow::V2::EntityTypes::UpdateEntityType EntityTypes::UpdateEntityType}.
         # @!attribute [rw] entity_type
         #   @return [Google::Cloud::Dialogflow::V2::EntityType]
         #     Required. The entity type to update.
-        #     Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
         # @!attribute [rw] language_code
         #   @return [String]
         #     Optional. The language of entity synonyms defined in `entity_type`. If not
         #     specified, the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
         #     Optional. The mask to control which fields get updated.
@@ -183,14 +197,15 @@ module Google
         #     "gs://".
         # @!attribute [rw] entity_type_batch_inline
         #   @return [Google::Cloud::Dialogflow::V2::EntityTypeBatch]
-        #     The collection of entity type to update or create.
+        #     The collection of entity types to update or create.
         # @!attribute [rw] language_code
         #   @return [String]
         #     Optional. The language of entity synonyms defined in `entity_types`. If not
         #     specified, the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
         #     Optional. The mask to control which fields get updated.
@@ -220,31 +235,33 @@ module Google
         #     `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
         # @!attribute [rw] entities
         #   @return [Array<Google::Cloud::Dialogflow::V2::EntityType::Entity>]
-        #     Required. The collection of entities to create.
+        #     Required. The entities to create.
         # @!attribute [rw] language_code
         #   @return [String]
         #     Optional. The language of entity synonyms defined in `entities`. If not
         #     specified, the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         class BatchCreateEntitiesRequest; end
 
-        # The response message for {Google::Cloud::Dialogflow::V2::EntityTypes::BatchCreateEntities EntityTypes::BatchCreateEntities}.
+        # The request message for {Google::Cloud::Dialogflow::V2::EntityTypes::BatchUpdateEntities EntityTypes::BatchUpdateEntities}.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required. The name of the entity type to update the entities in. Format:
-        #     `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
+        #     Required. The name of the entity type to update or create entities in.
+        #     Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
         # @!attribute [rw] entities
         #   @return [Array<Google::Cloud::Dialogflow::V2::EntityType::Entity>]
-        #     Required. The collection of new entities to replace the existing entities.
+        #     Required. The entities to update or create.
         # @!attribute [rw] language_code
         #   @return [String]
         #     Optional. The language of entity synonyms defined in `entities`. If not
         #     specified, the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
         #     Optional. The mask to control which fields get updated.
@@ -264,9 +281,10 @@ module Google
         #   @return [String]
         #     Optional. The language of entity synonyms defined in `entities`. If not
         #     specified, the agent's default language is used.
-        #     [More than a dozen
-        #     languages](https://dialogflow.com/docs/reference/language) are supported.
-        #     Note: languages must be enabled in the agent, before they can be used.
+        #     [Many
+        #     languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
+        #     are supported. Note: languages must be enabled in the agent before they can
+        #     be used.
         class BatchDeleteEntitiesRequest; end
 
         # This message is a wrapper around a collection of entity types.