google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0

data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb

@@ -21,6 +21,31 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1beta
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
+        # method.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     Required. The resource name of the parent Data Store, such as
+        #     `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+        #     This field is used to identify the data store where to fetch the models
+        #     from.
+        class ListCustomModelsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
+        # method.
+        # @!attribute [rw] models
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel>]
+        #     List of custom tuning models.
+        class ListCustomModelsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#train_custom_model SearchTuningService.TrainCustomModel}
         # method.
@@ -41,6 +66,9 @@ module Google
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
         #     The desired location of errors incurred during the data ingestion and
         #     training.
+        # @!attribute [rw] model_id
+        #   @return [::String]
+        #     If not provided, a UUID will be generated.
         class TrainCustomModelRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -100,11 +128,29 @@ module Google
         #
         #      * **bad-data**: The training data quality is bad.
         #      * **no-improvement**: Tuning didn't improve performance. Won't deploy.
-        #      * **in-progress**: Model training is in progress.
+        #      * **in-progress**: Model training job creation is in progress.
+        #      * **training**: Model is actively training.
+        #      * **evaluating**: The model is evaluating trained metrics.
+        #      * **indexing**: The model trained metrics are indexing.
         #      * **ready**: The model is ready for serving.
+        # @!attribute [rw] metrics
+        #   @return [::Google::Protobuf::Map{::String => ::Float}]
+        #     The metrics of the trained model.
+        # @!attribute [rw] model_name
+        #   @return [::String]
+        #     Fully qualified name of the CustomTuningModel.
         class TrainCustomModelResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Float]
+          class MetricsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Metadata related to the progress of the TrainCustomModel operation. This is

data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb

@@ -0,0 +1,88 @@
+# 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 V1beta
+        # External session proto definition.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Session::State]
+        #     The state of the session.
+        # @!attribute [rw] user_pseudo_id
+        #   @return [::String]
+        #     A unique identifier for tracking users.
+        # @!attribute [rw] turns
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn>]
+        #     Turns.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the session started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the session finished.
+        class Session
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents a turn, including a query from the user and a
+          # answer from service.
+          # @!attribute [rw] query
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Query]
+          #     The user query.
+          # @!attribute [rw] answer
+          #   @return [::String]
+          #     The resource name of the answer to the user query.
+          #
+          #     Only set if the answer generation (/answer API call) happened in this
+          #     turn.
+          class Turn
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Enumeration of the state of the session.
+          module State
+            # State is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The session is currently open.
+            IN_PROGRESS = 1
+          end
+        end
+
+        # Defines a user inputed query.
+        # @!attribute [rw] text
+        #   @return [::String]
+        #     Plain text.
+        # @!attribute [rw] query_id
+        #   @return [::String]
+        #     Unique Id for the query.
+        class Query
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb

@@ -57,6 +57,9 @@ module Google
         # @!attribute [r] generated_uri_pattern
         #   @return [::String]
         #     Output only. This is system-generated based on the provided_uri_pattern.
+        # @!attribute [r] root_domain_uri
+        #   @return [::String]
+        #     Output only. Root domain of the provided_uri_pattern.
         # @!attribute [r] site_verification_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SiteVerificationInfo]
         #     Output only. Site ownership and validity verification status.

data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb

@@ -22,7 +22,7 @@ module Google
     module DiscoveryEngine
       module V1beta
         # UserEvent captures all metadata information Discovery Engine API needs to
-        # know about how end users interact with customers' website.
+        # know about how end users interact with your website.
         # @!attribute [rw] event_type
         #   @return [::String]
         #     Required. User event type. Allowed values are:
@@ -63,6 +63,27 @@ module Google
         #     Analytics [Client
         #     ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
         #     for this field.
+        # @!attribute [rw] engine
+        #   @return [::String]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} resource name, in
+        #     the form of
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+        #
+        #     Optional. Only required for
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} produced user events.
+        #     For example, user events from blended search.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} resource
+        #     full name, of the form
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        #
+        #     Optional. Only required for user events whose data store can't by
+        #     determined by
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#engine UserEvent.engine} or
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#documents UserEvent.documents}.
+        #     If data store is set in the parent of write/import/collect user event
+        #     requests, this field can be omitted.
         # @!attribute [rw] event_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Only required for
@@ -187,7 +208,7 @@ module Google
         #   @return [::Array<::String>]
         #     A list of identifiers for the independent experiment groups this user event
         #     belongs to. This is used to distinguish between user events associated with
-        #     different experiment setups on the customer end.
+        #     different experiment setups.
         # @!attribute [rw] promotion_ids
         #   @return [::Array<::String>]
         #     The promotion IDs if this is an event associated with promotions.
@@ -255,7 +276,7 @@ module Google
         #     The most specific category associated with a category page.
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     Category pages include special pages such as sales or promotions. For
@@ -418,7 +439,7 @@ module Google
         #   @return [::Integer]
         #     Quantity of the Document associated with the user event. Defaults to 1.
         #
-        #     For example, this field will be 2 if two quantities of the same Document
+        #     For example, this field is 2 if two quantities of the same Document
         #     are involved in a `add-to-cart` event.
         #
         #     Required for events of the following event types:

data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb

@@ -24,11 +24,23 @@ module Google
         # Request message for WriteUserEvent method.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent DataStore resource name, such as
+        #     Required. The parent resource name.
+        #     If the write user event action is applied in
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} level, the
+        #     format is:
         #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+        #     If the write user event action is applied in [Location][] level, for
+        #     example, the event with
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} across multiple
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, the format is:
+        #     `projects/{project}/locations/{location}`.
         # @!attribute [rw] user_event
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent]
         #     Required. User event to write.
+        # @!attribute [rw] write_async
+        #   @return [::Boolean]
+        #     If set to true, the user event is written asynchronously after
+        #     validation, and the API responds without waiting for the write.
         class WriteUserEventRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-18 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -88,6 +88,13 @@ files:
 - lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb
 - lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb
 - lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service/client.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1beta/conversational_search_service.rb
 - lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb
 - lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb
@@ -122,6 +129,29 @@ files:
 - lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb
 - lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb
 - lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/client.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb
+- lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service/paths.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service/rest.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1beta/recommendation_service.rb
 - lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb
 - lib/google/cloud/discovery_engine/v1beta/recommendation_service/credentials.rb
@@ -181,13 +211,18 @@ files:
 - lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb
 - lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1beta/version.rb
+- lib/google/cloud/discoveryengine/v1beta/answer_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/common_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/completion_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/control_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/data_store_service_services_pb.rb
@@ -198,8 +233,16 @@ files:
 - lib/google/cloud/discoveryengine/v1beta/engine_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/project_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/rank_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/recommendation_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/schema_pb.rb
@@ -212,6 +255,7 @@ files:
 - lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb
+- lib/google/cloud/discoveryengine/v1beta/session_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb
 - lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb
@@ -224,11 +268,15 @@ files:
 - proto_docs/google/api/httpbody.rb
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/answer.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/common.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/completion.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/control.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/document.rb
@@ -236,8 +284,13 @@ files:
 - proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/engine.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/project.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/schema.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb
@@ -245,6 +298,7 @@ files:
 - proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb
+- proto_docs/google/cloud/discoveryengine/v1beta/session.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb
 - proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb