google-cloud-dialogflow-v2 1.2.0 → 1.4.0

data/lib/google/cloud/dialogflow/v2/webhook_pb.rb

@@ -11,7 +11,7 @@ require 'google/cloud/dialogflow/v2/session_entity_type_pb'
 require 'google/protobuf/struct_pb'
 
 
-descriptor_data = "\n(google/cloud/dialogflow/v2/webhook.proto\x12\x1agoogle.cloud.dialogflow.v2\x1a(google/cloud/dialogflow/v2/context.proto\x1a\'google/cloud/dialogflow/v2/intent.proto\x1a(google/cloud/dialogflow/v2/session.proto\x1a\x34google/cloud/dialogflow/v2/session_entity_type.proto\x1a\x1cgoogle/protobuf/struct.proto\"\xd6\x01\n\x0eWebhookRequest\x12\x0f\n\x07session\x18\x04 \x01(\t\x12\x13\n\x0bresponse_id\x18\x01 \x01(\t\x12=\n\x0cquery_result\x18\x02 \x01(\x0b\x32\'.google.cloud.dialogflow.v2.QueryResult\x12_\n\x1eoriginal_detect_intent_request\x18\x03 \x01(\x0b\x32\x37.google.cloud.dialogflow.v2.OriginalDetectIntentRequest\"\x80\x03\n\x0fWebhookResponse\x12\x18\n\x10\x66ulfillment_text\x18\x01 \x01(\t\x12H\n\x14\x66ulfillment_messages\x18\x02 \x03(\x0b\x32*.google.cloud.dialogflow.v2.Intent.Message\x12\x0e\n\x06source\x18\x03 \x01(\t\x12(\n\x07payload\x18\x04 \x01(\x0b\x32\x17.google.protobuf.Struct\x12<\n\x0foutput_contexts\x18\x05 \x03(\x0b\x32#.google.cloud.dialogflow.v2.Context\x12\x44\n\x14\x66ollowup_event_input\x18\x06 \x01(\x0b\x32&.google.cloud.dialogflow.v2.EventInput\x12K\n\x14session_entity_types\x18\n \x03(\x0b\x32-.google.cloud.dialogflow.v2.SessionEntityType\"h\n\x1bOriginalDetectIntentRequest\x12\x0e\n\x06source\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12(\n\x07payload\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructB\x95\x01\n\x1e\x63om.google.cloud.dialogflow.v2B\x0cWebhookProtoP\x01Z>cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb\xf8\x01\x01\xa2\x02\x02\x44\x46\xaa\x02\x1aGoogle.Cloud.Dialogflow.V2b\x06proto3"
+descriptor_data = "\n(google/cloud/dialogflow/v2/webhook.proto\x12\x1agoogle.cloud.dialogflow.v2\x1a(google/cloud/dialogflow/v2/context.proto\x1a\'google/cloud/dialogflow/v2/intent.proto\x1a(google/cloud/dialogflow/v2/session.proto\x1a\x34google/cloud/dialogflow/v2/session_entity_type.proto\x1a\x1cgoogle/protobuf/struct.proto\"\xd6\x01\n\x0eWebhookRequest\x12\x0f\n\x07session\x18\x04 \x01(\t\x12\x13\n\x0bresponse_id\x18\x01 \x01(\t\x12=\n\x0cquery_result\x18\x02 \x01(\x0b\x32\'.google.cloud.dialogflow.v2.QueryResult\x12_\n\x1eoriginal_detect_intent_request\x18\x03 \x01(\x0b\x32\x37.google.cloud.dialogflow.v2.OriginalDetectIntentRequest\"\x80\x03\n\x0fWebhookResponse\x12\x18\n\x10\x66ulfillment_text\x18\x01 \x01(\t\x12H\n\x14\x66ulfillment_messages\x18\x02 \x03(\x0b\x32*.google.cloud.dialogflow.v2.Intent.Message\x12\x0e\n\x06source\x18\x03 \x01(\t\x12(\n\x07payload\x18\x04 \x01(\x0b\x32\x17.google.protobuf.Struct\x12<\n\x0foutput_contexts\x18\x05 \x03(\x0b\x32#.google.cloud.dialogflow.v2.Context\x12\x44\n\x14\x66ollowup_event_input\x18\x06 \x01(\x0b\x32&.google.cloud.dialogflow.v2.EventInput\x12K\n\x14session_entity_types\x18\n \x03(\x0b\x32-.google.cloud.dialogflow.v2.SessionEntityType\"h\n\x1bOriginalDetectIntentRequest\x12\x0e\n\x06source\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12(\n\x07payload\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructB\x92\x01\n\x1e\x63om.google.cloud.dialogflow.v2B\x0cWebhookProtoP\x01Z>cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb\xa2\x02\x02\x44\x46\xaa\x02\x1aGoogle.Cloud.Dialogflow.V2b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 

