google-apis-discoveryengine_v1beta 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b31878ed5635318a180a540eb5e067040e19b7c8449ad81614a8b7e86dcf7b2
-  data.tar.gz: 0b2fbfb661dd01ba1eca280748a0955119ec99b454dc16359e9479e9472ca562
+  metadata.gz: 873c42659dc8bb3d09db30f5be699980866051fd7ab13d0739f8ca3da99a12d4
+  data.tar.gz: f0ebb0c73892777067cdd771d4af653ad882bb29f30dbd40afd420bae5d957f9
 SHA512:
-  metadata.gz: a34e6fdfa00522602cf810ccb5b3f3094f51c85e26b2ea6af567c8566df944cae00391f382d3da9ef39f2d434b11af5afe5e3eb36dc3d011993ed69eb408f185
-  data.tar.gz: f34fde375b8af4ca9f0e62b59cac58df069f0b77fcd4fc26cb1e30b00335836ece4b60156d07d7ecc7d3affa16f79c9918c05a9c2228dc1a06fc8dfbf5eb3bbf
+  metadata.gz: 8681f059acb830c9c52a203d9753e02019d832fb200b8d55278c9112bb7b8e9a1b2f5131f60ffd872381ccee6d23f6277fb0bee438a0b5ac564ec8d3928bae33
+  data.tar.gz: e49c7d2070ffcdfeaefdfa71051e3869f5d19cdb8fc4e232cc29d210c9716b5c0e303804aefefca878ba2ac47cd3f7796093db6aa1aa3a29bb83e1d90945a012

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1beta
 
+### v0.27.0 (2023-11-12)
+
+* Regenerated from discovery document revision 20231102
+
 ### v0.26.0 (2023-11-05)
 
 * Regenerated from discovery document revision 20231026

data/lib/google/apis/discoveryengine_v1beta/classes.rb

@@ -622,6 +622,61 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the DataStoreService.CreateDataStore
+      # operation. This will be returned by the google.longrunning.Operation.metadata
+      # field.
+      class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Metadata related to the progress of the EngineService.CreateEngine operation.
+      # This will be returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
       # Metadata for Create Schema LRO.
       class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
         include Google::Apis::Core::Hashable
@@ -648,6 +703,125 @@ module Google
         end
       end
       
+      # DataStore captures global settings and configs at the DataStore level.
+      class GoogleCloudDiscoveryengineV1alphaDataStore
+        include Google::Apis::Core::Hashable
+      
+        # Immutable. The content config of the data store. If this field is unset, the
+        # server behavior defaults to ContentConfig.NO_CONTENT.
+        # Corresponds to the JSON property `contentConfig`
+        # @return [String]
+        attr_accessor :content_config
+      
+        # Output only. Timestamp the DataStore was created at.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Output only. The id of the default Schema asscociated to this data store.
+        # Corresponds to the JSON property `defaultSchemaId`
+        # @return [String]
+        attr_accessor :default_schema_id
+      
+        # Required. The data store display name. This field must be a UTF-8 encoded
+        # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
+        # error is returned.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Immutable. The industry vertical that the data store registers.
+        # Corresponds to the JSON property `industryVertical`
+        # @return [String]
+        attr_accessor :industry_vertical
+      
+        # Immutable. The full resource name of the data store. Format: `projects/`
+        # project`/locations/`location`/collections/`collection_id`/dataStores/`
+        # data_store_id``. This field must be a UTF-8 encoded string with a length limit
+        # of 1024 characters.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The solutions that the data store enrolls. Available solutions for each
+        # industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `
+        # SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is
+        # automatically enrolled. Other solutions cannot be enrolled.
+        # Corresponds to the JSON property `solutionTypes`
+        # @return [Array<String>]
+        attr_accessor :solution_types
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @content_config = args[:content_config] if args.key?(:content_config)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
+          @name = args[:name] if args.key?(:name)
+          @solution_types = args[:solution_types] if args.key?(:solution_types)
+        end
+      end
+      
+      # Metadata related to the progress of the DataStoreService.DeleteDataStore
+      # operation. This will be returned by the google.longrunning.Operation.metadata
+      # field.
+      class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Metadata related to the progress of the EngineService.DeleteEngine operation.
+      # This will be returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
       # Metadata for DeleteSchema LRO.
       class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
         include Google::Apis::Core::Hashable
@@ -674,6 +848,384 @@ module Google
         end
       end
       
