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

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Settings for Generative AI.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/generativeSettings`.
+          # @!attribute [rw] fallback_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings]
+          #     Settings for Generative Fallback.
+          # @!attribute [rw] generative_safety_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SafetySettings]
+          #     Settings for Generative Safety.
+          # @!attribute [rw] knowledge_connector_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::KnowledgeConnectorSettings]
+          #     Settings for knowledge connector.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     Language for this settings.
+          class GenerativeSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Settings for Generative Fallback.
+            # @!attribute [rw] selected_prompt
+            #   @return [::String]
+            #     Display name of the selected prompt.
+            # @!attribute [rw] prompt_templates
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
+            #     Stored prompts that can be selected, for example default templates like
+            #     "conservative" or "chatty", or user defined ones.
+            class FallbackSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Prompt template.
+              # @!attribute [rw] display_name
+              #   @return [::String]
+              #     Prompt name.
+              # @!attribute [rw] prompt_text
+              #   @return [::String]
+              #     Prompt text that is sent to a LLM on no-match default, placeholders are
+              #     filled downstream. For example: "Here is a conversation $conversation,
+              #     a response is: "
+              # @!attribute [rw] frozen
+              #   @return [::Boolean]
+              #     If the flag is true, the prompt is frozen and cannot be modified by
+              #     users.
+              class PromptTemplate
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Settings for knowledge connector. These parameters are used for LLM prompt
+            # like "You are <agent>. You are a helpful and verbose <agent_identity> at
+            # <business>, <business_description>. Your task is to help humans on
+            # <agent_scope>".
+            # @!attribute [rw] business
+            #   @return [::String]
+            #     Name of the company, organization or other entity that the agent
+            #     represents. Used for knowledge connector LLM prompt and for knowledge
+            #     search.
+            # @!attribute [rw] agent
+            #   @return [::String]
+            #     Name of the virtual agent. Used for LLM prompt. Can be left empty.
+            # @!attribute [rw] agent_identity
+            #   @return [::String]
+            #     Identity of the agent, e.g. "virtual agent", "AI assistant".
+            # @!attribute [rw] business_description
+            #   @return [::String]
+            #     Company description, used for LLM prompt, e.g. "a family company selling
+            #     freshly roasted coffee beans".
+            # @!attribute [rw] agent_scope
+            #   @return [::String]
+            #     Agent scope, e.g. "Example company website", "internal Example
+            #     company website for employees", "manual of car owner".
+            class KnowledgeConnectorSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Dialogflow
-      module Cx
+      module CX
         module V3
           # Import strategies for the conflict resolution of resources (i.e. intents,
           # entities, and webhooks) with identical display names during import

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

@@ -61,8 +61,10 @@ module Google
           #   @return [::Array<::String>]
           #     Ordered list of
           #     {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup `TransitionRouteGroups`}
-          #     associated with the page. Transition route groups must be unique within a
-          #     page.
+          #     added to the page. Transition route groups must be unique within a page. If
+          #     the page links both flow-level transition route groups and agent-level
+          #     transition route groups, the flow-level ones will have higher priority and
+          #     will be put before the agent-level ones.
           #
           #     *   If multiple transition routes within a page scope refer to the same
           #         intent, then the precedence order is: page's transition route -> page's
@@ -104,6 +106,9 @@ module Google
           #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>]
           #     Handlers associated with the page to handle events such as webhook errors,
           #     no match or no input.
+          # @!attribute [rw] knowledge_connector_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings]
+          #     Optional. Knowledge connector configuration.
           class Page
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -270,6 +275,10 @@ module Google
           # @!attribute [r] name
           #   @return [::String]
           #     Output only. The unique identifier of this transition route.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     Optional. The description of the transition route. The maximum length is
+          #     500 characters.
           # @!attribute [rw] intent
           #   @return [::String]
           #     The unique identifier of an {::Google::Cloud::Dialogflow::CX::V3::Intent Intent}.
@@ -499,6 +508,39 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # The Knowledge Connector settings for this page or flow.
+          # This includes information such as the attached Knowledge Bases, and the way
+          # to execute fulfillment.
+          # @!attribute [rw] enabled
+          #   @return [::Boolean]
+          #     Whether Knowledge Connector is enabled or not.
+          # @!attribute [rw] trigger_fulfillment
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
+          #     The fulfillment to be triggered.
+          #
+          #     When the answers from the Knowledge Connector are selected by Dialogflow,
+          #     you can utitlize the request scoped parameter `$request.knowledge.answers`
+          #     (contains up to the 5 highest confidence answers) and
+          #     `$request.knowledge.questions` (contains the corresponding questions) to
+          #     construct the fulfillment.
+          # @!attribute [rw] target_page
+          #   @return [::String]
+          #     The target page to transition to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/pages/<Page ID>`.
+          # @!attribute [rw] target_flow
+          #   @return [::String]
+          #     The target flow to transition to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] data_store_connections
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>]
+          #     Optional. List of related data store connections.
+          class KnowledgeConnectorSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

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