data/proto_docs/google/api/client.rb

@@ -28,6 +28,9 @@ module Google
     # @!attribute [rw] destinations
     #   @return [::Array<::Google::Api::ClientLibraryDestination>]
     #     The destination where API teams want this client library to be published.
+    # @!attribute [rw] selective_gapic_generation
+    #   @return [::Google::Api::SelectiveGapicGeneration]
+    #     Configuration for which RPCs should be generated in the GAPIC client.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
       #     enabled. By default, asynchronous REST clients will not be generated.
       #     This feature will be enabled by default 1 month after launching the
       #     feature in preview packages.
+      # @!attribute [rw] protobuf_pythonic_types_enabled
+      #   @return [::Boolean]
+      #     Enables generation of protobuf code using new types that are more
+      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+      #     enabled by default 1 month after launching the feature in preview
+      #     packages.
       class ExperimentalFeatures
         include ::Google::Protobuf::MessageExts
         extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -375,6 +384,17 @@ module Google
       end
     end
 
+    # This message is used to configure the generation of a subset of the RPCs in
+    # a service for client libraries.
+    # @!attribute [rw] methods
+    #   @return [::Array<::String>]
+    #     An allowlist of the fully qualified names of RPCs that should be included
+    #     on public client surfaces.
+    class SelectiveGapicGeneration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization

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

@@ -159,6 +159,9 @@ module Google
         # @!attribute [rw] enable_automatic_punctuation
         #   @return [::Boolean]
         #     Enable automatic punctuation option at the speech backend.
+        # @!attribute [rw] phrase_sets
+        #   @return [::Array<::String>]
+        #     A collection of phrase set resources to use for speech adaptation.
         # @!attribute [rw] opt_out_conformer_model_migration
         #   @return [::Boolean]
         #     If `true`, the request will opt out for STT conformer model migration.
@@ -291,6 +294,9 @@ module Google
         #     [Agent Speech
         #     settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech)
         #     for model selection.
+        # @!attribute [rw] phrase_sets
+        #   @return [::Array<::String>]
+        #     List of names of Cloud Speech phrase sets that are used for transcription.
         # @!attribute [rw] audio_encoding
         #   @return [::Google::Cloud::Dialogflow::V2::AudioEncoding]
         #     Audio encoding of the audio content to process.

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

@@ -116,9 +116,9 @@ module Google
         #     Google. Only set it if you cannot wait for the response to return a
         #     auto-generated one to you.
         #
-        #     The conversation ID must be compliant with the regression fomula
+        #     The conversation ID must be compliant with the regression formula
         #     `[a-zA-Z][a-zA-Z0-9_-]*` with the characters length in range of [3,64].
-        #     If the field is provided, the caller is resposible for
+        #     If the field is provided, the caller is responsible for
         #     1. the uniqueness of the ID, otherwise the request will be rejected.
         #     2. the consistency for whether to use custom ID or not under a project to
         #     better ensure uniqueness.
@@ -496,9 +496,223 @@ module Google
         #     triggered.
         #     Format: `projects/<Project ID>/locations/<Location
         #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.
+        # @!attribute [rw] query_source
+        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource]
+        #     Optional. The source of the query in the request.
+        # @!attribute [rw] end_user_metadata
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. Information about the end-user to improve the relevance and
+        #     accuracy of generative answers.
+        #
+        #     This will be interpreted and used by a language model, so, for good
+        #     results, the data should be self-descriptive, and in a simple structure.
+        #
+        #     Example:
+        #
+        #     ```json
+        #     {
+        #       "subscription plan": "Business Premium Plus",
+        #       "devices owned": [
+        #         \\{"model": "Google Pixel 7"},
+        #         \\{"model": "Google Pixel Tablet"}
+        #       ]
+        #     }
+        #     ```
+        # @!attribute [rw] search_config
+        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig]
+        #     Optional. Configuration specific to search queries with data stores.
+        # @!attribute [rw] exact_search
+        #   @return [::Boolean]
+        #     Optional. Whether to search the query exactly without query rewrite.
         class SearchKnowledgeRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration specific to search queries with data stores.
