google-apis-discoveryengine_v1 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -510,6 +510,15 @@ module Google
510
510
  attr_accessor :ignore_adversarial_query
511
511
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
512
512
 
513
+ # Specifies whether to filter out queries that have low relevance. If this field
514
+ # is set to `false`, all search results are used regardless of relevance to
515
+ # generate answers. If set to `true` or unset, the behavior will be determined
516
+ # automatically by the service.
517
+ # Corresponds to the JSON property `ignoreLowRelevantContent`
518
+ # @return [Boolean]
519
+ attr_accessor :ignore_low_relevant_content
520
+ alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
521
+
513
522
  # Specifies whether to filter out queries that are not answer-seeking. The
514
523
  # default value is `false`. Google employs search-query classification to detect
515
524
  # answer-seeking queries. No answer is returned if the search query is
@@ -546,6 +555,7 @@ module Google
546
555
  def update!(**args)
547
556
  @answer_language_code = args[:answer_language_code] if args.key?(:answer_language_code)
548
557
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
558
+ @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
549
559
  @ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
550
560
  @include_citations = args[:include_citations] if args.key?(:include_citations)
551
561
  @model_spec = args[:model_spec] if args.key?(:model_spec)
@@ -730,6 +740,14 @@ module Google
730
740
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpec]
731
741
  attr_accessor :boost_spec
732
742
 
743
+ # Specs defining dataStores to filter on in a search call and configurations for
744
+ # those dataStores. This is only considered for engines with multiple dataStores
745
+ # use case. For single dataStore within an engine, they should use the specs at
746
+ # the top level.
747
+ # Corresponds to the JSON property `dataStoreSpecs`
748
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>]
749
+ attr_accessor :data_store_specs
750
+
733
751
  # The filter syntax consists of an expression language for constructing a
734
752
  # predicate from one or more fields of the documents being filtered. Filter
735
753
  # expression is case-sensitive. This will be used to filter search results which
@@ -767,6 +785,7 @@ module Google
767
785
  # Update properties of this object
768
786
  def update!(**args)
769
787
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
788
+ @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
770
789
  @filter = args[:filter] if args.key?(:filter)
771
790
  @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
772
791
  @order_by = args[:order_by] if args.key?(:order_by)
@@ -1120,6 +1139,12 @@ module Google
1120
1139
  # @return [String]
1121
1140
  attr_accessor :page_identifier
1122
1141
 
1142
+ # The structured JSON metadata for the document. It is populated from the struct
1143
+ # data from the Chunk in search result.
1144
+ # Corresponds to the JSON property `structData`
1145
+ # @return [Hash<String,Object>]
1146
+ attr_accessor :struct_data
1147
+
1123
1148
  # Title.
1124
1149
  # Corresponds to the JSON property `title`
1125
1150
  # @return [String]
@@ -1138,6 +1163,7 @@ module Google
1138
1163
  def update!(**args)
1139
1164
  @document = args[:document] if args.key?(:document)
1140
1165
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
1166
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
1141
1167
  @title = args[:title] if args.key?(:title)
1142
1168
  @uri = args[:uri] if args.key?(:uri)
1143
1169
  end
@@ -1157,6 +1183,12 @@ module Google
1157
1183
  # @return [String]
1158
1184
  attr_accessor :document
1159
1185
 
1186
+ # The structured JSON metadata for the document. It is populated from the struct
1187
+ # data from the Chunk in search result.
1188
+ # Corresponds to the JSON property `structData`
1189
+ # @return [Hash<String,Object>]
1190
+ attr_accessor :struct_data
1191
+
1160
1192
  # Title.
1161
1193
  # Corresponds to the JSON property `title`
1162
1194
  # @return [String]
@@ -1175,6 +1207,7 @@ module Google
1175
1207
  def update!(**args)
1176
1208
  @chunk_contents = args[:chunk_contents] if args.key?(:chunk_contents)
1177
1209
  @document = args[:document] if args.key?(:document)
1210
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
1178
1211
  @title = args[:title] if args.key?(:title)
1179
1212
  @uri = args[:uri] if args.key?(:uri)
1180
1213
  end
@@ -2013,6 +2046,281 @@ module Google
2013
2046
  end
2014
2047
  end
2015
2048
 