+      # Metadata that describes the training and serving parameters of an Engine.
+      class GoogleCloudDiscoveryengineV1alphaEngine
+        include Google::Apis::Core::Hashable
+      
+        # Configurations for a Chat Engine.
+        # Corresponds to the JSON property `chatEngineConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
+        attr_accessor :chat_engine_config
+      
+        # Additional information of a Chat Engine. Fields in this message are output
+        # only.
+        # Corresponds to the JSON property `chatEngineMetadata`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata]
+        attr_accessor :chat_engine_metadata
+      
+        # Common configurations for an Engine.
+        # Corresponds to the JSON property `commonConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig]
+        attr_accessor :common_config
+      
+        # Output only. Timestamp the Recommendation Engine was created at.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
+        # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
+        # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
+        # DataStores in the same Collection can be associated here. Note that when used
+        # in CreateEngineRequest, one DataStore id must be provided as the system will
+        # use it for necessary intializations.
+        # Corresponds to the JSON property `dataStoreIds`
+        # @return [Array<String>]
+        attr_accessor :data_store_ids
+      
+        # Required. The display name of the engine. Should be human readable. UTF-8
+        # encoded string with limit of 1024 characters.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Additional config specs for a Media Recommendation engine.
+        # Corresponds to the JSON property `mediaRecommendationEngineConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
+        attr_accessor :media_recommendation_engine_config
+      
+        # Immutable. The fully qualified resource name of the engine. This field must be
+        # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
+        # projects/`project_number`/locations/`location`/collections/`collection`/
+        # engines/`engine`` engine should be 1-63 characters, and valid characters are /
+        # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Additional information of a recommendation engine.
+        # Corresponds to the JSON property `recommendationMetadata`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata]
+        attr_accessor :recommendation_metadata
+      
+        # Configurations for a Search Engine.
+        # Corresponds to the JSON property `searchEngineConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig]
+        attr_accessor :search_engine_config
+      
+        # Additional config specs for a `similar-items` engine.
+        # Corresponds to the JSON property `similarDocumentsConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig]
+        attr_accessor :similar_documents_config
+      
+        # Required. The solutions of the engine.
+        # Corresponds to the JSON property `solutionType`
+        # @return [String]
+        attr_accessor :solution_type
+      
+        # Output only. Timestamp the Recommendation Engine was last updated.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
+          @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
+          @common_config = args[:common_config] if args.key?(:common_config)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
+          @name = args[:name] if args.key?(:name)
+          @recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
+          @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
+          @similar_documents_config = args[:similar_documents_config] if args.key?(:similar_documents_config)
+          @solution_type = args[:solution_type] if args.key?(:solution_type)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Configurations for a Chat Engine.
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
+        include Google::Apis::Core::Hashable
+      
+        # Configurations for generating a Dialogflow agent. Note that these
+        # configurations are one-time consumed by and passed to Dialogflow service. It
+        # means they cannot be retrieved using GetEngine or ListEngine API after engine
+        # creation.
+        # Corresponds to the JSON property `agentCreationConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
+        attr_accessor :agent_creation_config
+      
+        # The resource name of an exist Dialogflow agent to link to this Chat Engine.
+        # Customers can either provide `agent_creation_config` to create agent or
+        # provide an agent name that links the agent with the Chat engine. Format: `
+        # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
+        # one-time consumed by and passed to Dialogflow service. It means they cannot be
+        # retrieved using GetEngine or ListEngine API after engine creation. Please use
+        # Engine.chat_engine_metadata.dialogflow_agent for actual agent association
+        # after Engine is created.
+        # Corresponds to the JSON property `dialogflowAgentToLink`
+        # @return [String]
+        attr_accessor :dialogflow_agent_to_link
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
+          @dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
+        end
+      end
+      
+      # Configurations for generating a Dialogflow agent. Note that these
+      # configurations are one-time consumed by and passed to Dialogflow service. It
+      # means they cannot be retrieved using GetEngine or ListEngine API after engine
+      # creation.
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
+        include Google::Apis::Core::Hashable
+      
+        # Name of the company, organization or other entity that the agent represents.
+        # Used for knowledge connector LLM prompt and for knowledge search.
+        # Corresponds to the JSON property `business`
+        # @return [String]
+        attr_accessor :business
+      
+        # Required. The default language of the agent as a language tag. See [Language
+        # Support](https://cloud.google.com/dialogflow/docs/reference/language) for a
+        # list of the currently supported language codes.
+        # Corresponds to the JSON property `defaultLanguageCode`
+        # @return [String]
+        attr_accessor :default_language_code
+      
+        # Required. The time zone of the agent from the [time zone database](https://www.
+        # iana.org/time-zones), e.g., America/New_York, Europe/Paris.
+        # Corresponds to the JSON property `timeZone`
+        # @return [String]
+        attr_accessor :time_zone
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @business = args[:business] if args.key?(:business)
+          @default_language_code = args[:default_language_code] if args.key?(:default_language_code)
+          @time_zone = args[:time_zone] if args.key?(:time_zone)
+        end
+      end
+      
+      # Additional information of a Chat Engine. Fields in this message are output
+      # only.
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of a Dialogflow agent, that this Chat Engine refers to.
+        # Format: `projects//locations//agents/`.
+        # Corresponds to the JSON property `dialogflowAgent`
+        # @return [String]
+        attr_accessor :dialogflow_agent
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dialogflow_agent = args[:dialogflow_agent] if args.key?(:dialogflow_agent)
+        end
+      end
+      
+      # Common configurations for an Engine.
+      class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
+        include Google::Apis::Core::Hashable
+      
+        # The name of the company, business or entity that is associated with the engine.
+        # Setting this may help improve LLM related features.
+        # Corresponds to the JSON property `companyName`
+        # @return [String]
+        attr_accessor :company_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @company_name = args[:company_name] if args.key?(:company_name)
+        end
+      end
+      
+      # Additional config specs for a Media Recommendation engine.
+      class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
+        include Google::Apis::Core::Hashable
+      
+        # The optimization objective e.g. `cvr`. This field together with
+        # optimization_objective describe engine metadata to use to control engine
+        # training and serving. Currently supported values: `ctr`, `cvr`. If not
+        # specified, we choose default based on engine type. Default depends on type of
+        # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
+        # Corresponds to the JSON property `optimizationObjective`
+        # @return [String]
+        attr_accessor :optimization_objective
+      
+        # Custom threshold for `cvr` optimization_objective.
+        # Corresponds to the JSON property `optimizationObjectiveConfig`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
+        attr_accessor :optimization_objective_config
+      
+        # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
+        # part of the cost of running the service is frequency of training - this can be
+        # used to determine when to train engine in order to control cost. If not
+        # specified: the default value for `CreateEngine` method is `TRAINING`. The
+        # default value for `UpdateEngine` method is to keep the state the same as
+        # before.
+        # Corresponds to the JSON property `trainingState`
+        # @return [String]
+        attr_accessor :training_state
+      
+        # Required. The type of engine e.g. `recommended-for-you`. This field together
+        # with optimization_objective describe engine metadata to use to control engine
+        # training and serving. Currently supported values: `recommended-for-you`, `
+        # others-you-may-like`, `more-like-this`, `most-popular-items`.
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
+          @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
+          @training_state = args[:training_state] if args.key?(:training_state)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
+      # Custom threshold for `cvr` optimization_objective.
+      class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
+        include Google::Apis::Core::Hashable
+      
+        # Required. The name of the field to target. Currently supported values: `watch-
+        # percentage`, `watch-time`.
+        # Corresponds to the JSON property `targetField`
+        # @return [String]
+        attr_accessor :target_field
+      
+        # Required. The threshold to be applied to the target (e.g., 0.5).
+        # Corresponds to the JSON property `targetFieldValueFloat`
+        # @return [Float]
+        attr_accessor :target_field_value_float
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @target_field = args[:target_field] if args.key?(:target_field)
+          @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
+        end
+      end
+      
+      # Additional information of a recommendation engine.
+      class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The state of data requirements for this engine: `DATA_OK` and `
+        # DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state.
+        # Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines
+        # were trained successfully before, but cannot be refreshed because the
+        # underlying engine no longer has sufficient data for training.
+        # Corresponds to the JSON property `dataState`
+        # @return [String]
+        attr_accessor :data_state
+      
+        # Output only. The timestamp when the latest successful tune finished. Only
+        # applicable on Media Recommendation engines.
+        # Corresponds to the JSON property `lastTuneTime`
+        # @return [String]
+        attr_accessor :last_tune_time
+      
+        # Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
+        # Corresponds to the JSON property `servingState`
+        # @return [String]
+        attr_accessor :serving_state
+      
+        # Output only. The latest tune operation id associated with the engine. Only
+        # applicable on Media Recommendation engines. If present, this operation id can
+        # be used to determine if there is an ongoing tune for this engine. To check the
+        # operation status, send the GetOperation request with this operation id in the
+        # engine resource format. If no tuning has happened for this engine, the string
+        # is empty.
+        # Corresponds to the JSON property `tuningOperation`
+        # @return [String]
+        attr_accessor :tuning_operation
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @data_state = args[:data_state] if args.key?(:data_state)
+          @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
+          @serving_state = args[:serving_state] if args.key?(:serving_state)
+          @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
+        end
+      end
+      
+      # Configurations for a Search Engine.
+      class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
+        include Google::Apis::Core::Hashable
+      
+        # The add-on that this search engine enables.
+        # Corresponds to the JSON property `searchAddOns`
+        # @return [Array<String>]
+        attr_accessor :search_add_ons
+      
+        # The search feature tier of this engine. Different tiers might have different
+        # pricing. To learn more, please check the pricing documentation. Defaults to
+        # SearchTier.SEARCH_TIER_STANDARD if not specified.
+        # Corresponds to the JSON property `searchTier`
+        # @return [String]
+        attr_accessor :search_tier
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
+          @search_tier = args[:search_tier] if args.key?(:search_tier)
+        end
+      end
+      
+      # Additional config specs for a `similar-items` engine.
+      class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Configurations for fields of a schema. For example, configuring a field is
       # indexable, or searchable.
       class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -1397,6 +1949,40 @@ module Google
         end
       end
       
+      # Metadata associated with a tune operation.
+      class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Required. The resource name of the engine that this tune applies to. Format: `
+        # projects/`project_number`/locations/`location_id`/collections/`collection_id`/
+        # engines/`engine_id``
+        # Corresponds to the JSON property `engine`
+        # @return [String]
+        attr_accessor :engine
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @engine = args[:engine] if args.key?(:engine)
+        end
+      end
+      
+      # Response associated with a tune operation.
+      class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Metadata for UpdateSchema LRO.
       class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
         include Google::Apis::Core::Hashable

