google-cloud-dialogflow-cx-v3 0.22.0 → 0.23.0

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

@@ -0,0 +1,187 @@
+# 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
+          # Generators contain prompt to be sent to the LLM model to generate text. The
+          # prompt can contain parameters which will be resolved before calling the
+          # model. It can optionally contain banned phrases to ensure the model responses
+          # are safe.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the generator.
+          #     Must be set for the
+          #     {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator Generators.UpdateGenerator}
+          #     method. [Generators.CreateGenerate][] populates the name automatically.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/generators/<Generator ID>`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the generator, unique within the
+          #     agent. The prompt contains pre-defined parameters such as $conversation,
+          #     $last-user-utterance, etc. populated by Dialogflow. It can also contain
+          #     custom placeholders which will be resolved during fulfillment.
+          # @!attribute [rw] prompt_text
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Phrase]
+          #     Required. Prompt for the LLM model.
+          # @!attribute [rw] placeholders
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>]
+          #     Optional. List of custom placeholders in the prompt text.
+          class Generator
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Represents a custom placeholder in the prompt text.
+            # @!attribute [rw] id
+            #   @return [::String]
+            #     Unique ID used to map custom placeholder to parameters in fulfillment.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     Custom placeholder value in the prompt text.
+            class Placeholder
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # 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.
+          class Phrase
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for
+          # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#list_generators Generators.ListGenerators}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to list all generators for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list generators for.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 100 and
+          #     at most 1000.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          class ListGeneratorsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for
+          # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#list_generators Generators.ListGenerators}.
+          # @!attribute [rw] generators
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Generator>]
+          #     The list of generators. There will be a maximum number of items returned
+          #     based on the page_size field in the request.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListGeneratorsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for
+          # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#get_generator Generators.GetGenerator}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the generator.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/generators/<Generator ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list generators for.
+          class GetGeneratorRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for
+          # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#create_generator Generators.CreateGenerator}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to create a generator for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] generator
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Generator]
+          #     Required. The generator to create.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to create generators for the following fields:
+          #     *  `Generator.prompt_text.text`
+          #     If not specified, the agent's default language is used.
+          class CreateGeneratorRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for
+          # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator Generators.UpdateGenerator}.
+          # @!attribute [rw] generator
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Generator]
+          #     Required. The generator to update.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list generators for.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The mask to control which fields get updated. If the mask is not present,
+          #     all fields will be updated.
+          class UpdateGeneratorRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for
+          # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#delete_generator Generators.DeleteGenerator}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the generator to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/generators/<Generator ID>`.
+          # @!attribute [rw] force
+          #   @return [::Boolean]
+          #     This field has no effect for generators not being used.
+          #     For generators that are used by pages/flows/transition route groups:
+          #
+          #     *  If `force` is set to false, an error will be returned with message
+          #        indicating the referenced resources.
+          #     *  If `force` is set to true, Dialogflow will remove the generator, as well
+          #        as any references to the generator (i.e.
+          #        [Generator][Fulfillment.generator]) in fulfillments.
+          class DeleteGeneratorRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,6 +22,71 @@ module Google
     module Dialogflow
       module CX
         module V3
+          # Stores information about feedback provided by users about a response.
+          # @!attribute [rw] rating
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback::Rating]
+          #     Optional. Rating from user for the specific Dialogflow response.
+          # @!attribute [rw] rating_reason
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback::RatingReason]
+          #     Optional. In case of thumbs down rating provided, users can optionally
+          #     provide context about the rating.
+          # @!attribute [rw] custom_rating
+          #   @return [::String]
+          #     Optional. Custom rating from the user about the provided answer, with
+          #     maximum length of 1024 characters. For example, client could use a
+          #     customized JSON object to indicate the rating.
+          class AnswerFeedback
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Stores extra information about why users provided thumbs down rating.
+            # @!attribute [rw] reason_labels
+            #   @return [::Array<::String>]
+            #     Optional. Custom reason labels for thumbs down rating provided by the
+            #     user. The maximum number of labels allowed is 10 and the maximum length
+            #     of a single label is 128 characters.
+            # @!attribute [rw] feedback
+            #   @return [::String]
+            #     Optional. Additional feedback about the rating.
+            #     This field can be populated without choosing a predefined `reason`.
+            class RatingReason
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Represents thumbs up/down rating provided by user about a response.
+            module Rating
+              # Rating not specified.
+              RATING_UNSPECIFIED = 0
+
+              # Thumbs up feedback from user.
+              THUMBS_UP = 1
+
+              # Thumbs down feedback from user.
+              THUMBS_DOWN = 2
+            end
+          end
+
+          # The request to set the feedback for a bot answer.
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     Required. The name of the session the feedback was sent to.
+          # @!attribute [rw] response_id
+          #   @return [::String]
+          #     Required. ID of the response to update its feedback. This is the same as
+          #     DetectIntentResponse.response_id.
+          # @!attribute [rw] answer_feedback
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
+          #     Required. Feedback provided for a bot answer.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. The mask to control which fields to update. If the mask is not
+          #     present, all fields will be updated.
+          class SubmitAnswerFeedbackRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The request to detect user's intent.
           # @!attribute [rw] session
           #   @return [::String]
@@ -516,6 +581,28 @@ module Google
           #     By default, a Dialogflow session remains active and its data is stored for
           #     30 minutes after the last request is sent for the session.
           #     This value should be no longer than 1 day.
+          # @!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::CX::V3::SearchConfig]
+          #     Optional. Search configuration for UCS search queries.
           class QueryParameters
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -530,6 +617,100 @@ module Google
             end
           end
 
+          # Search configuration for UCS search queries.
+          # @!attribute [rw] boost_specs
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpecs>]
+          #     Optional. Boosting configuration for the datastores.
+          # @!attribute [rw] filter_specs
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::FilterSpecs>]
+          #     Optional. Filter configuration for the datastores.
+          class SearchConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # 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::CX::V3::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.
+            class ConditionBoostSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # 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::CX::V3::BoostSpec>]
+          #     Optional. A list of boosting specifications.
+          class BoostSpecs
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Filter 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] 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
+
           # Represents the query input. It can contain one of:
           #
           # 1. A conversational query in the form of text.
@@ -688,6 +869,10 @@ module Google
           #     the client may need to perform special logic at the moment. For example, if
           #     Dialogflow exports audio to Google Cloud Storage, then the client may need
           #     to wait for the resulting object to appear in the bucket before proceeding.
+          # @!attribute [rw] allow_answer_feedback
+          #   @return [::Boolean]
+          #     Indicates whether the Thumbs up/Thumbs down rating controls are need to be
+          #     shown for the response in the Dialogflow Messenger widget.
           class QueryResult
             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.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -272,6 +272,15 @@ files:
 - 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/generator_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/generator_services_pb.rb
+- lib/google/cloud/dialogflow/cx/v3/generators.rb
+- lib/google/cloud/dialogflow/cx/v3/generators/client.rb
+- lib/google/cloud/dialogflow/cx/v3/generators/credentials.rb
+- lib/google/cloud/dialogflow/cx/v3/generators/paths.rb
+- lib/google/cloud/dialogflow/cx/v3/generators/rest.rb
+- lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb
+- lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb
 - lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/inline_pb.rb
 - lib/google/cloud/dialogflow/cx/v3/intent_pb.rb
@@ -384,6 +393,7 @@ files:
 - 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/generator.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/import_strategy.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/inline.rb
 - proto_docs/google/cloud/dialogflow/cx/v3/intent.rb
@@ -426,7 +436,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Builds conversational interfaces (for example, chatbots, and voice-powered