+          # @!attribute [rw] boost_specs
+          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
+          #     Optional. Boost specifications for data stores.
+          # @!attribute [rw] filter_specs
+          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
+          #     Optional. Filter specification for data store queries.
+          class SearchConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Boost specifications for data stores.
+            # @!attribute [rw] data_stores
+            #   @return [::Array<::String>]
+            #     Optional. Data Stores where the boosting configuration is applied. The
+            #     full names of the referenced data stores. Formats:
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
+            #     `projects/{project}/locations/{location}/dataStores/{data_store}`
+            # @!attribute [rw] spec
+            #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
+            #     Optional. A list of boosting specifications.
+            class BoostSpecs
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Boost specification to boost certain documents.
+              # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
+              # documentation is available at
+              # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
+              # @!attribute [rw] condition_boost_specs
+              #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
+              #     Optional. Condition boost specifications. If a document matches
+              #     multiple conditions in the specifictions, boost scores from these
+              #     specifications are all applied and combined in a non-linear way.
+              #     Maximum number of specifications is 20.
+              class BoostSpec
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Boost applies to documents which match a condition.
+                # @!attribute [rw] condition
+                #   @return [::String]
+                #     Optional. An expression which specifies a boost condition. The
+                #     syntax and supported fields are the same as a filter expression.
+                #     Examples:
+                #
+                #     * To boost documents with document ID "doc_1" or "doc_2", and
+                #     color
+                #       "Red" or "Blue":
+                #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+                # @!attribute [rw] boost
+                #   @return [::Float]
+                #     Optional. Strength of the condition boost, which should be in [-1,
+                #     1]. Negative boost means demotion. Default is 0.0.
+                #
+                #     Setting to 1.0 gives the document a big promotion. However, it does
+                #     not necessarily mean that the boosted document will be the top
+                #     result at all times, nor that other documents will be excluded.
+                #     Results could still be shown even when none of them matches the
+                #     condition. And results that are significantly more relevant to the
+                #     search query can still trump your heavily favored but irrelevant
+                #     documents.
+                #
+                #     Setting to -1.0 gives the document a big demotion. However, results
+                #     that are deeply relevant might still be shown. The document will
+                #     have an upstream battle to get a fairly high ranking, but it is not
+                #     blocked out completely.
+                #
+                #     Setting to 0.0 means no boost applied. The boosting condition is
+                #     ignored.
+                # @!attribute [rw] boost_control_spec
+                #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
+                #     Optional. Complex specification for custom ranking based on
+                #     customer defined attribute value.
+                class ConditionBoostSpec
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                  # Specification for custom ranking based on customer specified
+                  # attribute
+                  # value. It provides more controls for customized ranking than the
+                  # simple (condition, boost) combination above.
+                  # @!attribute [rw] field_name
+                  #   @return [::String]
+                  #     Optional. The name of the field whose value will be used to
+                  #     determine the boost amount.
+                  # @!attribute [rw] attribute_type
+                  #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
+                  #     Optional. The attribute type to be used to determine the boost
+                  #     amount. The attribute value can be derived from the field value
+                  #     of the specified field_name. In the case of numerical it is
+                  #     straightforward i.e. attribute_value = numerical_field_value. In
+                  #     the case of freshness however, attribute_value = (time.now() -
+                  #     datetime_field_value).
+                  # @!attribute [rw] interpolation_type
+                  #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
+                  #     Optional. The interpolation type to be applied to connect the
+                  #     control points listed below.
+                  # @!attribute [rw] control_points
+                  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
+                  #     Optional. The control points used to define the curve. The
+                  #     monotonic function (defined through the interpolation_type above)
+                  #     passes through the control points listed here.
+                  class BoostControlSpec
+                    include ::Google::Protobuf::MessageExts
+                    extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                    # The control points used to define the curve. The curve defined
+                    # through these control points can only be monotonically increasing
+                    # or decreasing(constant values are acceptable).
+                    class ControlPoint
+                      include ::Google::Protobuf::MessageExts
+                      extend ::Google::Protobuf::MessageExts::ClassMethods
+                    end
+
+                    # The attribute(or function) for which the custom ranking is to be
+                    # applied.
+                    module AttributeType
+                      # Unspecified AttributeType.
+                      ATTRIBUTE_TYPE_UNSPECIFIED = 0
+
+                      # The value of the numerical field will be used to dynamically
+                      # update the boost amount. In this case, the attribute_value (the
+                      # x value) of the control point will be the actual value of the
+                      # numerical field for which the boost_amount is specified.
+                      NUMERICAL = 1
+
+                      # For the freshness use case the attribute value will be the
+                      # duration between the current time and the date in the datetime
+                      # field specified. The value must be formatted as an XSD
+                      # `dayTimeDuration` value (a restricted subset of an ISO 8601
+                      # duration value). The pattern for this is:
+                      # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
+                      FRESHNESS = 2
+                    end
+
+                    # The interpolation type to be applied. Default will be linear
+                    # (Piecewise Linear).
+                    module InterpolationType
+                      # Interpolation type is unspecified. In this case, it defaults to
+                      # Linear.
+                      INTERPOLATION_TYPE_UNSPECIFIED = 0
+
+                      # Piecewise linear interpolation will be applied.
+                      LINEAR = 1
+                    end
+                  end
+                end
+              end
+            end
+
+            # Filter specification for data store queries.
+            # @!attribute [rw] data_stores
+            #   @return [::Array<::String>]
+            #     Optional. The data store where the filter configuration is applied.
+            #     Full resource name of data store, such as
+            #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
+            #     dataStores/\\{dataStoreId}.
+            # @!attribute [rw] filter
+            #   @return [::String]
+            #     Optional. The filter expression to be applied.
+            #     Expression syntax is documented at
+            #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+            class FilterSpecs
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The source of the query. We use QuerySource to distinguish queries directly
+          # entered by agents and suggested queries from
+          # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
+          # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
+          # of a SuggestKnowledgeAssist call.
+          module QuerySource
+            # Unknown query source.
+            QUERY_SOURCE_UNSPECIFIED = 0
+
+            # The query is from agents.
+            AGENT_QUERY = 1
+
+            # The query is a suggested query from
+            # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
+            SUGGESTED_QUERY = 2
+          end
         end
 
         # The response message for