2049
+ # Defines circumstances to be checked before allowing a behavior
2050
+ class GoogleCloudDiscoveryengineV1Condition
2051
+ include Google::Apis::Core::Hashable
2052
+
2053
+ # Range of time(s) specifying when condition is active. Maximum of 10 time
2054
+ # ranges.
2055
+ # Corresponds to the JSON property `activeTimeRange`
2056
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConditionTimeRange>]
2057
+ attr_accessor :active_time_range
2058
+
2059
+ # Search only A list of terms to match the query on. Maximum of 10 query terms.
2060
+ # Corresponds to the JSON property `queryTerms`
2061
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConditionQueryTerm>]
2062
+ attr_accessor :query_terms
2063
+
2064
+ def initialize(**args)
2065
+ update!(**args)
2066
+ end
2067
+
2068
+ # Update properties of this object
2069
+ def update!(**args)
2070
+ @active_time_range = args[:active_time_range] if args.key?(:active_time_range)
2071
+ @query_terms = args[:query_terms] if args.key?(:query_terms)
2072
+ end
2073
+ end
2074
+
2075
+ # Matcher for search request query
2076
+ class GoogleCloudDiscoveryengineV1ConditionQueryTerm
2077
+ include Google::Apis::Core::Hashable
2078
+
2079
+ # Whether the search query needs to exactly match the query term.
2080
+ # Corresponds to the JSON property `fullMatch`
2081
+ # @return [Boolean]
2082
+ attr_accessor :full_match
2083
+ alias_method :full_match?, :full_match
2084
+
2085
+ # The specific query value to match against Must be lowercase, must be UTF-8.
2086
+ # Can have at most 3 space separated terms if full_match is true. Cannot be an
2087
+ # empty string. Maximum length of 5000 characters.
2088
+ # Corresponds to the JSON property `value`
2089
+ # @return [String]
2090
+ attr_accessor :value
2091
+
2092
+ def initialize(**args)
2093
+ update!(**args)
2094
+ end
2095
+
2096
+ # Update properties of this object
2097
+ def update!(**args)
2098
+ @full_match = args[:full_match] if args.key?(:full_match)
2099
+ @value = args[:value] if args.key?(:value)
2100
+ end
2101
+ end
2102
+
2103
+ # Used for time-dependent conditions.
2104
+ class GoogleCloudDiscoveryengineV1ConditionTimeRange
2105
+ include Google::Apis::Core::Hashable
2106
+
2107
+ # End of time range. Range is inclusive. Must be in the future.
2108
+ # Corresponds to the JSON property `endTime`
2109
+ # @return [String]
2110
+ attr_accessor :end_time
2111
+
2112
+ # Start of time range. Range is inclusive.
2113
+ # Corresponds to the JSON property `startTime`
2114
+ # @return [String]
2115
+ attr_accessor :start_time
2116
+
2117
+ def initialize(**args)
2118
+ update!(**args)
2119
+ end
2120
+
2121
+ # Update properties of this object
2122
+ def update!(**args)
2123
+ @end_time = args[:end_time] if args.key?(:end_time)
2124
+ @start_time = args[:start_time] if args.key?(:start_time)
2125
+ end
2126
+ end
2127
+
2128
+ # Defines a conditioned behavior to employ during serving. Must be attached to a
2129
+ # ServingConfig to be considered at serving time. Permitted actions dependent on
2130
+ # `SolutionType`.
2131
+ class GoogleCloudDiscoveryengineV1Control
2132
+ include Google::Apis::Core::Hashable
2133
+
2134
+ # Output only. List of all ServingConfig ids this control is attached to. May
2135
+ # take up to 10 minutes to update after changes.
2136
+ # Corresponds to the JSON property `associatedServingConfigIds`
2137
+ # @return [Array<String>]
2138
+ attr_accessor :associated_serving_config_ids
2139
+
2140
+ # Adjusts order of products in returned list.
2141
+ # Corresponds to the JSON property `boostAction`
2142
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlBoostAction]
2143
+ attr_accessor :boost_action
2144
+
2145
+ # Determines when the associated action will trigger. Omit to always apply the
2146
+ # action. Currently only a single condition may be specified. Otherwise an
2147
+ # INVALID ARGUMENT error is thrown.
2148
+ # Corresponds to the JSON property `conditions`
2149
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Condition>]
2150
+ attr_accessor :conditions
2151
+
2152
+ # Required. Human readable name. The identifier used in UI views. Must be UTF-8
2153
+ # encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT
2154
+ # error is thrown.
2155
+ # Corresponds to the JSON property `displayName`
2156
+ # @return [String]
2157
+ attr_accessor :display_name
2158
+
2159
+ # Specified which products may be included in results. Uses same filter as boost.
2160
+ # Corresponds to the JSON property `filterAction`
2161
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction]
2162
+ attr_accessor :filter_action
2163
+
2164
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
2165
+ # controls/*`
2166
+ # Corresponds to the JSON property `name`
2167
+ # @return [String]
2168
+ attr_accessor :name
2169
+
2170
+ # Redirects a shopper to the provided URI.
2171
+ # Corresponds to the JSON property `redirectAction`
2172
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction]
2173
+ attr_accessor :redirect_action
2174
+
2175
+ # Required. Immutable. What solution the control belongs to. Must be compatible
2176
+ # with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
2177
+ # Corresponds to the JSON property `solutionType`
2178
+ # @return [String]
2179
+ attr_accessor :solution_type
2180
+
2181
+ # Creates a set of terms that will act as synonyms of one another. Example: "
2182
+ # happy" will also be considered as "glad", "glad" will also be considered as "
2183
+ # happy".
2184
+ # Corresponds to the JSON property `synonymsAction`
2185
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlSynonymsAction]
2186
+ attr_accessor :synonyms_action
2187
+
2188
+ # Specifies the use case for the control. Affects what condition fields can be
2189
+ # set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case
2190
+ # per control. Must be set when solution_type is SolutionType.
2191
+ # SOLUTION_TYPE_SEARCH.
2192
+ # Corresponds to the JSON property `useCases`
2193
+ # @return [Array<String>]
2194
+ attr_accessor :use_cases
2195
+
2196
+ def initialize(**args)
2197
+ update!(**args)
2198
+ end
2199
+
2200
+ # Update properties of this object
2201
+ def update!(**args)
2202
+ @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids)
2203
+ @boost_action = args[:boost_action] if args.key?(:boost_action)
2204
+ @conditions = args[:conditions] if args.key?(:conditions)
2205
+ @display_name = args[:display_name] if args.key?(:display_name)
2206
+ @filter_action = args[:filter_action] if args.key?(:filter_action)
2207
+ @name = args[:name] if args.key?(:name)
2208
+ @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
2209
+ @solution_type = args[:solution_type] if args.key?(:solution_type)
2210
+ @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
2211
+ @use_cases = args[:use_cases] if args.key?(:use_cases)
2212
+ end
2213
+ end
2214
+
2215
+ # Adjusts order of products in returned list.
2216
+ class GoogleCloudDiscoveryengineV1ControlBoostAction
2217
+ include Google::Apis::Core::Hashable
2218
+
2219
+ # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
2220
+ # means demotion. Default is 0.0 (No-op).
2221
+ # Corresponds to the JSON property `boost`
2222
+ # @return [Float]
2223
+ attr_accessor :boost
2224
+
2225
+ # Required. Specifies which data store's documents can be boosted by this
2226
+ # control. Full data store name e.g. projects/123/locations/global/collections/
2227
+ # default_collection/dataStores/default_data_store
2228
+ # Corresponds to the JSON property `dataStore`
2229
+ # @return [String]
2230
+ attr_accessor :data_store
2231
+
2232
+ # Required. Specifies which products to apply the boost to. If no filter is
2233
+ # provided all products will be boosted (No-op). Syntax documentation: https://
2234
+ # cloud.google.com/retail/docs/filter-and-order Maximum length is 5000
2235
+ # characters. Otherwise an INVALID ARGUMENT error is thrown.
2236
+ # Corresponds to the JSON property `filter`
2237
+ # @return [String]
2238
+ attr_accessor :filter
2239
+
2240
+ def initialize(**args)
2241
+ update!(**args)
2242
+ end
2243
+
2244
+ # Update properties of this object
2245
+ def update!(**args)
2246
+ @boost = args[:boost] if args.key?(:boost)
2247
+ @data_store = args[:data_store] if args.key?(:data_store)
2248
+ @filter = args[:filter] if args.key?(:filter)
2249
+ end
2250
+ end
2251
+
2252
+ # Specified which products may be included in results. Uses same filter as boost.
2253
+ class GoogleCloudDiscoveryengineV1ControlFilterAction
2254
+ include Google::Apis::Core::Hashable
2255
+
2256
+ # Required. Specifies which data store's documents can be filtered by this
2257
+ # control. Full data store name e.g. projects/123/locations/global/collections/
2258
+ # default_collection/dataStores/default_data_store
2259
+ # Corresponds to the JSON property `dataStore`
2260
+ # @return [String]
2261
+ attr_accessor :data_store
2262
+
2263
+ # Required. A filter to apply on the matching condition results. Required Syntax
2264
+ # documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum
2265
+ # length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
2266
+ # Corresponds to the JSON property `filter`
2267
+ # @return [String]
2268
+ attr_accessor :filter
2269
+
2270
+ def initialize(**args)
2271
+ update!(**args)
2272
+ end
2273
+
2274
+ # Update properties of this object
2275
+ def update!(**args)
2276
+ @data_store = args[:data_store] if args.key?(:data_store)
2277
+ @filter = args[:filter] if args.key?(:filter)
2278
+ end
2279
+ end
2280
+
2281
+ # Redirects a shopper to the provided URI.
2282
+ class GoogleCloudDiscoveryengineV1ControlRedirectAction
2283
+ include Google::Apis::Core::Hashable
2284
+
2285
+ # Required. The URI to which the shopper will be redirected. Required. URI must
2286
+ # have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT
2287
+ # error is thrown.
2288
+ # Corresponds to the JSON property `redirectUri`
2289
+ # @return [String]
2290
+ attr_accessor :redirect_uri
2291
+
2292
+ def initialize(**args)
2293
+ update!(**args)
2294
+ end
2295
+
2296
+ # Update properties of this object
2297
+ def update!(**args)
2298
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
2299
+ end
2300
+ end
2301
+
2302
+ # Creates a set of terms that will act as synonyms of one another. Example: "
2303
+ # happy" will also be considered as "glad", "glad" will also be considered as "
2304
+ # happy".
2305
+ class GoogleCloudDiscoveryengineV1ControlSynonymsAction
2306
+ include Google::Apis::Core::Hashable
2307
+
2308
+ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at
2309
+ # least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
2310
+ # Corresponds to the JSON property `synonyms`
2311
+ # @return [Array<String>]
2312
+ attr_accessor :synonyms
2313
+
2314
+ def initialize(**args)
2315
+ update!(**args)
2316
+ end
2317
+
2318
+ # Update properties of this object
2319
+ def update!(**args)
2320
+ @synonyms = args[:synonyms] if args.key?(:synonyms)
2321
+ end
2322
+ end
2323
+
2016
2324
  # External conversation proto definition.
2017
2325
  class GoogleCloudDiscoveryengineV1Conversation
2018
2326
  include Google::Apis::Core::Hashable
@@ -3179,8 +3487,8 @@ module Google
3179
3487
  class GoogleCloudDiscoveryengineV1EngineCommonConfig
3180
3488
  include Google::Apis::Core::Hashable
3181
3489
 
3182
- # Immutable. The name of the company, business or entity that is associated with
3183
- # the engine. Setting this may help improve LLM related features.
3490
+ # The name of the company, business or entity that is associated with the engine.
3491
+ # Setting this may help improve LLM related features.
3184
3492
  # Corresponds to the JSON property `companyName`
3185
3493
  # @return [String]
3186
3494
  attr_accessor :company_name
@@ -3939,6 +4247,31 @@ module Google
3939
4247
  end
3940
4248
  end
3941
4249
 
4250
+ # Response for ListControls method.
4251
+ class GoogleCloudDiscoveryengineV1ListControlsResponse
4252
+ include Google::Apis::Core::Hashable
4253
+
4254
+ # All the Controls for a given data store.
4255
+ # Corresponds to the JSON property `controls`
4256
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control>]
4257
+ attr_accessor :controls
4258
+
4259
+ # Pagination token, if not returned indicates the last page.
4260
+ # Corresponds to the JSON property `nextPageToken`
4261
+ # @return [String]
4262
+ attr_accessor :next_page_token
4263
+
4264
+ def initialize(**args)
4265
+ update!(**args)
4266
+ end
4267
+
4268
+ # Update properties of this object
4269
+ def update!(**args)
4270
+ @controls = args[:controls] if args.key?(:controls)
4271
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
4272
+ end
4273
+ end
4274
+
3942
4275
  # Response for ListConversations method.
3943
4276
  class GoogleCloudDiscoveryengineV1ListConversationsResponse
3944
4277
  include Google::Apis::Core::Hashable
@@ -4249,36 +4582,32 @@ module Google
4249
4582
  end
4250
4583
  end
4251
4584
 
4252
- # Metadata related to the progress of the PurgeDocuments operation. This will be
4253
- # returned by the google.longrunning.Operation.metadata field.
4254
- class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
4585
+ # Metadata and configurations for a Google Cloud project in the service.
4586
+ class GoogleCloudDiscoveryengineV1Project
4255
4587
  include Google::Apis::Core::Hashable
