google-cloud-discovery_engine-v1 0.6.0 → 0.8.0

data/proto_docs/google/cloud/discoveryengine/v1/control.rb

@@ -0,0 +1,207 @@
+# 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 DiscoveryEngine
+      module V1
+        # Defines circumstances to be checked before allowing a behavior
+        # @!attribute [rw] query_terms
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::QueryTerm>]
+        #     Search only
+        #     A list of terms to match the query on.
+        #
+        #     Maximum of 10 query terms.
+        # @!attribute [rw] active_time_range
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::TimeRange>]
+        #     Range of time(s) specifying when condition is active.
+        #
+        #     Maximum of 10 time ranges.
+        class Condition
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for search request query
+          # @!attribute [rw] value
+          #   @return [::String]
+          #     The specific query value to match against
+          #
+          #     Must be lowercase, must be UTF-8.
+          #     Can have at most 3 space separated terms if full_match is true.
+          #     Cannot be an empty string.
+          #     Maximum length of 5000 characters.
+          # @!attribute [rw] full_match
+          #   @return [::Boolean]
+          #     Whether the search query needs to exactly match the query term.
+          class QueryTerm
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Used for time-dependent conditions.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Start of time range.
+          #
+          #     Range is inclusive.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     End of time range.
+          #
+          #     Range is inclusive.
+          #     Must be in the future.
+          class TimeRange
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Defines a conditioned behavior to employ during serving.
+        # Must be attached to a [ServingConfig][] to be considered at serving time.
+        # Permitted actions dependent on `SolutionType`.
+        # @!attribute [rw] boost_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction]
+        #     Defines a boost-type control
+        # @!attribute [rw] filter_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction]
+        #     Defines a filter-type control
+        #     Currently not supported by Recommendation
+        # @!attribute [rw] redirect_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction]
+        #     Defines a redirect-type control.
+        # @!attribute [rw] synonyms_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction]
+        #     Treats a group of terms as synonyms of one another.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/*/locations/global/dataStore/*/controls/*`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Human readable name. The identifier used in UI views.
+        #
+        #     Must be UTF-8 encoded string. Length limit is 128 characters.
+        #     Otherwise an INVALID ARGUMENT error is thrown.
+        # @!attribute [r] associated_serving_config_ids
+        #   @return [::Array<::String>]
+        #     Output only. List of all [ServingConfig][] ids this control is attached to.
+        #     May take up to 10 minutes to update after changes.
+        # @!attribute [rw] solution_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
+        #     Required. Immutable. What solution the control belongs to.
+        #
+        #     Must be compatible with vertical of resource.
+        #     Otherwise an INVALID ARGUMENT error is thrown.
+        # @!attribute [rw] use_cases
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchUseCase>]
+        #     Specifies the use case for the control.
+        #     Affects what condition fields can be set.
+        #     Only applies to
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        #     Currently only allow one use case per control.
+        #     Must be set when solution_type is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SolutionType.SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] conditions
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>]
+        #     Determines when the associated action will trigger.
+        #
+        #     Omit to always apply the action.
+        #     Currently only a single condition may be specified.
+        #     Otherwise an INVALID ARGUMENT error is thrown.
+        class Control
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Adjusts order of products in returned list.
+          # @!attribute [rw] boost
+          #   @return [::Float]
+          #     Required. Strength of the boost, which should be in [-1, 1]. Negative
+          #     boost means demotion. Default is 0.0 (No-op).
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Required. Specifies which products to apply the boost to.
+          #
+          #     If no filter is provided all products will be boosted (No-op).
+          #     Syntax documentation:
+          #     https://cloud.google.com/retail/docs/filter-and-order
+          #     Maximum length is 5000 characters.
+          #     Otherwise an INVALID ARGUMENT error is thrown.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     Required. Specifies which data store's documents can be boosted by this
+          #     control. Full data store name e.g.
+          #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
+          class BoostAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Specified which products may be included in results.
+          # Uses same filter as boost.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Required. A filter to apply on the matching condition results.
+          #
+          #     Required
+          #     Syntax documentation:
+          #     https://cloud.google.com/retail/docs/filter-and-order
+          #     Maximum length is 5000 characters. Otherwise an INVALID
+          #     ARGUMENT error is thrown.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     Required. Specifies which data store's documents can be filtered by this
+          #     control. Full data store name e.g.
+          #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
+          class FilterAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Redirects a shopper to the provided URI.
+          # @!attribute [rw] redirect_uri
+          #   @return [::String]
+          #     Required. The URI to which the shopper will be redirected.
+          #
+          #     Required.
+          #     URI must have length equal or less than 2000 characters.
+          #     Otherwise an INVALID ARGUMENT error is thrown.
+          class RedirectAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Creates a set of terms that will act as synonyms of one another.
+          #
+          # Example: "happy" will also be considered as "glad", "glad" will also be
+          # considered as "happy".
+          # @!attribute [rw] synonyms
+          #   @return [::Array<::String>]
+          #     Defines a set of synonyms.
+          #     Can specify up to 100 synonyms.
+          #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
+          #     thrown.
+          class SynonymsAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb

@@ -0,0 +1,126 @@
+# 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 DiscoveryEngine
+      module V1
+        # Request for CreateControl method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Full resource name of parent data store. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     or
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        # @!attribute [rw] control
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Control]
+        #     Required. The Control to create.
+        # @!attribute [rw] control_id
+        #   @return [::String]
+        #     Required. The ID to use for the Control, which will become the final
+        #     component of the Control's resource name.
+        #
+        #     This value must be within 1-63 characters.
+        #     Valid characters are /[a-z][0-9]-_/.
+        class CreateControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateControl method.
+        # @!attribute [rw] control
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Control]
+        #     Required. The Control to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1::Control Control} to update. The following
+        #     are NOT supported:
+        #
+        #     * {::Google::Cloud::DiscoveryEngine::V1::Control#name Control.name}
+        #     * {::Google::Cloud::DiscoveryEngine::V1::Control#solution_type Control.solution_type}
+        #
+        #     If not set or empty, all supported fields are updated.
+        class UpdateControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteControl method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Control to delete. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        class DeleteControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetControl method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Control to get. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        class GetControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListControls method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The data store resource name. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     or
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return. If unspecified, defaults
+        #     to 50. Max allowed value is 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListControls` call.
+        #     Provide this to retrieve the subsequent page.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter to apply on the list results. Supported features:
+        #
+        #     * List all the products under the parent branch if
+        #     {::Google::Cloud::DiscoveryEngine::V1::ListControlsRequest#filter filter} is
+        #     unset. Currently this field is unsupported.
+        class ListControlsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListControls method.
+        # @!attribute [rw] controls
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control>]
+        #     All the Controls for a given data store.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListControlsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb

@@ -25,9 +25,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. Fully qualified name
-        #     `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
+        #     `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
         #     or
-        #     `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
+        #     `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation::State]
         #     The state of the Conversation.