google-cloud-dialogflow-v2 1.0.0 → 1.1.0

data/proto_docs/google/cloud/dialogflow/v2/conversation.rb

@@ -27,7 +27,7 @@ module Google
         # include phone calls and text-based chat sessions.
         # @!attribute [r] name
         #   @return [::String]
-        #     Output only. The unique identifier of this conversation.
+        #     Output only. Identifier. The unique identifier of this conversation.
         #     Format: `projects/<Project ID>/locations/<Location
         #     ID>/conversations/<Conversation ID>`.
         # @!attribute [r] lifecycle_state
@@ -51,8 +51,8 @@ module Google
         #     Output only. The time the conversation was finished.
         # @!attribute [rw] conversation_stage
         #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage]
-        #     The stage of a conversation. It indicates whether the virtual agent or a
-        #     human agent is handling the conversation.
+        #     Optional. The stage of a conversation. It indicates whether the virtual
+        #     agent or a human agent is handling the conversation.
         #
         #     If the conversation is created with the conversation profile that has
         #     Dialogflow config set, defaults to
@@ -142,18 +142,9 @@ module Google
         #     Optional. The next_page_token value returned from a previous list request.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     A filter expression that filters conversations listed in the response. In
-        #     general, the expression must specify the field name, a comparison operator,
-        #     and the value to use for filtering:
-        #     <ul>
-        #       <li>The value must be a string, a number, or a boolean.</li>
-        #       <li>The comparison operator must be either `=`,`!=`, `>`, or `<`.</li>
-        #       <li>To filter on multiple expressions, separate the
-        #           expressions with `AND` or `OR` (omitting both implies `AND`).</li>
-        #       <li>For clarity, expressions can be enclosed in parentheses.</li>
-        #     </ul>
-        #     Only `lifecycle_state` can be filtered on in this way. For example,
-        #     the following expression only returns `COMPLETED` conversations:
+        #     Optional. A filter expression that filters conversations listed in the
+        #     response. Only `lifecycle_state` can be filtered on in this way. For
+        #     example, the following expression only returns `COMPLETED` conversations:
         #
         #     `lifecycle_state = "COMPLETED"`
         #
@@ -267,7 +258,7 @@ module Google
         #     ID>/conversations/<Conversation ID>`.
         # @!attribute [rw] latest_message
         #   @return [::String]
-        #     The name of the latest conversation message used as context for
+        #     Optional. The name of the latest conversation message used as context for
         #     compiling suggestion. If empty, the latest message of the conversation will
         #     be used.
         #
@@ -275,12 +266,13 @@ module Google
         #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.
         # @!attribute [rw] context_size
         #   @return [::Integer]
-        #     Max number of messages prior to and including
+        #     Optional. Max number of messages prior to and including
         #     [latest_message] to use as context when compiling the
         #     suggestion. By default 500 and at most 1000.
         # @!attribute [rw] assist_query_params
         #   @return [::Google::Cloud::Dialogflow::V2::AssistQueryParameters]
-        #     Parameters for a human assist query. Only used for POC/demo purpose.
+        #     Optional. Parameters for a human assist query. Only used for POC/demo
+        #     purpose.
         class SuggestConversationSummaryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -353,13 +345,13 @@ module Google
         #     Optional fields: \\{agent_assistant_config}
         # @!attribute [rw] latest_message
         #   @return [::String]
-        #     The name of the latest conversation message used as context for
+        #     Optional. The name of the latest conversation message used as context for
         #     generating a Summary. If empty, the latest message of the conversation will
         #     be used. The format is specific to the user and the names of the messages
         #     provided.
         # @!attribute [rw] max_context_size
         #   @return [::Integer]
-        #     Max number of messages prior to and including
+        #     Optional. Max number of messages prior to and including
         #     [latest_message] to use as context when compiling the
         #     suggestion. By default 500 and at most 1000.
         class GenerateStatelessSummaryRequest
@@ -433,11 +425,47 @@ module Google
           end
         end
 
+        # The request message for
+        # {::Google::Cloud::Dialogflow::V2::Conversations::Client#generate_stateless_suggestion Conversations.GenerateStatelessSuggestion}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource to charge for the Suggestion's generation.
+        #     Format: `projects/<Project ID>/locations/<Location ID>`.
+        # @!attribute [rw] generator
+        #   @return [::Google::Cloud::Dialogflow::V2::Generator]
+        #     Uncreated generator. It should be a complete generator that includes all
+        #     information about the generator.
+        # @!attribute [rw] generator_name
+        #   @return [::String]
+        #     The resource name of the existing created generator. Format:
+        #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
+        # @!attribute [rw] conversation_context
+        #   @return [::Google::Cloud::Dialogflow::V2::ConversationContext]
+        #     Optional. Context of the conversation, including transcripts.
+        # @!attribute [rw] trigger_events
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::TriggerEvent>]
+        #     Optional. A list of trigger events. Generator will be triggered only if
+        #     it's trigger event is included here.
+        class GenerateStatelessSuggestionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for
+        # {::Google::Cloud::Dialogflow::V2::Conversations::Client#generate_stateless_suggestion Conversations.GenerateStatelessSuggestion}.
+        # @!attribute [rw] generator_suggestion
+        #   @return [::Google::Cloud::Dialogflow::V2::GeneratorSuggestion]
+        #     Required. Generated suggestion for a conversation.
+        class GenerateStatelessSuggestionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The request message for
         # {::Google::Cloud::Dialogflow::V2::Conversations::Client#search_knowledge Conversations.SearchKnowledge}.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     The parent resource contains the conversation profile
+        #     Required. The parent resource contains the conversation profile
         #     Format: 'projects/<Project ID>' or `projects/<Project
         #     ID>/locations/<Location ID>`.
         # @!attribute [rw] query