data/lib/google/apis/discoveryengine_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1beta
       # Version of the google-apis-discoveryengine_v1beta gem
-      GEM_VERSION = "0.26.0"
+      GEM_VERSION = "0.27.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231026"
+      REVISION = "20231102"
     end
   end
 end

data/lib/google/apis/discoveryengine_v1beta/representations.rb

@@ -130,18 +130,108 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaDataStore
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaEngine
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaFieldConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -256,6 +346,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -892,6 +994,22 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -900,6 +1018,35 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaDataStore
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :content_config, as: 'contentConfig'
+          property :create_time, as: 'createTime'
+          property :default_schema_id, as: 'defaultSchemaId'
+          property :display_name, as: 'displayName'
+          property :industry_vertical, as: 'industryVertical'
+          property :name, as: 'name'
+          collection :solution_types, as: 'solutionTypes'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -908,6 +1055,107 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaEngine
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :chat_engine_config, as: 'chatEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig::Representation
+      
+          property :chat_engine_metadata, as: 'chatEngineMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata::Representation
+      
+          property :common_config, as: 'commonConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig::Representation
+      
+          property :create_time, as: 'createTime'
+          collection :data_store_ids, as: 'dataStoreIds'
+          property :display_name, as: 'displayName'
+          property :media_recommendation_engine_config, as: 'mediaRecommendationEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig::Representation
+      
+          property :name, as: 'name'
+          property :recommendation_metadata, as: 'recommendationMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata::Representation
+      
+          property :search_engine_config, as: 'searchEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig::Representation
+      
+          property :similar_documents_config, as: 'similarDocumentsConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig::Representation
+      
+          property :solution_type, as: 'solutionType'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :agent_creation_config, as: 'agentCreationConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig::Representation
+      
+          property :dialogflow_agent_to_link, as: 'dialogflowAgentToLink'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :business, as: 'business'
+          property :default_language_code, as: 'defaultLanguageCode'
+          property :time_zone, as: 'timeZone'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dialogflow_agent, as: 'dialogflowAgent'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :company_name, as: 'companyName'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :optimization_objective, as: 'optimizationObjective'
+          property :optimization_objective_config, as: 'optimizationObjectiveConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig::Representation
+      
+          property :training_state, as: 'trainingState'
+          property :type, as: 'type'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :target_field, as: 'targetField'
+          property :target_field_value_float, as: 'targetFieldValueFloat'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :data_state, as: 'dataState'
+          property :last_tune_time, as: 'lastTuneTime'
+          property :serving_state, as: 'servingState'
+          property :tuning_operation, as: 'tuningOperation'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :search_add_ons, as: 'searchAddOns'
+          property :search_tier, as: 'searchTier'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaFieldConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1096,6 +1344,19 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :engine, as: 'engine'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/discoveryengine_v1beta/service.rb