4256
4588
 
4257
- # Operation create time.
4589
+ # Output only. The timestamp when this project is created.
4258
4590
  # Corresponds to the JSON property `createTime`
4259
4591
  # @return [String]
4260
4592
  attr_accessor :create_time
4261
4593
 
4262
- # Count of entries that encountered errors while processing.
4263
- # Corresponds to the JSON property `failureCount`
4264
- # @return [Fixnum]
4265
- attr_accessor :failure_count
4266
-
4267
- # Count of entries that were ignored as entries were not found.
4268
- # Corresponds to the JSON property `ignoredCount`
4269
- # @return [Fixnum]
4270
- attr_accessor :ignored_count
4271
-
4272
- # Count of entries that were deleted successfully.
4273
- # Corresponds to the JSON property `successCount`
4274
- # @return [Fixnum]
4275
- attr_accessor :success_count
4594
+ # Output only. Full resource name of the project, for example `projects/`
4595
+ # project_number``. Note that when making requests, project number and project
4596
+ # id are both acceptable, but the server will always respond in project number.
4597
+ # Corresponds to the JSON property `name`
4598
+ # @return [String]
4599
+ attr_accessor :name
4276
4600
 
4277
- # Operation last update time. If the operation is done, this is also the finish
4278
- # time.
4279
- # Corresponds to the JSON property `updateTime`
4601
+ # Output only. The timestamp when this project is successfully provisioned.
4602
+ # Empty value means this project is still provisioning and is not ready for use.
4603
+ # Corresponds to the JSON property `provisionCompletionTime`
4280
4604
  # @return [String]
4281
- attr_accessor :update_time
4605
+ attr_accessor :provision_completion_time
4606
+
4607
+ # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
4608
+ # Corresponds to the JSON property `serviceTermsMap`
4609
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProjectServiceTerms>]
4610
+ attr_accessor :service_terms_map
4282
4611
 
4283
4612
  def initialize(**args)
4284
4613
  update!(**args)
@@ -4287,26 +4616,162 @@ module Google
4287
4616
  # Update properties of this object
4288
4617
  def update!(**args)
4289
4618
  @create_time = args[:create_time] if args.key?(:create_time)
4290
- @failure_count = args[:failure_count] if args.key?(:failure_count)
4291
- @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
4292
- @success_count = args[:success_count] if args.key?(:success_count)
4293
- @update_time = args[:update_time] if args.key?(:update_time)
4619
+ @name = args[:name] if args.key?(:name)
4620
+ @provision_completion_time = args[:provision_completion_time] if args.key?(:provision_completion_time)
4621
+ @service_terms_map = args[:service_terms_map] if args.key?(:service_terms_map)
4294
4622
  end
4295
4623
  end
4296
4624
 
4297
- # Request message for DocumentService.PurgeDocuments method.
4298
- class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
4625
+ # Metadata about the terms of service.
4626
+ class GoogleCloudDiscoveryengineV1ProjectServiceTerms
4299
4627
  include Google::Apis::Core::Hashable
4300
4628
 
4301
- # Required. Filter matching documents to purge. Only currently supported value
4302
- # is `*` (all items).
4303
- # Corresponds to the JSON property `filter`
4629
+ # The last time when the project agreed to the terms of service.
4630
+ # Corresponds to the JSON property `acceptTime`
4304
4631
  # @return [String]
4305
- attr_accessor :filter
4632
+ attr_accessor :accept_time
4306
4633
 
4307
- # Actually performs the purge. If `force` is set to false, return the expected
4308
- # purge count without deleting any documents.
4309
- # Corresponds to the JSON property `force`
4634
+ # The last time when the project declined or revoked the agreement to terms of
4635
+ # service.
4636
+ # Corresponds to the JSON property `declineTime`
4637
+ # @return [String]
4638
+ attr_accessor :decline_time
4639
+
4640
+ # The unique identifier of this terms of service. Available terms: * `
4641
+ # GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-
4642
+ # use-terms). When using this as `id`, the acceptable version to provide is `
4643
+ # 2022-11-23`.
4644
+ # Corresponds to the JSON property `id`
4645
+ # @return [String]
4646
+ attr_accessor :id
4647
+
4648
+ # Whether the project has accepted/rejected the service terms or it is still
4649
+ # pending.
4650
+ # Corresponds to the JSON property `state`
4651
+ # @return [String]
4652
+ attr_accessor :state
4653
+
4654
+ # The version string of the terms of service. For acceptable values, see the
4655
+ # comments for id above.
4656
+ # Corresponds to the JSON property `version`
4657
+ # @return [String]
4658
+ attr_accessor :version
4659
+
4660
+ def initialize(**args)
4661
+ update!(**args)
4662
+ end
4663
+
4664
+ # Update properties of this object
4665
+ def update!(**args)
4666
+ @accept_time = args[:accept_time] if args.key?(:accept_time)
4667
+ @decline_time = args[:decline_time] if args.key?(:decline_time)
4668
+ @id = args[:id] if args.key?(:id)
4669
+ @state = args[:state] if args.key?(:state)
4670
+ @version = args[:version] if args.key?(:version)
4671
+ end
4672
+ end
4673
+
4674
+ # Metadata associated with a project provision operation.
4675
+ class GoogleCloudDiscoveryengineV1ProvisionProjectMetadata
4676
+ include Google::Apis::Core::Hashable
4677
+
4678
+ def initialize(**args)
4679
+ update!(**args)
4680
+ end
4681
+
4682
+ # Update properties of this object
4683
+ def update!(**args)
4684
+ end
4685
+ end
4686
+
4687
+ # Request for ProjectService.ProvisionProject method.
4688
+ class GoogleCloudDiscoveryengineV1ProvisionProjectRequest
4689
+ include Google::Apis::Core::Hashable
4690
+
4691
+ # Required. Set to `true` to specify that caller has read and would like to give
4692
+ # consent to the [Terms for data use](https://cloud.google.com/retail/data-use-
4693
+ # terms).
4694
+ # Corresponds to the JSON property `acceptDataUseTerms`
4695
+ # @return [Boolean]
4696
+ attr_accessor :accept_data_use_terms
4697
+ alias_method :accept_data_use_terms?, :accept_data_use_terms
4698
+
4699
+ # Required. The version of the [Terms for data use](https://cloud.google.com/
4700
+ # retail/data-use-terms) that caller has read and would like to give consent to.
4701
+ # Acceptable version is `2022-11-23`, and this may change over time.
4702
+ # Corresponds to the JSON property `dataUseTermsVersion`
4703
+ # @return [String]
4704
+ attr_accessor :data_use_terms_version
4705
+
4706
+ def initialize(**args)
4707
+ update!(**args)
4708
+ end
4709
+
4710
+ # Update properties of this object
4711
+ def update!(**args)
4712
+ @accept_data_use_terms = args[:accept_data_use_terms] if args.key?(:accept_data_use_terms)
4713
+ @data_use_terms_version = args[:data_use_terms_version] if args.key?(:data_use_terms_version)
4714
+ end
4715
+ end
4716
+
4717
+ # Metadata related to the progress of the PurgeDocuments operation. This will be
4718
+ # returned by the google.longrunning.Operation.metadata field.
4719
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
4720
+ include Google::Apis::Core::Hashable
4721
+
4722
+ # Operation create time.
4723
+ # Corresponds to the JSON property `createTime`
4724
+ # @return [String]
4725
+ attr_accessor :create_time
4726
+
4727
+ # Count of entries that encountered errors while processing.
4728
+ # Corresponds to the JSON property `failureCount`
4729
+ # @return [Fixnum]
4730
+ attr_accessor :failure_count
4731
+
4732
+ # Count of entries that were ignored as entries were not found.
4733
+ # Corresponds to the JSON property `ignoredCount`
4734
+ # @return [Fixnum]
4735
+ attr_accessor :ignored_count
4736
+
4737
+ # Count of entries that were deleted successfully.
4738
+ # Corresponds to the JSON property `successCount`
4739
+ # @return [Fixnum]
4740
+ attr_accessor :success_count
4741
+
4742
+ # Operation last update time. If the operation is done, this is also the finish
4743
+ # time.
4744
+ # Corresponds to the JSON property `updateTime`
4745
+ # @return [String]
4746
+ attr_accessor :update_time
4747
+
4748
+ def initialize(**args)
4749
+ update!(**args)
4750
+ end
4751
+
4752
+ # Update properties of this object
4753
+ def update!(**args)
4754
+ @create_time = args[:create_time] if args.key?(:create_time)
4755
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
4756
+ @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
4757
+ @success_count = args[:success_count] if args.key?(:success_count)
4758
+ @update_time = args[:update_time] if args.key?(:update_time)
4759
+ end
4760
+ end
4761
+
4762
+ # Request message for DocumentService.PurgeDocuments method.
4763
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
4764
+ include Google::Apis::Core::Hashable
4765
+
4766
+ # Required. Filter matching documents to purge. Only currently supported value
4767
+ # is `*` (all items).
4768
+ # Corresponds to the JSON property `filter`
4769
+ # @return [String]
4770
+ attr_accessor :filter
4771
+
4772
+ # Actually performs the purge. If `force` is set to false, return the expected
4773
+ # purge count without deleting any documents.
4774
+ # Corresponds to the JSON property `force`
4310
4775
  # @return [Boolean]