@@ -81,6 +81,10 @@ module Google
           #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall]
           #     A signal that the client should transfer the phone call connected to
           #     this agent to a third-party endpoint.
+          # @!attribute [rw] knowledge_info_card
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::KnowledgeInfoCard]
+          #     Represents info card for knowledge answers, to be better rendered in
+          #     Dialogflow Messenger.
           # @!attribute [rw] response_type
           #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType]
           #     Response type.
@@ -242,6 +246,16 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # Represents info card response. If the response contains generative
+            # knowledge prediction, Dialogflow will return a payload with Infobot
+            # Messenger compatible info card.
+            #
+            # Otherwise, the info card response is skipped.
+            class KnowledgeInfoCard
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Represents different response types.
             module ResponseType
               # Not specified.

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Settings for Generative Safety.
+          # @!attribute [rw] banned_phrases
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SafetySettings::Phrase>]
+          #     Banned phrases for generated text.
+          class SafetySettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Text input which can be used for prompt or banned phrases.
+            # @!attribute [rw] text
+            #   @return [::String]
+            #     Required. Text input which can be used for prompt or banned phrases.
+            # @!attribute [rw] language_code
+            #   @return [::String]
+            #     Required. Language code of the phrase.
+            class Phrase
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -174,6 +174,10 @@ module Google
           #     for Agent Assist traffic), higher value will be ignored and use default.
           #     Setting a value higher than that has no effect. A missing value or
           #     setting to 0 also means we use default TTL.
+          # @!attribute [rw] retention_strategy
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy]
+          #     Specifies the retention behavior defined by
+          #     {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy SecuritySettings.RetentionStrategy}.
           # @!attribute [rw] purge_data_types
           #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>]
           #     List of types of data to remove when retention settings triggers purge.
@@ -184,7 +188,7 @@ module Google
           #     [Participants.StreamingAnalyzeContent][].
           #
           #     If
-          #     [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
+          #     {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings#retention_strategy retention_strategy}
           #     is set to REMOVE_AFTER_CONVERSATION or [audio_export_settings.gcs_bucket][]
           #     is empty, audio export is disabled.
           #
@@ -202,7 +206,7 @@ module Google
           #     completed.
           #
           #     If
-          #     [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
+          #     {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings#retention_strategy retention_strategy}
           #     is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter
           #     what you configure here.
           class SecuritySettings
@@ -279,6 +283,17 @@ module Google
               REDACT_DISK_STORAGE = 2
             end
 
+            # Defines how long we retain persisted data that contains sensitive info.
+            module RetentionStrategy
+              # Retains the persisted data with Dialogflow's internal default 365d TTLs.
+              RETENTION_STRATEGY_UNSPECIFIED = 0
+
+              # Removes data when the conversation ends. If there is no [Conversation][]
+              # explicitly established, a default conversation ends when the
+              # corresponding Dialogflow session ends.
+              REMOVE_AFTER_CONVERSATION = 1
+            end
+
             # Type of data we purge after retention settings triggers purge.
             module PurgeDataType
               # Unspecified. Do not use.

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

@@ -234,7 +234,10 @@ module Google
           #     beginning of the stream.
           # @!attribute [rw] no_speech_timeout
           #   @return [::Google::Protobuf::Duration]
-          #     No speech timeout settings observed at runtime.
+          #     No speech timeout settings for the stream.
+          # @!attribute [rw] endpointing_timeout
+          #   @return [::Google::Protobuf::Duration]
+          #     Speech endpointing timeout settings for the stream.
           # @!attribute [rw] is_input_text
           #   @return [::Boolean]
           #     Whether the streaming terminates with an injected text query.

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

@@ -85,6 +85,9 @@ module Google
 
               # Transition route group.
               TRANSITION_ROUTE_GROUP = 7
+
+              # Agent transition route group.
+              AGENT_TRANSITION_ROUTE_GROUP = 14
             end
 
             # Severity level.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dialogflow-cx-v3
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -219,6 +219,7 @@ files:
 - lib/google/cloud/dialogflow/cx/v3/changelogs/rest.rb
 - lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb
 - lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb
+- lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.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
@@ -270,6 +271,7 @@ files:
 - lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb
 - lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/intent_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/intent_services_pb.rb
@@ -291,6 +293,7 @@ files:
 - lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb
 - lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/rest.rb
+- lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/security_settings_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb
 - lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb
@@ -369,6 +372,7 @@ files:
 - 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/data_store_connection.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
@@ -376,10 +380,12 @@ files:
 - proto_docs/google/cloud/dialogflow/cx/v3/flow.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/gcs.rb
+- proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/import_strategy.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/intent.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/page.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb
+- proto_docs/google/cloud/dialogflow/cx/v3/safety_settings.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/session.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb
@@ -416,7 +422,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Builds conversational interfaces (for example, chatbots, and voice-powered