@@ -1087,10 +1087,14 @@ module Google
         
         # Makes a recommendation, which requires a contextual user event.
         # @param [String] serving_config
-        #   Required. Full resource name of the format: `projects/*/locations/global/
-        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
-        #   recommendations from your model, you must create at least one serving config
-        #   for it.
+        #   Required. Full resource name of a ServingConfig: `projects/*/locations/global/
+        #   collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` One default serving config is
+        #   created along with your recommendation engine creation. The engine ID will be
+        #   used as the ID of the default serving config. For example, for Engine `
+        #   projects/*/locations/global/collections/*/engines/my-engine`, you can use `
+        #   projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
+        #   engine` for your Recommend requests.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1124,9 +1128,11 @@ module Google
         # Performs a search.
         # @param [String] serving_config
         #   Required. The resource name of the Search serving config, such as `projects/*/
-        #   locations/global/collections/default_collection/dataStores/default_data_store/
-        #   servingConfigs/default_serving_config`. This field is used to identify the
-        #   serving configuration name, set of models used to make the search.
+        #   locations/global/collections/default_collection/engines/*/servingConfigs/
+        #   default_serving_config`, or `projects/*/locations/global/collections/
+        #   default_collection/dataStores/default_data_store/servingConfigs/
+        #   default_serving_config`. This field is used to identify the serving
+        #   configuration name, set of models used to make the search.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1492,10 +1498,14 @@ module Google
         
         # Makes a recommendation, which requires a contextual user event.
         # @param [String] serving_config