4311
4776
  attr_accessor :force
4312
4777
  alias_method :force?, :force
@@ -4475,6 +4940,21 @@ module Google
4475
4940
  # @return [Fixnum]
4476
4941
  attr_accessor :top_n
4477
4942
 
4943
+ # The user labels applied to a resource must meet the following requirements: *
4944
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
4945
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
4946
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
4947
+ # have a maximum length of 63 characters. * Keys and values can contain only
4948
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
4949
+ # must use UTF-8 encoding, and international characters are allowed. * The key
4950
+ # portion of a label must be unique. However, you can use the same key with
4951
+ # multiple resources. * Keys must start with a lowercase letter or international
4952
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
4953
+ # manager/docs/creating-managing-labels#requirements) for more details.
4954
+ # Corresponds to the JSON property `userLabels`
4955
+ # @return [Hash<String,String>]
4956
+ attr_accessor :user_labels
4957
+
4478
4958
  def initialize(**args)
4479
4959
  update!(**args)
4480
4960
  end
@@ -4486,6 +4966,7 @@ module Google
4486
4966
  @query = args[:query] if args.key?(:query)
4487
4967
  @records = args[:records] if args.key?(:records)
4488
4968
  @top_n = args[:top_n] if args.key?(:top_n)
4969
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
4489
4970
  end
4490
4971
  end
4491
4972
 
@@ -6536,6 +7017,15 @@ module Google
6536
7017
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo]
6537
7018
  attr_accessor :completion_info
6538
7019
 
7020
+ # The DataStore resource full name, of the form `projects/`project`/locations/`
7021
+ # location`/collections/`collection_id`/dataStores/`data_store_id``. Optional.
7022
+ # Only required for user events whose data store can't by determined by
7023
+ # UserEvent.engine or UserEvent.documents. If data store is set in the parent of
7024
+ # write/import/collect user event requests, this field can be omitted.
7025
+ # Corresponds to the JSON property `dataStore`
7026
+ # @return [String]
7027
+ attr_accessor :data_store
7028
+
6539
7029
  # Should set to true if the request is made directly from the end user, in which
6540
7030
  # case the UserEvent.user_info.user_agent can be populated from the HTTP request.
6541
7031
  # This flag should be set only if the API request is made directly from the end
@@ -6558,6 +7048,14 @@ module Google
6558
7048
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo>]
6559
7049
  attr_accessor :documents
6560
7050
 
7051
+ # The Engine resource name, in the form of `projects/`project`/locations/`
7052
+ # location`/collections/`collection_id`/engines/`engine_id``. Optional. Only
7053
+ # required for Engine produced user events. For example, user events from
7054
+ # blended search.
7055
+ # Corresponds to the JSON property `engine`
7056
+ # @return [String]
7057
+ attr_accessor :engine
7058
+
6561
7059
  # Only required for UserEventService.ImportUserEvents method. Timestamp of when
6562
7060
  # the user event happened.
6563
7061
  # Corresponds to the JSON property `eventTime`
@@ -6665,8 +7163,10 @@ module Google
6665
7163
  @attributes = args[:attributes] if args.key?(:attributes)
6666
7164
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
6667
7165
  @completion_info = args[:completion_info] if args.key?(:completion_info)
7166
+ @data_store = args[:data_store] if args.key?(:data_store)
6668
7167
  @direct_user_request = args[:direct_user_request] if args.key?(:direct_user_request)
6669
7168
  @documents = args[:documents] if args.key?(:documents)
7169
+ @engine = args[:engine] if args.key?(:engine)
6670
7170
  @event_time = args[:event_time] if args.key?(:event_time)
6671
7171
  @event_type = args[:event_type] if args.key?(:event_type)
6672
7172
  @filter = args[:filter] if args.key?(:filter)
@@ -6996,6 +7496,12 @@ module Google
6996
7496
  # @return [String]
6997
7497
  attr_accessor :page_identifier
6998
7498
 
7499
+ # The structured JSON metadata for the document. It is populated from the struct
7500
+ # data from the Chunk in search result.
7501
+ # Corresponds to the JSON property `structData`
7502
+ # @return [Hash<String,Object>]
7503
+ attr_accessor :struct_data
7504
+
6999
7505
  # Title.
7000
7506
  # Corresponds to the JSON property `title`
7001
7507
  # @return [String]
@@ -7014,6 +7520,7 @@ module Google
7014
7520
  def update!(**args)
7015
7521
  @document = args[:document] if args.key?(:document)
7016
7522
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
7523
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
7017
7524
  @title = args[:title] if args.key?(:title)
7018
7525
  @uri = args[:uri] if args.key?(:uri)
7019
7526
  end
@@ -7033,6 +7540,12 @@ module Google
7033
7540
  # @return [String]
7034
7541
  attr_accessor :document
7035
7542
 
7543
+ # The structured JSON metadata for the document. It is populated from the struct
7544
+ # data from the Chunk in search result.
7545
+ # Corresponds to the JSON property `structData`
7546
+ # @return [Hash<String,Object>]
7547
+ attr_accessor :struct_data
7548
+
7036
7549
  # Title.
7037
7550
  # Corresponds to the JSON property `title`
7038
7551
  # @return [String]
@@ -7051,6 +7564,7 @@ module Google
7051
7564
  def update!(**args)
7052
7565
  @chunk_contents = args[:chunk_contents] if args.key?(:chunk_contents)
7053
7566
  @document = args[:document] if args.key?(:document)
7567
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
7054
7568
  @title = args[:title] if args.key?(:title)
7055
7569
  @uri = args[:uri] if args.key?(:uri)
7056
7570
  end
@@ -7329,22 +7843,20 @@ module Google
7329
7843
  end
7330
7844
  end
7331
7845
 
7332
- # Metadata related to the progress of the DataStoreService.CreateDataStore
7333
- # operation. This will be returned by the google.longrunning.Operation.metadata
7334
- # field.
7335
- class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
7846
+ # Defines circumstances to be checked before allowing a behavior
7847
+ class GoogleCloudDiscoveryengineV1alphaCondition
7336
7848
  include Google::Apis::Core::Hashable
7337
7849
 
7338
- # Operation create time.
7339
- # Corresponds to the JSON property `createTime`
7340
- # @return [String]
7341
- attr_accessor :create_time
7850
+ # Range of time(s) specifying when condition is active. Maximum of 10 time
7851
+ # ranges.
7852
+ # Corresponds to the JSON property `activeTimeRange`
7853
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaConditionTimeRange>]
7854
+ attr_accessor :active_time_range
7342
7855
 
7343
- # Operation last update time. If the operation is done, this is also the finish
7344
- # time.
7345
- # Corresponds to the JSON property `updateTime`
7346
- # @return [String]
7347
- attr_accessor :update_time
7856
+ # Search only A list of terms to match the query on. Maximum of 10 query terms.
7857
+ # Corresponds to the JSON property `queryTerms`
7858
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaConditionQueryTerm>]
7859
+ attr_accessor :query_terms
7348
7860
 
7349
7861
  def initialize(**args)
7350
7862
  update!(**args)
@@ -7352,26 +7864,27 @@ module Google
7352
7864
 
7353
7865
  # Update properties of this object
7354
7866
  def update!(**args)
7355
- @create_time = args[:create_time] if args.key?(:create_time)
7356
- @update_time = args[:update_time] if args.key?(:update_time)
7867
+ @active_time_range = args[:active_time_range] if args.key?(:active_time_range)
7868
+ @query_terms = args[:query_terms] if args.key?(:query_terms)
7357
7869
  end
7358
7870
  end
7359
7871
 
7360
- # Metadata related to the progress of the EngineService.CreateEngine operation.
7361
- # This will be returned by the google.longrunning.Operation.metadata field.
7362
- class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
7872
+ # Matcher for search request query
7873
+ class GoogleCloudDiscoveryengineV1alphaConditionQueryTerm
7363
7874
  include Google::Apis::Core::Hashable
7364
7875
 
7365
- # Operation create time.
7366
- # Corresponds to the JSON property `createTime`
7367
- # @return [String]
7368
- attr_accessor :create_time
7876
+ # Whether the search query needs to exactly match the query term.
7877
+ # Corresponds to the JSON property `fullMatch`
7878
+ # @return [Boolean]
7879
+ attr_accessor :full_match
7880
+ alias_method :full_match?, :full_match
7369
7881
 