@@ -450,7 +478,7 @@ module Google
         #     ID>/conversationProfiles/<Conversation Profile ID>`.
         # @!attribute [rw] session_id
         #   @return [::String]
-        #     The ID of the search session.
+        #     Required. The ID of the search session.
         #     The session_id can be combined with Dialogflow V3 Agent ID retrieved from
         #     conversation profile or on its own to identify a search session. The search
         #     history of the same session will impact the search result. It's up to the
@@ -459,12 +487,12 @@ module Google
         #     not exceed 36 characters.
         # @!attribute [rw] conversation
         #   @return [::String]
-        #     The conversation (between human agent and end user) where the search
-        #     request is triggered. Format: `projects/<Project ID>/locations/<Location
-        #     ID>/conversations/<Conversation ID>`.
+        #     Optional. The conversation (between human agent and end user) where the
+        #     search request is triggered. Format: `projects/<Project
+        #     ID>/locations/<Location ID>/conversations/<Conversation ID>`.
         # @!attribute [rw] latest_message
         #   @return [::String]
-        #     The name of the latest conversation message when the request is
+        #     Optional. The name of the latest conversation message when the request is
         #     triggered.
         #     Format: `projects/<Project ID>/locations/<Location
         #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.

data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb

@@ -257,10 +257,19 @@ module Google
           #     can prevent those queries from being stored at answer records.
           #
           #     Supported features: KNOWLEDGE_SEARCH.
+          # @!attribute [rw] enable_query_suggestion_when_no_answer
+          #   @return [::Boolean]
+          #     Optional. Enable query suggestion even if we can't find its answer.
+          #     By default, queries are suggested only if we find its answer.
+          #     Supported features: KNOWLEDGE_ASSIST
           # @!attribute [rw] enable_conversation_augmented_query
           #   @return [::Boolean]
           #     Optional. Enable including conversation context during query answer
           #     generation. Supported features: KNOWLEDGE_SEARCH.
+          # @!attribute [rw] enable_query_suggestion_only
+          #   @return [::Boolean]
+          #     Optional. Enable query suggestion only.
+          #     Supported features: KNOWLEDGE_ASSIST
           # @!attribute [rw] suggestion_trigger_settings
           #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
           #     Settings of suggestion trigger.
@@ -297,6 +306,19 @@ module Google
           #     If `group_suggestion_responses` set to true. All the suggestions to the
           #     same participant based on the same context will be grouped into a single
           #     Pub/Sub event or StreamingAnalyzeContentResponse.
+          # @!attribute [rw] generators
+          #   @return [::Array<::String>]
+          #     Optional. List of various generator resource names used in the
+          #     conversation profile.
+          # @!attribute [rw] disable_high_latency_features_sync_delivery
+          #   @return [::Boolean]
+          #     Optional. When disable_high_latency_features_sync_delivery is true and
+          #     using the AnalyzeContent API, we will not deliver the responses from high
+          #     latency features in the API response. The
+          #     human_agent_assistant_config.notification_config must be configured and
+          #     enable_event_based_suggestion must be set to true to receive the
+          #     responses from high latency features in Pub/Sub. High latency feature(s):
+          #     KNOWLEDGE_ASSIST
           class SuggestionConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -555,7 +577,7 @@ module Google
         # to get access.
         # @!attribute [rw] live_person_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::LivePersonConfig]
-        #     Uses LivePerson (https://www.liveperson.com).
+        #     Uses [LivePerson](https://www.liveperson.com).
         # @!attribute [rw] salesforce_live_agent_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::SalesforceLiveAgentConfig]
         #     Uses Salesforce Live Agent.
@@ -563,7 +585,7 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Configuration specific to LivePerson (https://www.liveperson.com).
+          # Configuration specific to [LivePerson](https://www.liveperson.com).
           # @!attribute [rw] account_number
           #   @return [::String]
           #     Required. Account number of the LivePerson account to connect. This is
@@ -672,6 +694,9 @@ module Google
 
             # Run knowledge search with text input from agent or text generated query.
             KNOWLEDGE_SEARCH = 14
+
+            # Run knowledge assist with automatic query generation.
+            KNOWLEDGE_ASSIST = 15
           end
         end
 

data/proto_docs/google/cloud/dialogflow/v2/encryption_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 V2
+        # The request to get location-level encryption specification.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the encryption spec resource to get.
+        class GetEncryptionSpecRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A customer-managed encryption key specification that can be applied to all
+        # created resources (e.g. Conversation).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The resource name of the encryption key specification resource.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/encryptionSpec
+        # @!attribute [rw] kms_key
+        #   @return [::String]
+        #     Required. The name of customer-managed encryption key that is used to
+        #     secure a resource and its sub-resources. If empty, the resource is secured
+        #     by the default Google encryption key. Only the key in the same location as
+        #     this resource is allowed to be used for encryption. Format:
+        #     `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+        class EncryptionSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request to initialize a location-level encryption specification.
+        # @!attribute [rw] encryption_spec
+        #   @return [::Google::Cloud::Dialogflow::V2::EncryptionSpec]
+        #     Required. The encryption spec used for CMEK encryption. It is required that
+        #     the kms key is in the same region as the endpoint. The same key will be
+        #     used for all provisioned resources, if encryption is available. If the
+        #     kms_key_name is left empty, no encryption will be enforced.
+        class InitializeEncryptionSpecRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response to initialize a location-level encryption specification.
+        class InitializeEncryptionSpecResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for initializing a location-level encryption specification.
+        # @!attribute [r] request
+        #   @return [::Google::Cloud::Dialogflow::V2::InitializeEncryptionSpecRequest]
+        #     Output only. The original request for initialization.
+        class InitializeEncryptionSpecMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end