-        #   Required. Full resource name of the format: `projects/*/locations/global/
-        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
-        #   recommendations from your model, you must create at least one serving config
-        #   for it.
+        #   Required. Full resource name of a ServingConfig: `projects/*/locations/global/
+        #   collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` One default serving config is
+        #   created along with your recommendation engine creation. The engine ID will be
+        #   used as the ID of the default serving config. For example, for Engine `
+        #   projects/*/locations/global/collections/*/engines/my-engine`, you can use `
+        #   projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
+        #   engine` for your Recommend requests.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1529,9 +1539,11 @@ module Google
         # Performs a search.
         # @param [String] serving_config
         #   Required. The resource name of the Search serving config, such as `projects/*/
-        #   locations/global/collections/default_collection/dataStores/default_data_store/
-        #   servingConfigs/default_serving_config`. This field is used to identify the
-        #   serving configuration name, set of models used to make the search.
+        #   locations/global/collections/default_collection/engines/*/servingConfigs/
+        #   default_serving_config`, or `projects/*/locations/global/collections/
+        #   default_collection/dataStores/default_data_store/servingConfigs/
+        #   default_serving_config`. This field is used to identify the serving
+        #   configuration name, set of models used to make the search.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2600,10 +2612,14 @@ module Google
         
         # Makes a recommendation, which requires a contextual user event.
         # @param [String] serving_config
-        #   Required. Full resource name of the format: `projects/*/locations/global/
-        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
-        #   recommendations from your model, you must create at least one serving config
-        #   for it.
+        #   Required. Full resource name of a ServingConfig: `projects/*/locations/global/
+        #   collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` One default serving config is
+        #   created along with your recommendation engine creation. The engine ID will be
+        #   used as the ID of the default serving config. For example, for Engine `
+        #   projects/*/locations/global/collections/*/engines/my-engine`, you can use `
+        #   projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
+        #   engine` for your Recommend requests.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2637,9 +2653,11 @@ module Google
         # Performs a search.
         # @param [String] serving_config
         #   Required. The resource name of the Search serving config, such as `projects/*/
-        #   locations/global/collections/default_collection/dataStores/default_data_store/
-        #   servingConfigs/default_serving_config`. This field is used to identify the
-        #   serving configuration name, set of models used to make the search.
+        #   locations/global/collections/default_collection/engines/*/servingConfigs/
+        #   default_serving_config`, or `projects/*/locations/global/collections/
+        #   default_collection/dataStores/default_data_store/servingConfigs/
+        #   default_serving_config`. This field is used to identify the serving
+        #   configuration name, set of models used to make the search.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.26.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.27.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
 post_install_message: 
 rdoc_options: []