google-apis-discoveryengine_v1alpha 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab1684c3cb5359758af86622dd69fbe21e97befe37486ee697c0c67a907cc80a
-  data.tar.gz: b1d2ce81e9517dc9869a57df8fd646471d0af46298f7a8c294528fbcd965ad97
+  metadata.gz: 2adfc46570652a4e45febdabbc3bb6944df0eb93e6a2a73863e484a5899353c6
+  data.tar.gz: e4a5dd49b4921af29ef33c6d7d7fb15cef7089799c4e9bc2e29be563d86985c5
 SHA512:
-  metadata.gz: 25cac6fc1b775d5d8de22f8ee08cd46d07502363ac50a3d891faaddaff4af231a6a3274b549635016008b928451446f260f058ca0ff00c6f1af82a97d658ef6f
-  data.tar.gz: 1f69a2bcbcc98cf8a830e74c6000a3828850a6c3d36e0074c112a714d0eefd637acae74d1a28f99680206d9a3a7b17a8cb67abefe0ac05fdfe89038ce56f903c
+  metadata.gz: 1b825af8c6cef4c28d96f06b7fc0f6d445036cd33f2bf48b7e570d472f85ab69733c0a1c420aad4804caa94f38eaf0598062ee36232d419018e528b1d9d4b715
+  data.tar.gz: 5b2f498ff5b9028c7ab3a0ea4f3e22155c4cc3c7ff32f03a25d29fed970dc369b36f46ed238885cb97d5c8d75c71cae5debc4a25340a0d7ca549883423f49aa3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.29.0 (2023-12-10)
+
+* Regenerated from discovery document revision 20231130
+
+### v0.28.0 (2023-11-19)
+
+* Regenerated from discovery document revision 20231110
+
 ### v0.27.0 (2023-11-12)
 
 * Regenerated from discovery document revision 20231102

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

@@ -642,6 +642,86 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SiteSearchEngineService.
+      # BatchCreateTargetSite operation. This will be returned by the google.
+      # longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
+        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
+      
+      # Request message for SiteSearchEngineService.s method.
+      class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The request message specifying the resources to create. A maximum of
+        # 20 TargetSites can be created in a batch.
+        # Corresponds to the JSON property `requests`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest>]
+        attr_accessor :requests
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @requests = args[:requests] if args.key?(:requests)
+        end
+      end
+      
+      # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
+      class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
+        include Google::Apis::Core::Hashable
+      
+        # TargetSites created.
+        # Corresponds to the JSON property `targetSites`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
+        attr_accessor :target_sites
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @target_sites = args[:target_sites] if args.key?(:target_sites)
+        end
+      end
+      
+      # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
+      class GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # BigQuery source import data from.
       class GoogleCloudDiscoveryengineV1alphaBigQuerySource
         include Google::Apis::Core::Hashable
@@ -872,7 +952,8 @@ module Google
         attr_accessor :messages
       
         # Immutable. Fully qualified name `project/*/locations/global/collections/`
-        # collection`/dataStore/*/conversations/*`
+        # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
+        # collections/`collection`/engines/*/conversations/*`.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -1157,6 +1238,61 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SiteSearchEngineService.
+      # CreateTargetSite operation. This will be returned by the google.longrunning.
+      # Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
+        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
+      
+      # Request message for SiteSearchEngineService.CreateTargetSite method.
+      class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. Parent resource name of TargetSite, such as `projects/`project`/
+        # locations/`location`/collections/`collection`/dataStores/`data_store`/
+        # siteSearchEngine`.
+        # Corresponds to the JSON property `parent`
+        # @return [String]
+        attr_accessor :parent
+      
+        # A target site for the SiteSearchEngine.
+        # Corresponds to the JSON property `targetSite`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
+        attr_accessor :target_site
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @parent = args[:parent] if args.key?(:parent)
+          @target_site = args[:target_site] if args.key?(:target_site)
+        end
+      end
+      
       # A custom attribute that is not explicitly modeled in a resource, e.g.
       # UserEvent.
       class GoogleCloudDiscoveryengineV1alphaCustomAttribute
@@ -1335,6 +1471,88 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SiteSearchEngineService.
+      # DeleteTargetSite operation. This will be returned by the google.longrunning.
+      # Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
+        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 SiteSearchEngineService.
+      # DisableAdvancedSiteSearch operation. This will be returned by the google.
+      # longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
+        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
+      
+      # Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
+      class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
+      class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Document captures all raw metadata information of items to be recommended or
       # searched.
       class GoogleCloudDiscoveryengineV1alphaDocument
@@ -1518,6 +1736,60 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SiteSearchEngineService.
+      # EnableAdvancedSiteSearch operation. This will be returned by the google.
+      # longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
+        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
+      
+      # Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
+      class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
+      class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Metadata that describes the training and serving parameters of an Engine.
       class GoogleCloudDiscoveryengineV1alphaEngine
         include Google::Apis::Core::Hashable
@@ -1559,6 +1831,14 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
+        # The industry vertical that the engine registers. The restriction of the Engine
+        # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
+        # Vertical on Engine has to match vertical of the DataStore liniked to the
+        # engine.
+        # Corresponds to the JSON property `industryVertical`
+        # @return [String]
+        attr_accessor :industry_vertical
+      
         # Additional config specs for a Media Recommendation engine.
         # Corresponds to the JSON property `mediaRecommendationEngineConfig`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
@@ -1610,6 +1890,7 @@ module Google
           @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)