7370
- # Operation last update time. If the operation is done, this is also the finish
7371
- # time.
7372
- # Corresponds to the JSON property `updateTime`
7882
+ # The specific query value to match against Must be lowercase, must be UTF-8.
7883
+ # Can have at most 3 space separated terms if full_match is true. Cannot be an
7884
+ # empty string. Maximum length of 5000 characters.
7885
+ # Corresponds to the JSON property `value`
7373
7886
  # @return [String]
7374
- attr_accessor :update_time
7887
+ attr_accessor :value
7375
7888
 
7376
7889
  def initialize(**args)
7377
7890
  update!(**args)
@@ -7379,25 +7892,24 @@ module Google
7379
7892
 
7380
7893
  # Update properties of this object
7381
7894
  def update!(**args)
7382
- @create_time = args[:create_time] if args.key?(:create_time)
7383
- @update_time = args[:update_time] if args.key?(:update_time)
7895
+ @full_match = args[:full_match] if args.key?(:full_match)
7896
+ @value = args[:value] if args.key?(:value)
7384
7897
  end
7385
7898
  end
7386
7899
 
7387
- # Metadata for Create Schema LRO.
7388
- class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
7900
+ # Used for time-dependent conditions.
7901
+ class GoogleCloudDiscoveryengineV1alphaConditionTimeRange
7389
7902
  include Google::Apis::Core::Hashable
7390
7903
 
7391
- # Operation create time.
7392
- # Corresponds to the JSON property `createTime`
7904
+ # End of time range. Range is inclusive. Must be in the future.
7905
+ # Corresponds to the JSON property `endTime`
7393
7906
  # @return [String]
7394
- attr_accessor :create_time
7907
+ attr_accessor :end_time
7395
7908
 
7396
- # Operation last update time. If the operation is done, this is also the finish
7397
- # time.
7398
- # Corresponds to the JSON property `updateTime`
7909
+ # Start of time range. Range is inclusive.
7910
+ # Corresponds to the JSON property `startTime`
7399
7911
  # @return [String]
7400
- attr_accessor :update_time
7912
+ attr_accessor :start_time
7401
7913
 
7402
7914
  def initialize(**args)
7403
7915
  update!(**args)
@@ -7405,27 +7917,78 @@ module Google
7405
7917
 
7406
7918
  # Update properties of this object
7407
7919
  def update!(**args)
7408
- @create_time = args[:create_time] if args.key?(:create_time)
7409
- @update_time = args[:update_time] if args.key?(:update_time)
7920
+ @end_time = args[:end_time] if args.key?(:end_time)
7921
+ @start_time = args[:start_time] if args.key?(:start_time)
7410
7922
  end
7411
7923
  end
7412
7924
 
7413
- # Metadata related to the progress of the SiteSearchEngineService.
7414
- # CreateTargetSite operation. This will be returned by the google.longrunning.
7415
- # Operation.metadata field.
7416
- class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
7925
+ # Defines a conditioned behavior to employ during serving. Must be attached to a
7926
+ # ServingConfig to be considered at serving time. Permitted actions dependent on
7927
+ # `SolutionType`.
7928
+ class GoogleCloudDiscoveryengineV1alphaControl
7417
7929
  include Google::Apis::Core::Hashable
7418
7930
 
7419
- # Operation create time.
7420
- # Corresponds to the JSON property `createTime`
7931
+ # Output only. List of all ServingConfig ids this control is attached to. May
7932
+ # take up to 10 minutes to update after changes.
7933
+ # Corresponds to the JSON property `associatedServingConfigIds`
7934
+ # @return [Array<String>]
7935
+ attr_accessor :associated_serving_config_ids
7936
+
7937
+ # Adjusts order of products in returned list.
7938
+ # Corresponds to the JSON property `boostAction`
7939
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlBoostAction]
7940
+ attr_accessor :boost_action
7941
+
7942
+ # Determines when the associated action will trigger. Omit to always apply the
7943
+ # action. Currently only a single condition may be specified. Otherwise an
7944
+ # INVALID ARGUMENT error is thrown.
7945
+ # Corresponds to the JSON property `conditions`
7946
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCondition>]
7947
+ attr_accessor :conditions
7948
+
7949
+ # Required. Human readable name. The identifier used in UI views. Must be UTF-8
7950
+ # encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT
7951
+ # error is thrown.
7952
+ # Corresponds to the JSON property `displayName`
7421
7953
  # @return [String]
7422
- attr_accessor :create_time
7954
+ attr_accessor :display_name
7423
7955
 
7424
- # Operation last update time. If the operation is done, this is also the finish
7425
- # time.
7426
- # Corresponds to the JSON property `updateTime`
7956
+ # Specified which products may be included in results. Uses same filter as boost.
7957
+ # Corresponds to the JSON property `filterAction`
7958
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlFilterAction]
7959
+ attr_accessor :filter_action
7960
+
7961
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
7962
+ # controls/*`
7963
+ # Corresponds to the JSON property `name`
7427
7964
  # @return [String]
7428
- attr_accessor :update_time
7965
+ attr_accessor :name
7966
+
7967
+ # Redirects a shopper to the provided URI.
7968
+ # Corresponds to the JSON property `redirectAction`
7969
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction]
7970
+ attr_accessor :redirect_action
7971
+
7972
+ # Required. Immutable. What solution the control belongs to. Must be compatible
7973
+ # with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
7974
+ # Corresponds to the JSON property `solutionType`
7975
+ # @return [String]
7976
+ attr_accessor :solution_type
7977
+
7978
+ # Creates a set of terms that will act as synonyms of one another. Example: "
7979
+ # happy" will also be considered as "glad", "glad" will also be considered as "
7980
+ # happy".
7981
+ # Corresponds to the JSON property `synonymsAction`
7982
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlSynonymsAction]
7983
+ attr_accessor :synonyms_action
7984
+
7985
+ # Specifies the use case for the control. Affects what condition fields can be
7986
+ # set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case
7987
+ # per control. Must be set when solution_type is SolutionType.
7988
+ # SOLUTION_TYPE_SEARCH.
7989
+ # Corresponds to the JSON property `useCases`
7990
+ # @return [Array<String>]
7991
+ attr_accessor :use_cases
7429
7992
 
7430
7993
  def initialize(**args)
7431
7994
  update!(**args)
@@ -7433,31 +7996,257 @@ module Google
7433
7996
 
7434
7997
  # Update properties of this object
7435
7998
  def update!(**args)
7436
- @create_time = args[:create_time] if args.key?(:create_time)
7437
- @update_time = args[:update_time] if args.key?(:update_time)
7999
+ @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids)
8000
+ @boost_action = args[:boost_action] if args.key?(:boost_action)
8001
+ @conditions = args[:conditions] if args.key?(:conditions)
8002
+ @display_name = args[:display_name] if args.key?(:display_name)
8003
+ @filter_action = args[:filter_action] if args.key?(:filter_action)
8004
+ @name = args[:name] if args.key?(:name)
8005
+ @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
8006
+ @solution_type = args[:solution_type] if args.key?(:solution_type)
8007
+ @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
8008
+ @use_cases = args[:use_cases] if args.key?(:use_cases)
7438
8009
  end
7439
8010
  end
7440
8011
 
7441
- # Metadata that describes a custom tuned model.
7442
- class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
8012
+ # Adjusts order of products in returned list.
8013
+ class GoogleCloudDiscoveryengineV1alphaControlBoostAction
7443
8014
  include Google::Apis::Core::Hashable
7444
8015
 
7445
- # Timestamp the Model was created at.
7446
- # Corresponds to the JSON property `createTime`
7447
- # @return [String]
7448
- attr_accessor :create_time
8016
+ # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
8017
+ # means demotion. Default is 0.0 (No-op).
8018
+ # Corresponds to the JSON property `boost`
8019
+ # @return [Float]
8020
+ attr_accessor :boost
7449
8021
 
7450
- # The display name of the model.
7451
- # Corresponds to the JSON property `displayName`
8022
+ # Required. Specifies which data store's documents can be boosted by this
8023
+ # control. Full data store name e.g. projects/123/locations/global/collections/
8024
+ # default_collection/dataStores/default_data_store
8025
+ # Corresponds to the JSON property `dataStore`
7452
8026
  # @return [String]
7453
- attr_accessor :display_name
8027
+ attr_accessor :data_store
7454
8028
 