@@ -545,6 +759,9 @@ module Google
           # @!attribute [rw] snippet
           #   @return [::String]
           #     The relevant snippet of the article.
+          # @!attribute [rw] metadata
+          #   @return [::Google::Protobuf::Struct]
+          #     Metadata associated with the article.
           class AnswerSource
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -370,6 +370,10 @@ module Google
           #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections]
           #     Optional. The customized sections chosen to return when requesting a
           #     summary of a conversation.
+          # @!attribute [rw] context_size
+          #   @return [::Integer]
+          #     Optional. The number of recent messages to include in the context.
+          #     Supported features: KNOWLEDGE_ASSIST.
           class SuggestionQueryConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -34,10 +34,10 @@ module Google
         #     Optional. The ID to use for the generator, which will become the final
         #     component of the generator's resource name.
         #
-        #     The generator ID must be compliant with the regression fomula
+        #     The generator ID must be compliant with the regression formula
         #     `[a-zA-Z][a-zA-Z0-9_-]*` with the characters length in range of [3,64].
         #     If the field is not provided, an Id will be auto-generated.
-        #     If the field is provided, the caller is resposible for
+        #     If the field is provided, the caller is responsible for
         #     1. the uniqueness of the ID, otherwise the request will be rejected.
         #     2. the consistency for whether to use custom ID or not under a project to
         #     better ensure uniqueness.
@@ -50,7 +50,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The generator resource name to retrieve. Format:
-        #     `projects/<Project ID>/locations/<Location ID>`/generators/<Generator ID>`
+        #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
         class GetGeneratorRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -165,7 +165,6 @@ module Google
 
         # Providing examples in the generator (i.e. building a few-shot generator)
         # helps convey the desired format of the LLM response.
-        # NEXT_ID: 10
         # @!attribute [rw] conversation_context
         #   @return [::Google::Cloud::Dialogflow::V2::ConversationContext]
         #     Optional. Conversation transcripts.

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

@@ -1147,6 +1147,9 @@ module Google
               # @!attribute [rw] title
               #   @return [::String]
               #     Title of the document.
+              # @!attribute [rw] metadata
+              #   @return [::Google::Protobuf::Struct]
+              #     Metadata of the document.
               class Snippet
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dialogflow-v2
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -337,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Builds conversational interfaces (for example, chatbots, and voice-powered