+          @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
           @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)
@@ -1626,8 +1907,8 @@ module Google
       
         # 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.
+        # means they cannot be retrieved using EngineService.GetEngine or EngineService.
+        # ListEngines API after engine creation.
         # Corresponds to the JSON property `agentCreationConfig`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
         attr_accessor :agent_creation_config
@@ -1637,9 +1918,9 @@ module Google
         # 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.
+        # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
+        # engine creation. Please use 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
@@ -1657,8 +1938,8 @@ module Google
       
       # 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.
+      # means they cannot be retrieved using EngineService.GetEngine or EngineService.
+      # ListEngines API after engine creation.
       class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
         include Google::Apis::Core::Hashable
       
@@ -1896,6 +2177,40 @@ module Google
         end
       end
       
+      # Response message for SiteSearchEngineService.FetchDomainVerificationStatus
+      # method.
+      class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
+        include Google::Apis::Core::Hashable
+      
+        # A token that can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # List of TargetSites containing the site verification status.
+        # Corresponds to the JSON property `targetSites`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
+        attr_accessor :target_sites
+      
+        # The total number of items matching the request. This will always be populated
+        # in the response.
+        # Corresponds to the JSON property `totalSize`
+        # @return [Fixnum]
+        attr_accessor :total_size
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @target_sites = args[:target_sites] if args.key?(:target_sites)
+          @total_size = args[:total_size] if args.key?(:total_size)
+        end
+      end
+      
       # Configurations for fields of a schema. For example, configuring a field is
       # indexable, or searchable.
       class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -2537,6 +2852,39 @@ module Google
         end
       end
       
+      # Response message for SiteSearchEngineService.ListTargetSites method.
+      class GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
+        include Google::Apis::Core::Hashable
+      
+        # A token that can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # List of TargetSites.
+        # Corresponds to the JSON property `targetSites`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
+        attr_accessor :target_sites
+      
+        # The total number of items matching the request. This will always be populated
+        # in the response.
+        # Corresponds to the JSON property `totalSize`
+        # @return [Fixnum]
+        attr_accessor :total_size
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @target_sites = args[:target_sites] if args.key?(:target_sites)
+          @total_size = args[:total_size] if args.key?(:total_size)
+        end
+      end
+      
       # Request message for WidgetService.LookupWidgetConfig method.
       class GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest
         include Google::Apis::Core::Hashable
@@ -3420,6 +3768,18 @@ module Google
         # @return [String]
         attr_accessor :branch
       
+        # The default filter that is applied when a user performs a search without
+        # checking any filters on the search page. The filter applied to every search
+        # request when quality improvement such as query expansion is needed. In the
+        # case a query does not have a sufficient amount of results this filter will be
+        # used to determine whether or not to enable the query expansion flow. The
+        # original filter will still be used for the query expanded search. This field
+        # is strongly recommended to achieve high search quality. For more information
+        # about filter syntax, see SearchRequest.filter.
+        # Corresponds to the JSON property `canonicalFilter`
+        # @return [String]
+        attr_accessor :canonical_filter
+      
         # A specification for configuring the behavior of content search.
         # Corresponds to the JSON property `contentSearchSpec`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
@@ -3588,6 +3948,7 @@ module Google
         def update!(**args)
           @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
           @branch = args[:branch] if args.key?(:branch)
+          @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
           @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
           @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
           @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
@@ -3840,6 +4201,11 @@ module Google
         # @return [String]
         attr_accessor :language_code
       
+        # Specification of the model.
+        # Corresponds to the JSON property `modelSpec`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
+        attr_accessor :model_spec
+      
         # The number of top results to generate the summary from. If the number of
         # results returned is less than `summaryResultCount`, the summary is generated
         # from all of the results. At most five results can be used to generate a
@@ -3858,10 +4224,30 @@ module Google
           @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
           @include_citations = args[:include_citations] if args.key?(:include_citations)
           @language_code = args[:language_code] if args.key?(:language_code)
+          @model_spec = args[:model_spec] if args.key?(:model_spec)
           @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
         end
       end
       
+      # Specification of the model.
+      class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec
+        include Google::Apis::Core::Hashable
+      
+        # The string format of the model version. e.g. stable, latest, etc.
+        # Corresponds to the JSON property `version`
+        # @return [String]
+        attr_accessor :version
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @version = args[:version] if args.key?(:version)
+        end
+      end
+      
       # The specification that uses customized query embedding vector to do semantic
       # document retrieval.
       class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
@@ -4478,6 +4864,27 @@ module Google
         end
       end
       
+      # SiteSearchEngine captures DataStore level site search persisting
+      # configurations. It is a singleton value per data store.
+      class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
+        include Google::Apis::Core::Hashable
+      
+        # The fully qualified resource name of the site search engine. Format: `projects/
+        # */locations/*/dataStores/*/siteSearchEngine`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
       # Verification information for target sites in advanced site search.
       class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
         include Google::Apis::Core::Hashable
@@ -4771,6 +5178,34 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SiteSearchEngineService.
+      # UpdateTargetSite operation. This will be returned by the google.longrunning.
+      # Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
+        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
+      
       # UserEvent captures all metadata information Discovery Engine API needs to know
       # about how end users interact with customers' website.
       class GoogleCloudDiscoveryengineV1alphaUserEvent

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.27.0"
+      GEM_VERSION = "0.29.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 = "20231102"
+      REVISION = "20231130"
     end
   end
 end