7455
- # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
7456
- # Corresponds to the JSON property `modelState`
8029
+ # Required. Specifies which products to apply the boost to. If no filter is
8030
+ # provided all products will be boosted (No-op). Syntax documentation: https://
8031
+ # cloud.google.com/retail/docs/filter-and-order Maximum length is 5000
8032
+ # characters. Otherwise an INVALID ARGUMENT error is thrown.
8033
+ # Corresponds to the JSON property `filter`
8034
+ # @return [String]
8035
+ attr_accessor :filter
8036
+
8037
+ def initialize(**args)
8038
+ update!(**args)
8039
+ end
8040
+
8041
+ # Update properties of this object
8042
+ def update!(**args)
8043
+ @boost = args[:boost] if args.key?(:boost)
8044
+ @data_store = args[:data_store] if args.key?(:data_store)
8045
+ @filter = args[:filter] if args.key?(:filter)
8046
+ end
8047
+ end
8048
+
8049
+ # Specified which products may be included in results. Uses same filter as boost.
8050
+ class GoogleCloudDiscoveryengineV1alphaControlFilterAction
8051
+ include Google::Apis::Core::Hashable
8052
+
8053
+ # Required. Specifies which data store's documents can be filtered by this
8054
+ # control. Full data store name e.g. projects/123/locations/global/collections/
8055
+ # default_collection/dataStores/default_data_store
8056
+ # Corresponds to the JSON property `dataStore`
8057
+ # @return [String]
8058
+ attr_accessor :data_store
8059
+
8060
+ # Required. A filter to apply on the matching condition results. Required Syntax
8061
+ # documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum
8062
+ # length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
8063
+ # Corresponds to the JSON property `filter`
8064
+ # @return [String]
8065
+ attr_accessor :filter
8066
+
8067
+ def initialize(**args)
8068
+ update!(**args)
8069
+ end
8070
+
8071
+ # Update properties of this object
8072
+ def update!(**args)
8073
+ @data_store = args[:data_store] if args.key?(:data_store)
8074
+ @filter = args[:filter] if args.key?(:filter)
8075
+ end
8076
+ end
8077
+
8078
+ # Redirects a shopper to the provided URI.
8079
+ class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
8080
+ include Google::Apis::Core::Hashable
8081
+
8082
+ # Required. The URI to which the shopper will be redirected. Required. URI must
8083
+ # have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT
8084
+ # error is thrown.
8085
+ # Corresponds to the JSON property `redirectUri`
8086
+ # @return [String]
8087
+ attr_accessor :redirect_uri
8088
+
8089
+ def initialize(**args)
8090
+ update!(**args)
8091
+ end
8092
+
8093
+ # Update properties of this object
8094
+ def update!(**args)
8095
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
8096
+ end
8097
+ end
8098
+
8099
+ # Creates a set of terms that will act as synonyms of one another. Example: "
8100
+ # happy" will also be considered as "glad", "glad" will also be considered as "
8101
+ # happy".
8102
+ class GoogleCloudDiscoveryengineV1alphaControlSynonymsAction
8103
+ include Google::Apis::Core::Hashable
8104
+
8105
+ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at
8106
+ # least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
8107
+ # Corresponds to the JSON property `synonyms`
8108
+ # @return [Array<String>]
8109
+ attr_accessor :synonyms
8110
+
8111
+ def initialize(**args)
8112
+ update!(**args)
8113
+ end
8114
+
8115
+ # Update properties of this object
8116
+ def update!(**args)
8117
+ @synonyms = args[:synonyms] if args.key?(:synonyms)
8118
+ end
8119
+ end
8120
+
8121
+ # Metadata related to the progress of the DataStoreService.CreateDataStore
8122
+ # operation. This will be returned by the google.longrunning.Operation.metadata
8123
+ # field.
8124
+ class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
8125
+ include Google::Apis::Core::Hashable
8126
+
8127
+ # Operation create time.
8128
+ # Corresponds to the JSON property `createTime`
8129
+ # @return [String]
8130
+ attr_accessor :create_time
8131
+
8132
+ # Operation last update time. If the operation is done, this is also the finish
8133
+ # time.
8134
+ # Corresponds to the JSON property `updateTime`
8135
+ # @return [String]
8136
+ attr_accessor :update_time
8137
+
8138
+ def initialize(**args)
8139
+ update!(**args)
8140
+ end
8141
+
8142
+ # Update properties of this object
8143
+ def update!(**args)
8144
+ @create_time = args[:create_time] if args.key?(:create_time)
8145
+ @update_time = args[:update_time] if args.key?(:update_time)
8146
+ end
8147
+ end
8148
+
8149
+ # Metadata related to the progress of the EngineService.CreateEngine operation.
8150
+ # This will be returned by the google.longrunning.Operation.metadata field.
8151
+ class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
8152
+ include Google::Apis::Core::Hashable
8153
+
8154
+ # Operation create time.
8155
+ # Corresponds to the JSON property `createTime`
8156
+ # @return [String]
8157
+ attr_accessor :create_time
8158
+
8159
+ # Operation last update time. If the operation is done, this is also the finish
8160
+ # time.
8161
+ # Corresponds to the JSON property `updateTime`
8162
+ # @return [String]
8163
+ attr_accessor :update_time
8164
+
8165
+ def initialize(**args)
8166
+ update!(**args)
8167
+ end
8168
+
8169
+ # Update properties of this object
8170
+ def update!(**args)
8171
+ @create_time = args[:create_time] if args.key?(:create_time)
8172
+ @update_time = args[:update_time] if args.key?(:update_time)
8173
+ end
8174
+ end
8175
+
8176
+ # Metadata for Create Schema LRO.
8177
+ class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
8178
+ include Google::Apis::Core::Hashable
8179
+
8180
+ # Operation create time.
8181
+ # Corresponds to the JSON property `createTime`
8182
+ # @return [String]
8183
+ attr_accessor :create_time
8184
+
8185
+ # Operation last update time. If the operation is done, this is also the finish
8186
+ # time.
8187
+ # Corresponds to the JSON property `updateTime`
8188
+ # @return [String]
8189
+ attr_accessor :update_time
8190
+
8191
+ def initialize(**args)
8192
+ update!(**args)
8193
+ end
8194
+
8195
+ # Update properties of this object
8196
+ def update!(**args)
8197
+ @create_time = args[:create_time] if args.key?(:create_time)
8198
+ @update_time = args[:update_time] if args.key?(:update_time)
8199
+ end
8200
+ end
8201
+
8202
+ # Metadata related to the progress of the SiteSearchEngineService.
8203
+ # CreateTargetSite operation. This will be returned by the google.longrunning.
8204
+ # Operation.metadata field.
8205
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
8206
+ include Google::Apis::Core::Hashable
8207
+
8208
+ # Operation create time.
8209
+ # Corresponds to the JSON property `createTime`
8210
+ # @return [String]
8211
+ attr_accessor :create_time
8212
+
8213
+ # Operation last update time. If the operation is done, this is also the finish
8214
+ # time.
8215
+ # Corresponds to the JSON property `updateTime`
8216
+ # @return [String]
8217
+ attr_accessor :update_time
8218
+
8219
+ def initialize(**args)
8220
+ update!(**args)
8221
+ end
8222
+
8223
+ # Update properties of this object
8224
+ def update!(**args)
8225
+ @create_time = args[:create_time] if args.key?(:create_time)
8226
+ @update_time = args[:update_time] if args.key?(:update_time)
8227
+ end
8228
+ end
8229
+
8230
+ # Metadata that describes a custom tuned model.
8231
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
8232
+ include Google::Apis::Core::Hashable
8233
+
8234
+ # Timestamp the Model was created at.
8235
+ # Corresponds to the JSON property `createTime`
8236
+ # @return [String]
8237
+ attr_accessor :create_time
8238
+
8239
+ # The display name of the model.
8240
+ # Corresponds to the JSON property `displayName`
8241
+ # @return [String]
8242
+ attr_accessor :display_name
8243
+
8244
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
8245
+ # Corresponds to the JSON property `modelState`
7457
8246
  # @return [String]
7458
8247
  attr_accessor :model_state
7459
8248
 
7460
- #
8249
+ # The version of the model.
7461
8250
  # Corresponds to the JSON property `modelVersion`
7462
8251
  # @return [Fixnum]
7463
8252
  attr_accessor :model_version
@@ -8170,8 +8959,8 @@ module Google
8170
8959
  class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
8171
8960
  include Google::Apis::Core::Hashable
8172
8961
 
8173
- # Immutable. The name of the company, business or entity that is associated with
8174
- # the engine. Setting this may help improve LLM related features.
8962
+ # The name of the company, business or entity that is associated with the engine.
8963
+ # Setting this may help improve LLM related features.
8175
8964
  # Corresponds to the JSON property `companyName`
8176
8965
  # @return [String]
8177
8966
  attr_accessor :company_name
@@ -8489,6 +9278,17 @@ module Google
8489
9278
  # @return [String]
8490
9279
  attr_accessor :retrievable_option
8491
9280
 
9281
+ # Field paths for indexing custom attribute from schema.org data. More details
9282
+ # of schema.org and its defined types can be found at [schema.org](https://
9283
+ # schema.org). It is only used on advanced site search schema. Currently only
9284
+ # support full path from root. The full path to a field is constructed by
9285
+ # concatenating field names, starting from `_root`, with a period `.` as the
9286
+ # delimiter. Examples: * Publish date of the root: _root.datePublished * Publish
9287
+ # date of the reviews: _root.review.datePublished
9288
+ # Corresponds to the JSON property `schemaOrgPaths`
9289
+ # @return [Array<String>]
9290
+ attr_accessor :schema_org_paths
9291
+
8492
9292
  # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by
8493
9293
  # text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is
8494
9294
  # numerical, field values will not be searchable by text queries in
@@ -8518,6 +9318,7 @@ module Google
8518
9318
  @key_property_type = args[:key_property_type] if args.key?(:key_property_type)
8519
9319
  @recs_filterable_option = args[:recs_filterable_option] if args.key?(:recs_filterable_option)
8520
9320
  @retrievable_option = args[:retrievable_option] if args.key?(:retrievable_option)
9321
+ @schema_org_paths = args[:schema_org_paths] if args.key?(:schema_org_paths)
8521
9322
  @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
8522
9323
  end
8523
9324
  end
@@ -9740,6 +10541,281 @@ module Google
9740
10541
  end
9741
10542
  end
9742
10543
 
10544
+ # Defines circumstances to be checked before allowing a behavior
10545
+ class GoogleCloudDiscoveryengineV1betaCondition
10546
+ include Google::Apis::Core::Hashable
10547
+
10548
+ # Range of time(s) specifying when condition is active. Maximum of 10 time
10549
+ # ranges.
10550
+ # Corresponds to the JSON property `activeTimeRange`
10551
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaConditionTimeRange>]
10552
+ attr_accessor :active_time_range
10553
+
10554
+ # Search only A list of terms to match the query on. Maximum of 10 query terms.
10555
+ # Corresponds to the JSON property `queryTerms`
10556
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaConditionQueryTerm>]
10557
+ attr_accessor :query_terms
10558
+
10559
+ def initialize(**args)
10560
+ update!(**args)
10561
+ end
10562
+
10563
+ # Update properties of this object
10564
+ def update!(**args)
10565
+ @active_time_range = args[:active_time_range] if args.key?(:active_time_range)
10566
+ @query_terms = args[:query_terms] if args.key?(:query_terms)
10567
+ end
10568
+ end
10569
+
10570
+ # Matcher for search request query
10571
+ class GoogleCloudDiscoveryengineV1betaConditionQueryTerm
10572
+ include Google::Apis::Core::Hashable
10573
+
10574
+ # Whether the search query needs to exactly match the query term.
10575
+ # Corresponds to the JSON property `fullMatch`
10576
+ # @return [Boolean]
10577
+ attr_accessor :full_match
10578
+ alias_method :full_match?, :full_match
10579
+
10580
+ # The specific query value to match against Must be lowercase, must be UTF-8.
10581
+ # Can have at most 3 space separated terms if full_match is true. Cannot be an
10582
+ # empty string. Maximum length of 5000 characters.
10583
+ # Corresponds to the JSON property `value`
10584
+ # @return [String]
10585
+ attr_accessor :value
10586
+
10587
+ def initialize(**args)
10588
+ update!(**args)
10589
+ end
10590
+
10591
+ # Update properties of this object
10592
+ def update!(**args)
10593
+ @full_match = args[:full_match] if args.key?(:full_match)
10594
+ @value = args[:value] if args.key?(:value)
10595
+ end
10596
+ end
10597
+
10598
+ # Used for time-dependent conditions.
10599
+ class GoogleCloudDiscoveryengineV1betaConditionTimeRange
10600
+ include Google::Apis::Core::Hashable
10601
+
10602
+ # End of time range. Range is inclusive. Must be in the future.
10603
+ # Corresponds to the JSON property `endTime`
10604
+ # @return [String]
10605
+ attr_accessor :end_time
10606
+
10607
+ # Start of time range. Range is inclusive.
10608
+ # Corresponds to the JSON property `startTime`
10609
+ # @return [String]
10610
+ attr_accessor :start_time
10611
+
10612
+ def initialize(**args)
10613
+ update!(**args)
10614
+ end
10615
+
10616
+ # Update properties of this object
10617
+ def update!(**args)
10618
+ @end_time = args[:end_time] if args.key?(:end_time)
10619
+ @start_time = args[:start_time] if args.key?(:start_time)
10620
+ end
10621
+ end
10622
+
10623
+ # Defines a conditioned behavior to employ during serving. Must be attached to a
10624
+ # ServingConfig to be considered at serving time. Permitted actions dependent on
10625
+ # `SolutionType`.
10626
+ class GoogleCloudDiscoveryengineV1betaControl
10627
+ include Google::Apis::Core::Hashable
10628
+
10629
+ # Output only. List of all ServingConfig ids this control is attached to. May
10630
+ # take up to 10 minutes to update after changes.
10631
+ # Corresponds to the JSON property `associatedServingConfigIds`
10632
+ # @return [Array<String>]
10633
+ attr_accessor :associated_serving_config_ids
10634
+
10635
+ # Adjusts order of products in returned list.
10636
+ # Corresponds to the JSON property `boostAction`
10637
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlBoostAction]
10638
+ attr_accessor :boost_action
10639
+
10640
+ # Determines when the associated action will trigger. Omit to always apply the
10641
+ # action. Currently only a single condition may be specified. Otherwise an
10642
+ # INVALID ARGUMENT error is thrown.
10643
+ # Corresponds to the JSON property `conditions`
10644
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCondition>]
10645
+ attr_accessor :conditions
10646
+
10647
+ # Required. Human readable name. The identifier used in UI views. Must be UTF-8
10648
+ # encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT
10649
+ # error is thrown.
10650
+ # Corresponds to the JSON property `displayName`
10651
+ # @return [String]
10652
+ attr_accessor :display_name
10653
+
10654
+ # Specified which products may be included in results. Uses same filter as boost.
10655
+ # Corresponds to the JSON property `filterAction`
10656
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction]
10657
+ attr_accessor :filter_action
10658
+
10659
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
10660
+ # controls/*`
10661
+ # Corresponds to the JSON property `name`
10662
+ # @return [String]
10663
+ attr_accessor :name
10664
+
10665
+ # Redirects a shopper to the provided URI.
10666
+ # Corresponds to the JSON property `redirectAction`
10667
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction]
10668
+ attr_accessor :redirect_action
10669
+
10670
+ # Required. Immutable. What solution the control belongs to. Must be compatible
10671
+ # with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
10672
+ # Corresponds to the JSON property `solutionType`
10673
+ # @return [String]
10674
+ attr_accessor :solution_type
10675
+
10676
+ # Creates a set of terms that will act as synonyms of one another. Example: "
10677
+ # happy" will also be considered as "glad", "glad" will also be considered as "
10678
+ # happy".
10679
+ # Corresponds to the JSON property `synonymsAction`
10680
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlSynonymsAction]
10681
+ attr_accessor :synonyms_action
10682
+
10683
+ # Specifies the use case for the control. Affects what condition fields can be
10684
+ # set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case
10685
+ # per control. Must be set when solution_type is SolutionType.
10686
+ # SOLUTION_TYPE_SEARCH.
10687
+ # Corresponds to the JSON property `useCases`
10688
+ # @return [Array<String>]
10689
+ attr_accessor :use_cases
10690
+
10691
+ def initialize(**args)
10692
+ update!(**args)
10693
+ end
10694
+
10695
+ # Update properties of this object
10696
+ def update!(**args)
10697
+ @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids)
10698
+ @boost_action = args[:boost_action] if args.key?(:boost_action)
10699
+ @conditions = args[:conditions] if args.key?(:conditions)
10700
+ @display_name = args[:display_name] if args.key?(:display_name)
10701
+ @filter_action = args[:filter_action] if args.key?(:filter_action)
10702
+ @name = args[:name] if args.key?(:name)
10703
+ @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
10704
+ @solution_type = args[:solution_type] if args.key?(:solution_type)
10705
+ @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
10706
+ @use_cases = args[:use_cases] if args.key?(:use_cases)
10707
+ end
10708
+ end
10709
+
10710
+ # Adjusts order of products in returned list.
10711
+ class GoogleCloudDiscoveryengineV1betaControlBoostAction
10712
+ include Google::Apis::Core::Hashable
10713
+
10714
+ # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
10715
+ # means demotion. Default is 0.0 (No-op).
10716
+ # Corresponds to the JSON property `boost`
10717
+ # @return [Float]
10718
+ attr_accessor :boost
10719
+
10720
+ # Required. Specifies which data store's documents can be boosted by this
10721
+ # control. Full data store name e.g. projects/123/locations/global/collections/
10722
+ # default_collection/dataStores/default_data_store
10723
+ # Corresponds to the JSON property `dataStore`
10724
+ # @return [String]
10725
+ attr_accessor :data_store
10726
+
10727
+ # Required. Specifies which products to apply the boost to. If no filter is
10728
+ # provided all products will be boosted (No-op). Syntax documentation: https://
10729
+ # cloud.google.com/retail/docs/filter-and-order Maximum length is 5000
10730
+ # characters. Otherwise an INVALID ARGUMENT error is thrown.
10731
+ # Corresponds to the JSON property `filter`
10732
+ # @return [String]
10733
+ attr_accessor :filter
10734
+
10735
+ def initialize(**args)
10736
+ update!(**args)
10737
+ end
10738
+
10739
+ # Update properties of this object
10740
+ def update!(**args)
10741
+ @boost = args[:boost] if args.key?(:boost)
10742
+ @data_store = args[:data_store] if args.key?(:data_store)
10743
+ @filter = args[:filter] if args.key?(:filter)
10744
+ end
10745
+ end
10746
+
10747
+ # Specified which products may be included in results. Uses same filter as boost.
10748
+ class GoogleCloudDiscoveryengineV1betaControlFilterAction
10749
+ include Google::Apis::Core::Hashable
10750
+
10751
+ # Required. Specifies which data store's documents can be filtered by this
10752
+ # control. Full data store name e.g. projects/123/locations/global/collections/
10753
+ # default_collection/dataStores/default_data_store
10754
+ # Corresponds to the JSON property `dataStore`
10755
+ # @return [String]
10756
+ attr_accessor :data_store
10757
+
10758
+ # Required. A filter to apply on the matching condition results. Required Syntax
10759
+ # documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum
10760
+ # length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
10761
+ # Corresponds to the JSON property `filter`
10762
+ # @return [String]
10763
+ attr_accessor :filter
10764
+
10765
+ def initialize(**args)
10766
+ update!(**args)
10767
+ end
10768
+
10769
+ # Update properties of this object
10770
+ def update!(**args)
10771
+ @data_store = args[:data_store] if args.key?(:data_store)
10772
+ @filter = args[:filter] if args.key?(:filter)
10773
+ end
10774
+ end
10775
+
10776
+ # Redirects a shopper to the provided URI.
10777
+ class GoogleCloudDiscoveryengineV1betaControlRedirectAction
10778
+ include Google::Apis::Core::Hashable
10779
+
10780
+ # Required. The URI to which the shopper will be redirected. Required. URI must
10781
+ # have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT
10782
+ # error is thrown.
10783
+ # Corresponds to the JSON property `redirectUri`
10784
+ # @return [String]
10785
+ attr_accessor :redirect_uri
10786
+
10787
+ def initialize(**args)
10788
+ update!(**args)
10789
+ end
10790
+
10791
+ # Update properties of this object
10792
+ def update!(**args)
10793
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
10794
+ end
10795
+ end
10796
+
10797
+ # Creates a set of terms that will act as synonyms of one another. Example: "
10798
+ # happy" will also be considered as "glad", "glad" will also be considered as "
10799
+ # happy".
10800
+ class GoogleCloudDiscoveryengineV1betaControlSynonymsAction
10801
+ include Google::Apis::Core::Hashable
10802
+
10803
+ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at
10804
+ # least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
10805
+ # Corresponds to the JSON property `synonyms`
10806
+ # @return [Array<String>]
10807
+ attr_accessor :synonyms
10808
+
10809
+ def initialize(**args)
10810
+ update!(**args)
10811
+ end
10812
+
10813
+ # Update properties of this object
10814
+ def update!(**args)
10815
+ @synonyms = args[:synonyms] if args.key?(:synonyms)
10816
+ end
10817
+ end
10818
+
9743
10819
  # Metadata related to the progress of the DataStoreService.CreateDataStore
9744
10820
  # operation. This will be returned by the google.longrunning.Operation.metadata
9745
10821
  # field.
@@ -9868,7 +10944,7 @@ module Google
9868
10944
  # @return [String]
9869
10945
  attr_accessor :model_state
9870
10946
 
9871
- #
10947
+ # The version of the model.
9872
10948
  # Corresponds to the JSON property `modelVersion`
9873
10949
  # @return [Fixnum]
9874
10950
  attr_accessor :model_version
@@ -10473,8 +11549,8 @@ module Google
10473
11549
  class GoogleCloudDiscoveryengineV1betaEngineCommonConfig
10474
11550
  include Google::Apis::Core::Hashable
10475
11551
 
10476
- # Immutable. The name of the company, business or entity that is associated with
10477
- # the engine. Setting this may help improve LLM related features.
11552
+ # The name of the company, business or entity that is associated with the engine.
11553
+ # Setting this may help improve LLM related features.
10478
11554
  # Corresponds to the JSON property `companyName`
10479
11555
  # @return [String]
10480
11556
  attr_accessor :company_name
@@ -10765,6 +11841,108 @@ module Google
10765
11841
  end
10766
11842
  end
10767
11843
 
11844
+ # Metadata and configurations for a Google Cloud project in the service.
11845
+ class GoogleCloudDiscoveryengineV1betaProject
11846
+ include Google::Apis::Core::Hashable
11847
+
11848
+ # Output only. The timestamp when this project is created.
11849
+ # Corresponds to the JSON property `createTime`
11850
+ # @return [String]
11851
+ attr_accessor :create_time
11852
+
11853
+ # Output only. Full resource name of the project, for example `projects/`
11854
+ # project_number``. Note that when making requests, project number and project
11855
+ # id are both acceptable, but the server will always respond in project number.
11856
+ # Corresponds to the JSON property `name`
11857
+ # @return [String]
11858
+ attr_accessor :name
11859
+
11860
+ # Output only. The timestamp when this project is successfully provisioned.
11861
+ # Empty value means this project is still provisioning and is not ready for use.
11862
+ # Corresponds to the JSON property `provisionCompletionTime`
11863
+ # @return [String]
11864
+ attr_accessor :provision_completion_time
11865
+
11866
+ # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
11867
+ # Corresponds to the JSON property `serviceTermsMap`
11868
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaProjectServiceTerms>]
11869
+ attr_accessor :service_terms_map
11870
+
11871
+ def initialize(**args)
11872
+ update!(**args)
11873
+ end
11874
+
11875
+ # Update properties of this object
11876
+ def update!(**args)
11877
+ @create_time = args[:create_time] if args.key?(:create_time)
11878
+ @name = args[:name] if args.key?(:name)
11879
+ @provision_completion_time = args[:provision_completion_time] if args.key?(:provision_completion_time)
11880
+ @service_terms_map = args[:service_terms_map] if args.key?(:service_terms_map)
11881
+ end
11882
+ end
11883
+
11884
+ # Metadata about the terms of service.
11885
+ class GoogleCloudDiscoveryengineV1betaProjectServiceTerms
11886
+ include Google::Apis::Core::Hashable
11887
+
11888
+ # The last time when the project agreed to the terms of service.
11889
+ # Corresponds to the JSON property `acceptTime`
11890
+ # @return [String]
11891
+ attr_accessor :accept_time
11892
+
11893
+ # The last time when the project declined or revoked the agreement to terms of
11894
+ # service.
11895
+ # Corresponds to the JSON property `declineTime`
11896
+ # @return [String]
11897
+ attr_accessor :decline_time
11898
+
11899
+ # The unique identifier of this terms of service. Available terms: * `
11900
+ # GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-
11901
+ # use-terms). When using this as `id`, the acceptable version to provide is `
11902
+ # 2022-11-23`.
11903
+ # Corresponds to the JSON property `id`
11904
+ # @return [String]
11905
+ attr_accessor :id
11906
+
11907
+ # Whether the project has accepted/rejected the service terms or it is still
11908
+ # pending.
11909
+ # Corresponds to the JSON property `state`
11910
+ # @return [String]
11911
+ attr_accessor :state
11912
+
11913
+ # The version string of the terms of service. For acceptable values, see the
11914
+ # comments for id above.
11915
+ # Corresponds to the JSON property `version`
11916
+ # @return [String]
11917
+ attr_accessor :version
11918
+
11919
+ def initialize(**args)
11920
+ update!(**args)
11921
+ end
11922
+
11923
+ # Update properties of this object
11924
+ def update!(**args)
11925
+ @accept_time = args[:accept_time] if args.key?(:accept_time)
11926
+ @decline_time = args[:decline_time] if args.key?(:decline_time)
11927
+ @id = args[:id] if args.key?(:id)
11928
+ @state = args[:state] if args.key?(:state)
11929
+ @version = args[:version] if args.key?(:version)
11930
+ end
11931
+ end
11932
+
11933
+ # Metadata associated with a project provision operation.
11934
+ class GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata
11935
+ include Google::Apis::Core::Hashable
11936
+
11937
+ def initialize(**args)
11938
+ update!(**args)
11939
+ end
11940
+
11941
+ # Update properties of this object
11942
+ def update!(**args)
11943
+ end
11944
+ end
11945
+
10768
11946
  # Metadata related to the progress of the PurgeDocuments operation. This will be
10769
11947
  # returned by the google.longrunning.Operation.metadata field.
10770
11948
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata