google-apis-discoveryengine_v1 0.24.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3018,6 +3018,11 @@ module Google
3018
3018
  # @return [String]
3019
3019
  attr_accessor :name
3020
3020
 
3021
+ # Optional. Single-regional CMEKs that are required for some VAIS features.
3022
+ # Corresponds to the JSON property `singleRegionKeys`
3023
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SingleRegionKey>]
3024
+ attr_accessor :single_region_keys
3025
+
3021
3026
  # Output only. State of the CmekConfig.
3022
3027
  # Corresponds to the JSON property `state`
3023
3028
  # @return [String]
@@ -3034,6 +3039,7 @@ module Google
3034
3039
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
3035
3040
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
3036
3041
  @name = args[:name] if args.key?(:name)
3042
+ @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
3037
3043
  @state = args[:state] if args.key?(:state)
3038
3044
  end
3039
3045
  end
@@ -4013,6 +4019,12 @@ module Google
4013
4019
  # @return [String]
4014
4020
  attr_accessor :industry_vertical
4015
4021
 
4022
+ # Optional. If set, this DataStore is an Infobot FAQ DataStore.
4023
+ # Corresponds to the JSON property `isInfobotFaqDataStore`
4024
+ # @return [Boolean]
4025
+ attr_accessor :is_infobot_faq_data_store
4026
+ alias_method :is_infobot_faq_data_store?, :is_infobot_faq_data_store
4027
+
4016
4028
  # Input only. The KMS key to be used to protect this DataStore at creation time.
4017
4029
  # Must be set for requests that need to comply with CMEK Org Policy protections.
4018
4030
  # If this field is set and processed successfully, the DataStore will be
@@ -4067,6 +4079,7 @@ module Google
4067
4079
  @display_name = args[:display_name] if args.key?(:display_name)
4068
4080
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
4069
4081
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
4082
+ @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
4070
4083
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
4071
4084
  @name = args[:name] if args.key?(:name)
4072
4085
  @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
@@ -4454,6 +4467,12 @@ module Google
4454
4467
  # @return [String]
4455
4468
  attr_accessor :index_time
4456
4469
 
4470
+ # Immutable. The message indicates the document index is in progress. If this
4471
+ # field is populated, the document index is pending.
4472
+ # Corresponds to the JSON property `pendingMessage`
4473
+ # @return [String]
4474
+ attr_accessor :pending_message
4475
+
4457
4476
  def initialize(**args)
4458
4477
  update!(**args)
4459
4478
  end
@@ -4462,6 +4481,7 @@ module Google
4462
4481
  def update!(**args)
4463
4482
  @error_samples = args[:error_samples] if args.key?(:error_samples)
4464
4483
  @index_time = args[:index_time] if args.key?(:index_time)
4484
+ @pending_message = args[:pending_message] if args.key?(:pending_message)
4465
4485
  end
4466
4486
  end
4467
4487
 
@@ -4813,8 +4833,8 @@ module Google
4813
4833
  attr_accessor :display_name
4814
4834
 
4815
4835
  # The industry vertical that the engine registers. The restriction of the Engine
4816
- # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
4817
- # Vertical on Engine has to match vertical of the DataStore linked to the engine.
4836
+ # industry vertical is based on DataStore: Vertical on Engine has to match
4837
+ # vertical of the DataStore linked to the engine.
4818
4838
  # Corresponds to the JSON property `industryVertical`
4819
4839
  # @return [String]
4820
4840
  attr_accessor :industry_vertical
@@ -5220,21 +5240,94 @@ module Google
5220
5240
  end
5221
5241
  end
5222
5242
 
5223
- # Grounding Fact.
5224
- class GoogleCloudDiscoveryengineV1GroundingFact
5243
+ # Top-level message sent by the client for the `GenerateGroundedContent` method.
5244
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest
5225
5245
  include Google::Apis::Core::Hashable
5226
5246
 
5227
- # Attributes associated with the fact. Common attributes include `source` (
5228
- # indicating where the fact was sourced from), `author` (indicating the author
5229
- # of the fact), and so on.
5230
- # Corresponds to the JSON property `attributes`
5247
+ # Content of the current conversation with the model. For single-turn queries,
5248
+ # this is a single instance. For multi-turn queries, this is a repeated field
5249
+ # that contains conversation history + latest request.
5250
+ # Corresponds to the JSON property `contents`
5251
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundedGenerationContent>]
5252
+ attr_accessor :contents
5253
+
5254
+ # Content generation specification.
5255
+ # Corresponds to the JSON property `generationSpec`
5256
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec]
5257
+ attr_accessor :generation_spec
5258
+
5259
+ # Grounding specification.
5260
+ # Corresponds to the JSON property `groundingSpec`
5261
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec]
5262
+ attr_accessor :grounding_spec
5263
+
5264
+ # Base structured datatype containing multi-part content of a message.
5265
+ # Corresponds to the JSON property `systemInstruction`
5266
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundedGenerationContent]
5267
+ attr_accessor :system_instruction
5268
+
5269
+ # The user labels applied to a resource must meet the following requirements: *
5270
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
5271
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
5272
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
5273
+ # have a maximum length of 63 characters. * Keys and values can contain only
5274
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
5275
+ # must use UTF-8 encoding, and international characters are allowed. * The key
5276
+ # portion of a label must be unique. However, you can use the same key with
5277
+ # multiple resources. * Keys must start with a lowercase letter or international
5278
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
5279
+ # manager/docs/creating-managing-labels#requirements) for more details.
5280
+ # Corresponds to the JSON property `userLabels`
5231
5281
  # @return [Hash<String,String>]
5232
- attr_accessor :attributes
5282
+ attr_accessor :user_labels
5233
5283
 
5234
- # Text content of the fact. Can be at most 10K characters long.
5235
- # Corresponds to the JSON property `factText`
5284
+ def initialize(**args)
5285
+ update!(**args)
5286
+ end
5287
+
5288
+ # Update properties of this object
5289
+ def update!(**args)
5290
+ @contents = args[:contents] if args.key?(:contents)
5291
+ @generation_spec = args[:generation_spec] if args.key?(:generation_spec)
5292
+ @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
5293
+ @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
5294
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
5295
+ end
5296
+ end
5297
+
5298
+ # Describes the options to customize dynamic retrieval.
5299
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration
5300
+ include Google::Apis::Core::Hashable
5301
+
5302
+ # Describes the predictor settings for dynamic retrieval.
5303
+ # Corresponds to the JSON property `predictor`
5304
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor]
5305
+ attr_accessor :predictor
5306
+
5307
+ def initialize(**args)
5308
+ update!(**args)
5309
+ end
5310
+
5311
+ # Update properties of this object
5312
+ def update!(**args)
5313
+ @predictor = args[:predictor] if args.key?(:predictor)
5314
+ end
5315
+ end
5316
+
5317
+ # Describes the predictor settings for dynamic retrieval.
5318
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor
5319
+ include Google::Apis::Core::Hashable
5320
+
5321
+ # The value of the threshold. If the predictor will predict a value smaller than
5322
+ # this, it would suppress grounding in the source.
5323
+ # Corresponds to the JSON property `threshold`
5324
+ # @return [Float]
5325
+ attr_accessor :threshold
5326
+
5327
+ # The version of the predictor to be used in dynamic retrieval.
5328
+ # Corresponds to the JSON property `version`
5236
5329
  # @return [String]
5237
- attr_accessor :fact_text
5330
+ attr_accessor :version
5238
5331
 
5239
5332
  def initialize(**args)
5240
5333
  update!(**args)
@@ -5242,36 +5335,60 @@ module Google
5242
5335
 
5243
5336
  # Update properties of this object
5244
5337
  def update!(**args)
5245
- @attributes = args[:attributes] if args.key?(:attributes)
5246
- @fact_text = args[:fact_text] if args.key?(:fact_text)
5338
+ @threshold = args[:threshold] if args.key?(:threshold)
5339
+ @version = args[:version] if args.key?(:version)
5247
5340
  end
5248
5341
  end
5249
5342
 
5250
- # Metadata related to the progress of the ImportCompletionSuggestions operation.
5251
- # This will be returned by the google.longrunning.Operation.metadata field.
5252
- class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata
5343
+ # Content generation specification.
5344
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec
5253
5345
  include Google::Apis::Core::Hashable
5254
5346
 
5255
- # Operation create time.
5256
- # Corresponds to the JSON property `createTime`
5347
+ # If specified, custom value for frequency penalty will be used.
5348
+ # Corresponds to the JSON property `frequencyPenalty`
5349
+ # @return [Float]
5350
+ attr_accessor :frequency_penalty
5351
+
5352
+ # Language code for content. Use language tags defined by [BCP47](https://www.
5353
+ # rfc-editor.org/rfc/bcp/bcp47.txt).
5354
+ # Corresponds to the JSON property `languageCode`
5257
5355
  # @return [String]
5258
- attr_accessor :create_time
5356
+ attr_accessor :language_code
5259
5357
 
5260
- # Count of CompletionSuggestions that failed to be imported.
5261
- # Corresponds to the JSON property `failureCount`
5358
+ # If specified, custom value for max output tokens will be used.
5359
+ # Corresponds to the JSON property `maxOutputTokens`
5262
5360
  # @return [Fixnum]
5263
- attr_accessor :failure_count
5361
+ attr_accessor :max_output_tokens
5264
5362
 
5265
- # Count of CompletionSuggestions successfully imported.
5266
- # Corresponds to the JSON property `successCount`
5363
+ # Specifies which Vertex model id to use for generation.
5364
+ # Corresponds to the JSON property `modelId`
5365
+ # @return [String]
5366
+ attr_accessor :model_id
5367
+
5368
+ # If specified, custom value for presence penalty will be used.
5369
+ # Corresponds to the JSON property `presencePenalty`
5370
+ # @return [Float]
5371
+ attr_accessor :presence_penalty
5372
+
5373
+ # If specified, custom value for the seed will be used.
5374
+ # Corresponds to the JSON property `seed`
5267
5375
  # @return [Fixnum]
5268
- attr_accessor :success_count
5376
+ attr_accessor :seed
5269
5377
 
5270
- # Operation last update time. If the operation is done, this is also the finish
5271
- # time.
5272
- # Corresponds to the JSON property `updateTime`
5273
- # @return [String]
5274
- attr_accessor :update_time
5378
+ # If specified, custom value for the temperature will be used.
5379
+ # Corresponds to the JSON property `temperature`
5380
+ # @return [Float]
5381
+ attr_accessor :temperature
5382
+
5383
+ # If specified, custom value for top-k sampling will be used.
5384
+ # Corresponds to the JSON property `topK`
5385
+ # @return [Fixnum]
5386
+ attr_accessor :top_k
5387
+
5388
+ # If specified, custom value for nucleus sampling will be used.
5389
+ # Corresponds to the JSON property `topP`
5390
+ # @return [Float]
5391
+ attr_accessor :top_p
5275
5392
 
5276
5393
  def initialize(**args)
5277
5394
  update!(**args)
@@ -5279,58 +5396,57 @@ module Google
5279
5396
 
5280
5397
  # Update properties of this object
5281
5398
  def update!(**args)
5282
- @create_time = args[:create_time] if args.key?(:create_time)
5283
- @failure_count = args[:failure_count] if args.key?(:failure_count)
5284
- @success_count = args[:success_count] if args.key?(:success_count)
5285
- @update_time = args[:update_time] if args.key?(:update_time)
5399
+ @frequency_penalty = args[:frequency_penalty] if args.key?(:frequency_penalty)
5400
+ @language_code = args[:language_code] if args.key?(:language_code)
5401
+ @max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
5402
+ @model_id = args[:model_id] if args.key?(:model_id)
5403
+ @presence_penalty = args[:presence_penalty] if args.key?(:presence_penalty)
5404
+ @seed = args[:seed] if args.key?(:seed)
5405
+ @temperature = args[:temperature] if args.key?(:temperature)
5406
+ @top_k = args[:top_k] if args.key?(:top_k)
5407
+ @top_p = args[:top_p] if args.key?(:top_p)
5286
5408
  end
5287
5409
  end
5288
5410
 
5289
- # Request message for CompletionService.ImportCompletionSuggestions method.
5290
- class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest
5411
+ # Grounding source.
5412
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource
5291
5413
  include Google::Apis::Core::Hashable
5292
5414
 
5293
- # BigQuery source import data from.
5294
- # Corresponds to the JSON property `bigquerySource`
5295
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigQuerySource]
5296
- attr_accessor :bigquery_source
5297
-
5298
- # Configuration of destination for Import related errors.
5299
- # Corresponds to the JSON property `errorConfig`
5300
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
5301
- attr_accessor :error_config
5302
-
5303
- # Cloud Storage location for input content.
5304
- # Corresponds to the JSON property `gcsSource`
5305
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
5306
- attr_accessor :gcs_source
5415
+ # Google Search config parameters.
5416
+ # Corresponds to the JSON property `googleSearchSource`
5417
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource]
5418
+ attr_accessor :google_search_source
5307
5419
 
5308
- # The inline source for CompletionSuggestions.
5420
+ # Message to be used for grounding based on inline content.
5309
5421
  # Corresponds to the JSON property `inlineSource`
5310
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource]
5422
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource]
5311
5423
  attr_accessor :inline_source
5312
5424
 
5425
+ # Message to be used for grounding with Vertex AI Search.
5426
+ # Corresponds to the JSON property `searchSource`
5427
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource]
5428
+ attr_accessor :search_source
5429
+
5313
5430
  def initialize(**args)
5314
5431
  update!(**args)
5315
5432
  end
5316
5433
 
5317
5434
  # Update properties of this object
5318
5435
  def update!(**args)
5319
- @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
5320
- @error_config = args[:error_config] if args.key?(:error_config)
5321
- @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
5436
+ @google_search_source = args[:google_search_source] if args.key?(:google_search_source)
5322
5437
  @inline_source = args[:inline_source] if args.key?(:inline_source)
5438
+ @search_source = args[:search_source] if args.key?(:search_source)
5323
5439
  end
5324
5440
  end
5325
5441
 
5326
- # The inline source for CompletionSuggestions.
5327
- class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource
5442
+ # Google Search config parameters.
5443
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource
5328
5444
  include Google::Apis::Core::Hashable
5329
5445
 
5330
- # Required. A list of all denylist entries to import. Max of 1000 items.
5331
- # Corresponds to the JSON property `suggestions`
5332
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionSuggestion>]
5333
- attr_accessor :suggestions
5446
+ # Describes the options to customize dynamic retrieval.
5447
+ # Corresponds to the JSON property `dynamicRetrievalConfig`
5448
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration]
5449
+ attr_accessor :dynamic_retrieval_config
5334
5450
 
5335
5451
  def initialize(**args)
5336
5452
  update!(**args)
@@ -5338,25 +5454,25 @@ module Google
5338
5454
 
5339
5455
  # Update properties of this object
5340
5456
  def update!(**args)
5341
- @suggestions = args[:suggestions] if args.key?(:suggestions)
5457
+ @dynamic_retrieval_config = args[:dynamic_retrieval_config] if args.key?(:dynamic_retrieval_config)
5342
5458
  end
5343
5459
  end
5344
5460
 
5345
- # Response of the CompletionService.ImportCompletionSuggestions method. If the
5346
- # long running operation is done, this message is returned by the google.
5347
- # longrunning.Operations.response field if the operation is successful.
5348
- class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse
5461
+ # Message to be used for grounding based on inline content.
5462
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource
5349
5463
  include Google::Apis::Core::Hashable
5350
5464
 
5351
- # Configuration of destination for Import related errors.
5352
- # Corresponds to the JSON property `errorConfig`
5353
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
5354
- attr_accessor :error_config
5465
+ # Attributes associated with the content. Common attributes include `source` (
5466
+ # indicating where the content was sourced from) and `author` (indicating the
5467
+ # author of the content).
5468
+ # Corresponds to the JSON property `attributes`
5469
+ # @return [Hash<String,String>]
5470
+ attr_accessor :attributes
5355
5471
 
5356
- # A sample of errors encountered while processing the request.
5357
- # Corresponds to the JSON property `errorSamples`
5358
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
5359
- attr_accessor :error_samples
5472
+ # List of facts to be used for grounding.
5473
+ # Corresponds to the JSON property `groundingFacts`
5474
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundingFact>]
5475
+ attr_accessor :grounding_facts
5360
5476
 
5361
5477
  def initialize(**args)
5362
5478
  update!(**args)
@@ -5364,41 +5480,39 @@ module Google
5364
5480
 
5365
5481
  # Update properties of this object
5366
5482
  def update!(**args)
5367
- @error_config = args[:error_config] if args.key?(:error_config)
5368
- @error_samples = args[:error_samples] if args.key?(:error_samples)
5483
+ @attributes = args[:attributes] if args.key?(:attributes)
5484
+ @grounding_facts = args[:grounding_facts] if args.key?(:grounding_facts)
5369
5485
  end
5370
5486
  end
5371
5487
 
5372
- # Metadata related to the progress of the ImportDocuments operation. This is
5373
- # returned by the google.longrunning.Operation.metadata field.
5374
- class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
5488
+ # Message to be used for grounding with Vertex AI Search.
5489
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource
5375
5490
  include Google::Apis::Core::Hashable
5376
5491
 
5377
- # Operation create time.
5378
- # Corresponds to the JSON property `createTime`
5492
+ # Filter expression to be applied to the search. The syntax is the same as
5493
+ # SearchRequest.filter.
5494
+ # Corresponds to the JSON property `filter`
5379
5495
  # @return [String]
5380
- attr_accessor :create_time
5381
-
5382
- # Count of entries that encountered errors while processing.
5383
- # Corresponds to the JSON property `failureCount`
5384
- # @return [Fixnum]
5385
- attr_accessor :failure_count
5496
+ attr_accessor :filter
5386
5497
 
5387
- # Count of entries that were processed successfully.
5388
- # Corresponds to the JSON property `successCount`
5498
+ # Number of search results to return. The default value is 10. The maximumm
5499
+ # allowed value is 10.
5500
+ # Corresponds to the JSON property `maxResultCount`
5389
5501
  # @return [Fixnum]
5390
- attr_accessor :success_count
5502
+ attr_accessor :max_result_count
5391
5503
 
5392
- # Total count of entries that were processed.
5393
- # Corresponds to the JSON property `totalCount`
5394
- # @return [Fixnum]
5395
- attr_accessor :total_count
5504
+ # If set, safe search is enabled in Vertex AI Search requests.
5505
+ # Corresponds to the JSON property `safeSearch`
5506
+ # @return [Boolean]
5507
+ attr_accessor :safe_search
5508
+ alias_method :safe_search?, :safe_search
5396
5509
 
5397
- # Operation last update time. If the operation is done, this is also the finish
5398
- # time.
5399
- # Corresponds to the JSON property `updateTime`
5510
+ # The resource name of the Engine to use. Format: `projects/`project`/locations/`
5511
+ # location`/collections/`collection_id`/engines/`engine_id`/servingConfigs/`
5512
+ # serving_config_id``
5513
+ # Corresponds to the JSON property `servingConfig`
5400
5514
  # @return [String]
5401
- attr_accessor :update_time
5515
+ attr_accessor :serving_config
5402
5516
 
5403
5517
  def initialize(**args)
5404
5518
  update!(**args)
@@ -5406,71 +5520,565 @@ module Google
5406
5520
 
5407
5521
  # Update properties of this object
5408
5522
  def update!(**args)
5409
- @create_time = args[:create_time] if args.key?(:create_time)
5410
- @failure_count = args[:failure_count] if args.key?(:failure_count)
5411
- @success_count = args[:success_count] if args.key?(:success_count)
5412
- @total_count = args[:total_count] if args.key?(:total_count)
5413
- @update_time = args[:update_time] if args.key?(:update_time)
5523
+ @filter = args[:filter] if args.key?(:filter)
5524
+ @max_result_count = args[:max_result_count] if args.key?(:max_result_count)
5525
+ @safe_search = args[:safe_search] if args.key?(:safe_search)
5526
+ @serving_config = args[:serving_config] if args.key?(:serving_config)
5414
5527
  end
5415
5528
  end
5416
5529
 
5417
- # Request message for Import methods.
5418
- class GoogleCloudDiscoveryengineV1ImportDocumentsRequest
5530
+ # Grounding specification.
5531
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec
5419
5532
  include Google::Apis::Core::Hashable
5420
5533
 
5421
- # AlloyDB source import data from.
5422
- # Corresponds to the JSON property `alloyDbSource`
5423
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AlloyDbSource]
5424
- attr_accessor :alloy_db_source
5534
+ # Grounding sources.
5535
+ # Corresponds to the JSON property `groundingSources`
5536
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource>]
5537
+ attr_accessor :grounding_sources
5425
5538
 
5426
- # Whether to automatically generate IDs for the documents if absent. If set to `
5427
- # true`, Document.ids are automatically generated based on the hash of the
5428
- # payload, where IDs may not be consistent during multiple imports. In which
5429
- # case ReconciliationMode.FULL is highly recommended to avoid duplicate contents.
5430
- # If unset or set to `false`, Document.ids have to be specified using id_field,
5431
- # otherwise, documents without IDs fail to be imported. Supported data sources: *
5432
- # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
5433
- # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
5434
- # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
5435
- # SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
5436
- # Corresponds to the JSON property `autoGenerateIds`
5437
- # @return [Boolean]
5438
- attr_accessor :auto_generate_ids
5439
- alias_method :auto_generate_ids?, :auto_generate_ids
5539
+ def initialize(**args)
5540
+ update!(**args)
5541
+ end
5440
5542
 
5441
- # BigQuery source import data from.
5442
- # Corresponds to the JSON property `bigquerySource`
5443
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigQuerySource]
5444
- attr_accessor :bigquery_source
5543
+ # Update properties of this object
5544
+ def update!(**args)
5545
+ @grounding_sources = args[:grounding_sources] if args.key?(:grounding_sources)
5546
+ end
5547
+ end
5445
5548
 
5446
- # The Cloud Bigtable source for importing data.
5447
- # Corresponds to the JSON property `bigtableSource`
5448
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigtableSource]
5449
- attr_accessor :bigtable_source
5549
+ # Response for the `GenerateGroundedContent` method.
5550
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse
5551
+ include Google::Apis::Core::Hashable
5450
5552
 
5451
- # Cloud SQL source import data from.
5452
- # Corresponds to the JSON property `cloudSqlSource`
5453
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CloudSqlSource]
5454
- attr_accessor :cloud_sql_source
5553
+ # Generated candidates.
5554
+ # Corresponds to the JSON property `candidates`
5555
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate>]
5556
+ attr_accessor :candidates
5455
5557
 
5456
- # Configuration of destination for Import related errors.
5457
- # Corresponds to the JSON property `errorConfig`
5458
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
5459
- attr_accessor :error_config
5558
+ def initialize(**args)
5559
+ update!(**args)
5560
+ end
5460
5561
 
5461
- # Cloud FhirStore source import data from.
5462
- # Corresponds to the JSON property `fhirStoreSource`
5463
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FhirStoreSource]
5464
- attr_accessor :fhir_store_source
5562
+ # Update properties of this object
5563
+ def update!(**args)
5564
+ @candidates = args[:candidates] if args.key?(:candidates)
5565
+ end
5566
+ end
5465
5567
 
5466
- # Firestore source import data from.
5467
- # Corresponds to the JSON property `firestoreSource`
5468
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FirestoreSource]
5469
- attr_accessor :firestore_source
5568
+ # A response candidate generated from the model.
5569
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate
5570
+ include Google::Apis::Core::Hashable
5470
5571
 
5471
- # Cloud Storage location for input content.
5472
- # Corresponds to the JSON property `gcsSource`
5473
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
5572
+ # Base structured datatype containing multi-part content of a message.
5573
+ # Corresponds to the JSON property `content`
5574
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundedGenerationContent]
5575
+ attr_accessor :content
5576
+
5577
+ # Citation for the generated content.
5578
+ # Corresponds to the JSON property `groundingMetadata`
5579
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata]
5580
+ attr_accessor :grounding_metadata
5581
+
5582
+ # The overall grounding score for the candidate, in the range of [0, 1].
5583
+ # Corresponds to the JSON property `groundingScore`
5584
+ # @return [Float]
5585
+ attr_accessor :grounding_score
5586
+
5587
+ # Index of the candidate.
5588
+ # Corresponds to the JSON property `index`
5589
+ # @return [Fixnum]
5590
+ attr_accessor :index
5591
+
5592
+ def initialize(**args)
5593
+ update!(**args)
5594
+ end
5595
+
5596
+ # Update properties of this object
5597
+ def update!(**args)
5598
+ @content = args[:content] if args.key?(:content)
5599
+ @grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
5600
+ @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
5601
+ @index = args[:index] if args.key?(:index)
5602
+ end
5603
+ end
5604
+
5605
+ # Citation for the generated content.
5606
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata
5607
+ include Google::Apis::Core::Hashable
5608
+
5609
+ # GroundingSupport across all claims in the answer candidate. An support to a
5610
+ # fact indicates that the claim is supported by the fact.
5611
+ # Corresponds to the JSON property `groundingSupport`
5612
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>]
5613
+ attr_accessor :grounding_support
5614
+
5615
+ # Retrieval metadata to provide an understanding in the retrieval steps
5616
+ # performed by the model. There can be multiple such messages which can
5617
+ # correspond to different parts of the retrieval. This is a mechanism used to
5618
+ # ensure transparency to our users.
5619
+ # Corresponds to the JSON property `retrievalMetadata`
5620
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>]
5621
+ attr_accessor :retrieval_metadata
5622
+
5623
+ # Google search entry point.
5624
+ # Corresponds to the JSON property `searchEntryPoint`
5625
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint]
5626
+ attr_accessor :search_entry_point
5627
+
5628
+ # List of chunks to be attributed across all claims in the candidate. These are
5629
+ # derived from the grounding sources supplied in the request.
5630
+ # Corresponds to the JSON property `supportChunks`
5631
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk>]
5632
+ attr_accessor :support_chunks
5633
+
5634
+ # Web search queries for the following-up web search.
5635
+ # Corresponds to the JSON property `webSearchQueries`
5636
+ # @return [Array<String>]
5637
+ attr_accessor :web_search_queries
5638
+
5639
+ def initialize(**args)
5640
+ update!(**args)
5641
+ end
5642
+
5643
+ # Update properties of this object
5644
+ def update!(**args)
5645
+ @grounding_support = args[:grounding_support] if args.key?(:grounding_support)
5646
+ @retrieval_metadata = args[:retrieval_metadata] if args.key?(:retrieval_metadata)
5647
+ @search_entry_point = args[:search_entry_point] if args.key?(:search_entry_point)
5648
+ @support_chunks = args[:support_chunks] if args.key?(:support_chunks)
5649
+ @web_search_queries = args[:web_search_queries] if args.key?(:web_search_queries)
5650
+ end
5651
+ end
5652
+
5653
+ # Describes the metadata about dynamic retrieval.
5654
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata
5655
+ include Google::Apis::Core::Hashable
5656
+
5657
+ # Describes the metadata about the dynamic retrieval predictor.
5658
+ # Corresponds to the JSON property `predictorMetadata`
5659
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata]
5660
+ attr_accessor :predictor_metadata
5661
+
5662
+ def initialize(**args)
5663
+ update!(**args)
5664
+ end
5665
+
5666
+ # Update properties of this object
5667
+ def update!(**args)
5668
+ @predictor_metadata = args[:predictor_metadata] if args.key?(:predictor_metadata)
5669
+ end
5670
+ end
5671
+
5672
+ # Describes the metadata about the dynamic retrieval predictor.
5673
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata
5674
+ include Google::Apis::Core::Hashable
5675
+
5676
+ # The value of the predictor. This should be between [0, 1] where a value of 0
5677
+ # means that the query would not benefit from grounding, while a value of 1.0
5678
+ # means that the query would benefit the most. In between values allow to
5679
+ # differentiate between different usefulness scores for grounding.
5680
+ # Corresponds to the JSON property `prediction`
5681
+ # @return [Float]
5682
+ attr_accessor :prediction
5683
+
5684
+ # The version of the predictor which was used in dynamic retrieval.
5685
+ # Corresponds to the JSON property `version`
5686
+ # @return [String]
5687
+ attr_accessor :version
5688
+
5689
+ def initialize(**args)
5690
+ update!(**args)
5691
+ end
5692
+
5693
+ # Update properties of this object
5694
+ def update!(**args)
5695
+ @prediction = args[:prediction] if args.key?(:prediction)
5696
+ @version = args[:version] if args.key?(:version)
5697
+ end
5698
+ end
5699
+
5700
+ # Grounding info for a claim in the candidate and its support.
5701
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport
5702
+ include Google::Apis::Core::Hashable
5703
+
5704
+ # Text for the claim in the candidate. Always provided when a support is found.
5705
+ # Corresponds to the JSON property `claimText`
5706
+ # @return [String]
5707
+ attr_accessor :claim_text
5708
+
5709
+ # A list of indices (into 'support_chunks') specifying the citations associated
5710
+ # with the claim. For instance [1,3,4] means that support_chunks[1],
5711
+ # support_chunks[3], support_chunks[4] are the chunks attributed to the claim.
5712
+ # Corresponds to the JSON property `supportChunkIndices`
5713
+ # @return [Array<Fixnum>]
5714
+ attr_accessor :support_chunk_indices
5715
+
5716
+ # A score in the range of [0, 1] describing how grounded is a specific claim in
5717
+ # the support chunks indicated. Higher value means that the claim is better
5718
+ # supported by the chunks.
5719
+ # Corresponds to the JSON property `supportScore`
5720
+ # @return [Float]
5721
+ attr_accessor :support_score
5722
+
5723
+ def initialize(**args)
5724
+ update!(**args)
5725
+ end
5726
+
5727
+ # Update properties of this object
5728
+ def update!(**args)
5729
+ @claim_text = args[:claim_text] if args.key?(:claim_text)
5730
+ @support_chunk_indices = args[:support_chunk_indices] if args.key?(:support_chunk_indices)
5731
+ @support_score = args[:support_score] if args.key?(:support_score)
5732
+ end
5733
+ end
5734
+
5735
+ # Describes the metadata associated with a retrieval step.
5736
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata
5737
+ include Google::Apis::Core::Hashable
5738
+
5739
+ # Describes the metadata about dynamic retrieval.
5740
+ # Corresponds to the JSON property `dynamicRetrievalMetadata`
5741
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata]
5742
+ attr_accessor :dynamic_retrieval_metadata
5743
+
5744
+ # Describes the source to which the metadata is referring to.
5745
+ # Corresponds to the JSON property `source`
5746
+ # @return [String]
5747
+ attr_accessor :source
5748
+
5749
+ def initialize(**args)
5750
+ update!(**args)
5751
+ end
5752
+
5753
+ # Update properties of this object
5754
+ def update!(**args)
5755
+ @dynamic_retrieval_metadata = args[:dynamic_retrieval_metadata] if args.key?(:dynamic_retrieval_metadata)
5756
+ @source = args[:source] if args.key?(:source)
5757
+ end
5758
+ end
5759
+
5760
+ # Google search entry point.
5761
+ class GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint
5762
+ include Google::Apis::Core::Hashable
5763
+
5764
+ # Web content snippet that can be embedded in a web page or an app webview.
5765
+ # Corresponds to the JSON property `renderedContent`
5766
+ # @return [String]
5767
+ attr_accessor :rendered_content
5768
+
5769
+ # Base64 encoded JSON representing array of tuple.
5770
+ # Corresponds to the JSON property `sdkBlob`
5771
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
5772
+ # @return [String]
5773
+ attr_accessor :sdk_blob
5774
+
5775
+ def initialize(**args)
5776
+ update!(**args)
5777
+ end
5778
+
5779
+ # Update properties of this object
5780
+ def update!(**args)
5781
+ @rendered_content = args[:rendered_content] if args.key?(:rendered_content)
5782
+ @sdk_blob = args[:sdk_blob] if args.key?(:sdk_blob)
5783
+ end
5784
+ end
5785
+
5786
+ # Base structured datatype containing multi-part content of a message.
5787
+ class GoogleCloudDiscoveryengineV1GroundedGenerationContent
5788
+ include Google::Apis::Core::Hashable
5789
+
5790
+ # Ordered `Parts` that constitute a single message.
5791
+ # Corresponds to the JSON property `parts`
5792
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundedGenerationContentPart>]
5793
+ attr_accessor :parts
5794
+
5795
+ # Producer of the content. Must be either `user` or `model`. Intended to be used
5796
+ # for multi-turn conversations. Otherwise, it can be left unset.
5797
+ # Corresponds to the JSON property `role`
5798
+ # @return [String]
5799
+ attr_accessor :role
5800
+
5801
+ def initialize(**args)
5802
+ update!(**args)
5803
+ end
5804
+
5805
+ # Update properties of this object
5806
+ def update!(**args)
5807
+ @parts = args[:parts] if args.key?(:parts)
5808
+ @role = args[:role] if args.key?(:role)
5809
+ end
5810
+ end
5811
+
5812
+ # Single part of content.
5813
+ class GoogleCloudDiscoveryengineV1GroundedGenerationContentPart
5814
+ include Google::Apis::Core::Hashable
5815
+
5816
+ # Inline text.
5817
+ # Corresponds to the JSON property `text`
5818
+ # @return [String]
5819
+ attr_accessor :text
5820
+
5821
+ def initialize(**args)
5822
+ update!(**args)
5823
+ end
5824
+
5825
+ # Update properties of this object
5826
+ def update!(**args)
5827
+ @text = args[:text] if args.key?(:text)
5828
+ end
5829
+ end
5830
+
5831
+ # Grounding Fact.
5832
+ class GoogleCloudDiscoveryengineV1GroundingFact
5833
+ include Google::Apis::Core::Hashable
5834
+
5835
+ # Attributes associated with the fact. Common attributes include `source` (
5836
+ # indicating where the fact was sourced from), `author` (indicating the author
5837
+ # of the fact), and so on.
5838
+ # Corresponds to the JSON property `attributes`
5839
+ # @return [Hash<String,String>]
5840
+ attr_accessor :attributes
5841
+
5842
+ # Text content of the fact. Can be at most 10K characters long.
5843
+ # Corresponds to the JSON property `factText`
5844
+ # @return [String]
5845
+ attr_accessor :fact_text
5846
+
5847
+ def initialize(**args)
5848
+ update!(**args)
5849
+ end
5850
+
5851
+ # Update properties of this object
5852
+ def update!(**args)
5853
+ @attributes = args[:attributes] if args.key?(:attributes)
5854
+ @fact_text = args[:fact_text] if args.key?(:fact_text)
5855
+ end
5856
+ end
5857
+
5858
+ # Metadata related to the progress of the ImportCompletionSuggestions operation.
5859
+ # This will be returned by the google.longrunning.Operation.metadata field.
5860
+ class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata
5861
+ include Google::Apis::Core::Hashable
5862
+
5863
+ # Operation create time.
5864
+ # Corresponds to the JSON property `createTime`
5865
+ # @return [String]
5866
+ attr_accessor :create_time
5867
+
5868
+ # Count of CompletionSuggestions that failed to be imported.
5869
+ # Corresponds to the JSON property `failureCount`
5870
+ # @return [Fixnum]
5871
+ attr_accessor :failure_count
5872
+
5873
+ # Count of CompletionSuggestions successfully imported.
5874
+ # Corresponds to the JSON property `successCount`
5875
+ # @return [Fixnum]
5876
+ attr_accessor :success_count
5877
+
5878
+ # Operation last update time. If the operation is done, this is also the finish
5879
+ # time.
5880
+ # Corresponds to the JSON property `updateTime`
5881
+ # @return [String]
5882
+ attr_accessor :update_time
5883
+
5884
+ def initialize(**args)
5885
+ update!(**args)
5886
+ end
5887
+
5888
+ # Update properties of this object
5889
+ def update!(**args)
5890
+ @create_time = args[:create_time] if args.key?(:create_time)
5891
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
5892
+ @success_count = args[:success_count] if args.key?(:success_count)
5893
+ @update_time = args[:update_time] if args.key?(:update_time)
5894
+ end
5895
+ end
5896
+
5897
+ # Request message for CompletionService.ImportCompletionSuggestions method.
5898
+ class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest
5899
+ include Google::Apis::Core::Hashable
5900
+
5901
+ # BigQuery source import data from.
5902
+ # Corresponds to the JSON property `bigquerySource`
5903
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigQuerySource]
5904
+ attr_accessor :bigquery_source
5905
+
5906
+ # Configuration of destination for Import related errors.
5907
+ # Corresponds to the JSON property `errorConfig`
5908
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
5909
+ attr_accessor :error_config
5910
+
5911
+ # Cloud Storage location for input content.
5912
+ # Corresponds to the JSON property `gcsSource`
5913
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
5914
+ attr_accessor :gcs_source
5915
+
5916
+ # The inline source for CompletionSuggestions.
5917
+ # Corresponds to the JSON property `inlineSource`
5918
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource]
5919
+ attr_accessor :inline_source
5920
+
5921
+ def initialize(**args)
5922
+ update!(**args)
5923
+ end
5924
+
5925
+ # Update properties of this object
5926
+ def update!(**args)
5927
+ @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
5928
+ @error_config = args[:error_config] if args.key?(:error_config)
5929
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
5930
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
5931
+ end
5932
+ end
5933
+
5934
+ # The inline source for CompletionSuggestions.
5935
+ class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource
5936
+ include Google::Apis::Core::Hashable
5937
+
5938
+ # Required. A list of all denylist entries to import. Max of 1000 items.
5939
+ # Corresponds to the JSON property `suggestions`
5940
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionSuggestion>]
5941
+ attr_accessor :suggestions
5942
+
5943
+ def initialize(**args)
5944
+ update!(**args)
5945
+ end
5946
+
5947
+ # Update properties of this object
5948
+ def update!(**args)
5949
+ @suggestions = args[:suggestions] if args.key?(:suggestions)
5950
+ end
5951
+ end
5952
+
5953
+ # Response of the CompletionService.ImportCompletionSuggestions method. If the
5954
+ # long running operation is done, this message is returned by the google.
5955
+ # longrunning.Operations.response field if the operation is successful.
5956
+ class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse
5957
+ include Google::Apis::Core::Hashable
5958
+
5959
+ # Configuration of destination for Import related errors.
5960
+ # Corresponds to the JSON property `errorConfig`
5961
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
5962
+ attr_accessor :error_config
5963
+
5964
+ # A sample of errors encountered while processing the request.
5965
+ # Corresponds to the JSON property `errorSamples`
5966
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
5967
+ attr_accessor :error_samples
5968
+
5969
+ def initialize(**args)
5970
+ update!(**args)
5971
+ end
5972
+
5973
+ # Update properties of this object
5974
+ def update!(**args)
5975
+ @error_config = args[:error_config] if args.key?(:error_config)
5976
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
5977
+ end
5978
+ end
5979
+
5980
+ # Metadata related to the progress of the ImportDocuments operation. This is
5981
+ # returned by the google.longrunning.Operation.metadata field.
5982
+ class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
5983
+ include Google::Apis::Core::Hashable
5984
+
5985
+ # Operation create time.
5986
+ # Corresponds to the JSON property `createTime`
5987
+ # @return [String]
5988
+ attr_accessor :create_time
5989
+
5990
+ # Count of entries that encountered errors while processing.
5991
+ # Corresponds to the JSON property `failureCount`
5992
+ # @return [Fixnum]
5993
+ attr_accessor :failure_count
5994
+
5995
+ # Count of entries that were processed successfully.
5996
+ # Corresponds to the JSON property `successCount`
5997
+ # @return [Fixnum]
5998
+ attr_accessor :success_count
5999
+
6000
+ # Total count of entries that were processed.
6001
+ # Corresponds to the JSON property `totalCount`
6002
+ # @return [Fixnum]
6003
+ attr_accessor :total_count
6004
+
6005
+ # Operation last update time. If the operation is done, this is also the finish
6006
+ # time.
6007
+ # Corresponds to the JSON property `updateTime`
6008
+ # @return [String]
6009
+ attr_accessor :update_time
6010
+
6011
+ def initialize(**args)
6012
+ update!(**args)
6013
+ end
6014
+
6015
+ # Update properties of this object
6016
+ def update!(**args)
6017
+ @create_time = args[:create_time] if args.key?(:create_time)
6018
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
6019
+ @success_count = args[:success_count] if args.key?(:success_count)
6020
+ @total_count = args[:total_count] if args.key?(:total_count)
6021
+ @update_time = args[:update_time] if args.key?(:update_time)
6022
+ end
6023
+ end
6024
+
6025
+ # Request message for Import methods.
6026
+ class GoogleCloudDiscoveryengineV1ImportDocumentsRequest
6027
+ include Google::Apis::Core::Hashable
6028
+
6029
+ # AlloyDB source import data from.
6030
+ # Corresponds to the JSON property `alloyDbSource`
6031
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AlloyDbSource]
6032
+ attr_accessor :alloy_db_source
6033
+
6034
+ # Whether to automatically generate IDs for the documents if absent. If set to `
6035
+ # true`, Document.ids are automatically generated based on the hash of the
6036
+ # payload, where IDs may not be consistent during multiple imports. In which
6037
+ # case ReconciliationMode.FULL is highly recommended to avoid duplicate contents.
6038
+ # If unset or set to `false`, Document.ids have to be specified using id_field,
6039
+ # otherwise, documents without IDs fail to be imported. Supported data sources: *
6040
+ # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
6041
+ # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
6042
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
6043
+ # SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
6044
+ # Corresponds to the JSON property `autoGenerateIds`
6045
+ # @return [Boolean]
6046
+ attr_accessor :auto_generate_ids
6047
+ alias_method :auto_generate_ids?, :auto_generate_ids
6048
+
6049
+ # BigQuery source import data from.
6050
+ # Corresponds to the JSON property `bigquerySource`
6051
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigQuerySource]
6052
+ attr_accessor :bigquery_source
6053
+
6054
+ # The Cloud Bigtable source for importing data.
6055
+ # Corresponds to the JSON property `bigtableSource`
6056
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigtableSource]
6057
+ attr_accessor :bigtable_source
6058
+
6059
+ # Cloud SQL source import data from.
6060
+ # Corresponds to the JSON property `cloudSqlSource`
6061
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CloudSqlSource]
6062
+ attr_accessor :cloud_sql_source
6063
+
6064
+ # Configuration of destination for Import related errors.
6065
+ # Corresponds to the JSON property `errorConfig`
6066
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
6067
+ attr_accessor :error_config
6068
+
6069
+ # Cloud FhirStore source import data from.
6070
+ # Corresponds to the JSON property `fhirStoreSource`
6071
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FhirStoreSource]
6072
+ attr_accessor :fhir_store_source
6073
+
6074
+ # Firestore source import data from.
6075
+ # Corresponds to the JSON property `firestoreSource`
6076
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FirestoreSource]
6077
+ attr_accessor :firestore_source
6078
+
6079
+ # Cloud Storage location for input content.
6080
+ # Corresponds to the JSON property `gcsSource`
6081
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
5474
6082
  attr_accessor :gcs_source
5475
6083
 
5476
6084
  # The field indicates the ID field or column to be used as unique IDs of the
@@ -9091,6 +9699,27 @@ module Google
9091
9699
  end
9092
9700
  end
9093
9701
 
9702
+ # Metadata for single-regional CMEKs.
9703
+ class GoogleCloudDiscoveryengineV1SingleRegionKey
9704
+ include Google::Apis::Core::Hashable
9705
+
9706
+ # Required. Single-regional kms key resource name which will be used to encrypt
9707
+ # resources `projects/`project`/locations/`location`/keyRings/`keyRing`/
9708
+ # cryptoKeys/`keyId``.
9709
+ # Corresponds to the JSON property `kmsKey`
9710
+ # @return [String]
9711
+ attr_accessor :kms_key
9712
+
9713
+ def initialize(**args)
9714
+ update!(**args)
9715
+ end
9716
+
9717
+ # Update properties of this object
9718
+ def update!(**args)
9719
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
9720
+ end
9721
+ end
9722
+
9094
9723
  # SiteSearchEngine captures DataStore level site search persisting
9095
9724
  # configurations. It is a singleton value per data store.
9096
9725
  class GoogleCloudDiscoveryengineV1SiteSearchEngine
@@ -10000,6 +10629,38 @@ module Google
10000
10629
  end
10001
10630
  end
10002
10631
 
10632
+ # Informations to support actions on the connector.
10633
+ class GoogleCloudDiscoveryengineV1alphaActionConfig
10634
+ include Google::Apis::Core::Hashable
10635
+
10636
+ # Required. Params needed to support actions in the format of (Key, Value) pairs.
10637
+ # Required parameters for sources that support OAUTH, i.e. `gmail`, `
10638
+ # google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `
10639
+ # client_id` * Value: type STRING. The client id for the service provider to
10640
+ # identify your application. * Key: `client_secret` * Value:type STRING. The
10641
+ # client secret generated by the application's authorization server.
10642
+ # Corresponds to the JSON property `actionParams`
10643
+ # @return [Hash<String,Object>]
10644
+ attr_accessor :action_params
10645
+
10646
+ # Output only. The connector contains the necessary parameters and is configured
10647
+ # to support actions.
10648
+ # Corresponds to the JSON property `isActionConfigured`
10649
+ # @return [Boolean]
10650
+ attr_accessor :is_action_configured
10651
+ alias_method :is_action_configured?, :is_action_configured
10652
+
10653
+ def initialize(**args)
10654
+ update!(**args)
10655
+ end
10656
+
10657
+ # Update properties of this object
10658
+ def update!(**args)
10659
+ @action_params = args[:action_params] if args.key?(:action_params)
10660
+ @is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
10661
+ end
10662
+ end
10663
+
10003
10664
  # Configuration data for advance site search.
10004
10665
  class GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig
10005
10666
  include Google::Apis::Core::Hashable
@@ -10776,23 +11437,74 @@ module Google
10776
11437
  # @return [String]
10777
11438
  attr_accessor :name
10778
11439
 
10779
- # Output only. State of the CmekConfig.
10780
- # Corresponds to the JSON property `state`
10781
- # @return [String]
10782
- attr_accessor :state
10783
-
11440
+ # Optional. Single-regional CMEKs that are required for some VAIS features.
11441
+ # Corresponds to the JSON property `singleRegionKeys`
11442
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
11443
+ attr_accessor :single_region_keys
11444
+
11445
+ # Output only. State of the CmekConfig.
11446
+ # Corresponds to the JSON property `state`
11447
+ # @return [String]
11448
+ attr_accessor :state
11449
+
11450
+ def initialize(**args)
11451
+ update!(**args)
11452
+ end
11453
+
11454
+ # Update properties of this object
11455
+ def update!(**args)
11456
+ @is_default = args[:is_default] if args.key?(:is_default)
11457
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
11458
+ @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
11459
+ @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
11460
+ @name = args[:name] if args.key?(:name)
11461
+ @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
11462
+ @state = args[:state] if args.key?(:state)
11463
+ end
11464
+ end
11465
+
11466
+ # Collection is a container for configuring resources and access to a set of
11467
+ # DataStores.
11468
+ class GoogleCloudDiscoveryengineV1alphaCollection
11469
+ include Google::Apis::Core::Hashable
11470
+
11471
+ # Output only. Timestamp the Collection was created at.
11472
+ # Corresponds to the JSON property `createTime`
11473
+ # @return [String]
11474
+ attr_accessor :create_time
11475
+
11476
+ # Manages the connection to external data sources for all data stores grouped
11477
+ # under a Collection. It's a singleton resource of Collection. The
11478
+ # initialization is only supported through SetUpDataConnector method, which will
11479
+ # create a new Collection and initialize its DataConnector. //
11480
+ # Corresponds to the JSON property `dataConnector`
11481
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataConnector]
11482
+ attr_accessor :data_connector
11483
+
11484
+ # Required. The Collection display name. This field must be a UTF-8 encoded
11485
+ # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
11486
+ # error is returned.
11487
+ # Corresponds to the JSON property `displayName`
11488
+ # @return [String]
11489
+ attr_accessor :display_name
11490
+
11491
+ # Immutable. The full resource name of the Collection. Format: `projects/`
11492
+ # project`/locations/`location`/collections/`collection_id``. This field must be
11493
+ # a UTF-8 encoded string with a length limit of 1024 characters.
11494
+ # Corresponds to the JSON property `name`
11495
+ # @return [String]
11496
+ attr_accessor :name
11497
+
10784
11498
  def initialize(**args)
10785
11499
  update!(**args)
10786
11500
  end
10787
11501
 
10788
11502
  # Update properties of this object
10789
11503
  def update!(**args)
10790
- @is_default = args[:is_default] if args.key?(:is_default)
10791
- @kms_key = args[:kms_key] if args.key?(:kms_key)
10792
- @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
10793
- @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
11504
+ @create_time = args[:create_time] if args.key?(:create_time)
11505
+ @data_connector = args[:data_connector] if args.key?(:data_connector)
11506
+ @display_name = args[:display_name] if args.key?(:display_name)
10794
11507
  @name = args[:name] if args.key?(:name)
10795
- @state = args[:state] if args.key?(:state)
10796
11508
  end
10797
11509
  end
10798
11510
 
@@ -10883,6 +11595,158 @@ module Google
10883
11595
  end
10884
11596
  end
10885
11597
 
11598
+ # A data sync run of DataConnector. After DataConnector is successfully
11599
+ # initialized, data syncs are scheduled at DataConnector.refresh_interval. A
11600
+ # ConnectorRun represents a data sync either in the past or onging that the
11601
+ # moment. //
11602
+ class GoogleCloudDiscoveryengineV1alphaConnectorRun
11603
+ include Google::Apis::Core::Hashable
11604
+
11605
+ # Output only. The time when the connector run ended.
11606
+ # Corresponds to the JSON property `endTime`
11607
+ # @return [String]
11608
+ attr_accessor :end_time
11609
+
11610
+ # Output only. The details of the entities synced at the ConnectorRun. Each
11611
+ # ConnectorRun consists of syncing one or more entities.
11612
+ # Corresponds to the JSON property `entityRuns`
11613
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun>]
11614
+ attr_accessor :entity_runs
11615
+
11616
+ # Contains info about errors incurred during the sync. Only exist if running
11617
+ # into an error state. Contains error code and error message. Use with the `
11618
+ # state` field.
11619
+ # Corresponds to the JSON property `errors`
11620
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
11621
+ attr_accessor :errors
11622
+
11623
+ # Output only. The time when the connector run was most recently paused.
11624
+ # Corresponds to the JSON property `latestPauseTime`
11625
+ # @return [String]
11626
+ attr_accessor :latest_pause_time
11627
+
11628
+ # Output only. The full resource name of the Connector Run. Format: `projects/*/
11629
+ # locations/*/collections/*/dataConnector/connectorRuns/*`. The `
11630
+ # connector_run_id` is system-generated.
11631
+ # Corresponds to the JSON property `name`
11632
+ # @return [String]
11633
+ attr_accessor :name
11634
+
11635
+ # Output only. The time when the connector run started.
11636
+ # Corresponds to the JSON property `startTime`
11637
+ # @return [String]
11638
+ attr_accessor :start_time
11639
+
11640
+ # Output only. The state of the sync run.
11641
+ # Corresponds to the JSON property `state`
11642
+ # @return [String]
11643
+ attr_accessor :state
11644
+
11645
+ # Timestamp at which the connector run sync state was last updated.
11646
+ # Corresponds to the JSON property `stateUpdateTime`
11647
+ # @return [String]
11648
+ attr_accessor :state_update_time
11649
+
11650
+ # Output only. The trigger for this ConnectorRun.
11651
+ # Corresponds to the JSON property `trigger`
11652
+ # @return [String]
11653
+ attr_accessor :trigger
11654
+
11655
+ def initialize(**args)
11656
+ update!(**args)
11657
+ end
11658
+
11659
+ # Update properties of this object
11660
+ def update!(**args)
11661
+ @end_time = args[:end_time] if args.key?(:end_time)
11662
+ @entity_runs = args[:entity_runs] if args.key?(:entity_runs)
11663
+ @errors = args[:errors] if args.key?(:errors)
11664
+ @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
11665
+ @name = args[:name] if args.key?(:name)
11666
+ @start_time = args[:start_time] if args.key?(:start_time)
11667
+ @state = args[:state] if args.key?(:state)
11668
+ @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
11669
+ @trigger = args[:trigger] if args.key?(:trigger)
11670
+ end
11671
+ end
11672
+
11673
+ # Represents an entity that was synced in this ConnectorRun.
11674
+ class GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun
11675
+ include Google::Apis::Core::Hashable
11676
+
11677
+ # The name of the source entity.
11678
+ # Corresponds to the JSON property `entityName`
11679
+ # @return [String]
11680
+ attr_accessor :entity_name
11681
+
11682
+ # The total number of documents failed at sync at any stage (extraction,
11683
+ # indexing, etc).
11684
+ # Corresponds to the JSON property `errorRecordCount`
11685
+ # @return [Fixnum]
11686
+ attr_accessor :error_record_count
11687
+
11688
+ # The errors from the entity's sync run. Only exist if running into an error
11689
+ # state. Contains error code and error message.
11690
+ # Corresponds to the JSON property `errors`
11691
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
11692
+ attr_accessor :errors
11693
+
11694
+ # The number of documents extracted from connector source, ready to be ingested
11695
+ # to UCS.
11696
+ # Corresponds to the JSON property `extractedRecordCount`
11697
+ # @return [Fixnum]
11698
+ attr_accessor :extracted_record_count
11699
+
11700
+ # The number of documents indexed.
11701
+ # Corresponds to the JSON property `indexedRecordCount`
11702
+ # @return [Fixnum]
11703
+ attr_accessor :indexed_record_count
11704
+
11705
+ # The number of requests sent to 3p API.
11706
+ # Corresponds to the JSON property `sourceApiRequestCount`
11707
+ # @return [Fixnum]
11708
+ attr_accessor :source_api_request_count
11709
+
11710
+ # The state of the entity's sync run.
11711
+ # Corresponds to the JSON property `state`
11712
+ # @return [String]
11713
+ attr_accessor :state
11714
+
11715
+ # Timestamp at which the entity sync state was last updated.
11716
+ # Corresponds to the JSON property `stateUpdateTime`
11717
+ # @return [String]
11718
+ attr_accessor :state_update_time
11719
+
11720
+ # The timestamp for either extracted_documents_count, indexed_documents_count
11721
+ # and error_documents_count was last updated.
11722
+ # Corresponds to the JSON property `statsUpdateTime`
11723
+ # @return [String]
11724
+ attr_accessor :stats_update_time
11725
+
11726
+ # Sync type of this run.
11727
+ # Corresponds to the JSON property `syncType`
11728
+ # @return [String]
11729
+ attr_accessor :sync_type
11730
+
11731
+ def initialize(**args)
11732
+ update!(**args)
11733
+ end
11734
+
11735
+ # Update properties of this object
11736
+ def update!(**args)
11737
+ @entity_name = args[:entity_name] if args.key?(:entity_name)
11738
+ @error_record_count = args[:error_record_count] if args.key?(:error_record_count)
11739
+ @errors = args[:errors] if args.key?(:errors)
11740
+ @extracted_record_count = args[:extracted_record_count] if args.key?(:extracted_record_count)
11741
+ @indexed_record_count = args[:indexed_record_count] if args.key?(:indexed_record_count)
11742
+ @source_api_request_count = args[:source_api_request_count] if args.key?(:source_api_request_count)
11743
+ @state = args[:state] if args.key?(:state)
11744
+ @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
11745
+ @stats_update_time = args[:stats_update_time] if args.key?(:stats_update_time)
11746
+ @sync_type = args[:sync_type] if args.key?(:sync_type)
11747
+ end
11748
+ end
11749
+
10886
11750
  # Defines a conditioned behavior to employ during serving. Must be attached to a
10887
11751
  # ServingConfig to be considered at serving time. Permitted actions dependent on
10888
11752
  # `SolutionType`.
@@ -11307,53 +12171,182 @@ module Google
11307
12171
  end
11308
12172
  end
11309
12173
 
11310
- # Metadata that describes a custom tuned model.
11311
- class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
12174
+ # Manages the connection to external data sources for all data stores grouped
12175
+ # under a Collection. It's a singleton resource of Collection. The
12176
+ # initialization is only supported through SetUpDataConnector method, which will
12177
+ # create a new Collection and initialize its DataConnector. //
12178
+ class GoogleCloudDiscoveryengineV1alphaDataConnector
11312
12179
  include Google::Apis::Core::Hashable
11313
12180
 
11314
- # Deprecated: Timestamp the Model was created at.
12181
+ # Informations to support actions on the connector.
12182
+ # Corresponds to the JSON property `actionConfig`
12183
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaActionConfig]
12184
+ attr_accessor :action_config
12185
+
12186
+ # Indicates whether the connector is disabled for auto run. It can be used to
12187
+ # pause periodical and real time sync.
12188
+ # Corresponds to the JSON property `autoRunDisabled`
12189
+ # @return [Boolean]
12190
+ attr_accessor :auto_run_disabled
12191
+ alias_method :auto_run_disabled?, :auto_run_disabled
12192
+
12193
+ # Output only. User actions that must be completed before the connector can
12194
+ # start syncing data.
12195
+ # Corresponds to the JSON property `blockingReasons`
12196
+ # @return [Array<String>]
12197
+ attr_accessor :blocking_reasons
12198
+
12199
+ # Output only. Timestamp the DataConnector was created at.
11315
12200
  # Corresponds to the JSON property `createTime`
11316
12201
  # @return [String]
11317
12202
  attr_accessor :create_time
11318
12203
 
11319
- # The display name of the model.
11320
- # Corresponds to the JSON property `displayName`
12204
+ # Required. The name of the data source. Supported values: `salesforce`, `jira`,
12205
+ # `confluence`, `bigquery`.
12206
+ # Corresponds to the JSON property `dataSource`
11321
12207
  # @return [String]
11322
- attr_accessor :display_name
12208
+ attr_accessor :data_source
11323
12209
 
11324
- # Currently this is only populated if the model state is `
11325
- # INPUT_VALIDATION_FAILED`.
11326
- # Corresponds to the JSON property `errorMessage`
12210
+ # Optional. Any target destinations used to connect to third-party services.
12211
+ # Corresponds to the JSON property `destinationConfigs`
12212
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDestinationConfig>]
12213
+ attr_accessor :destination_configs
12214
+
12215
+ # List of entities from the connected data source to ingest.
12216
+ # Corresponds to the JSON property `entities`
12217
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>]
12218
+ attr_accessor :entities
12219
+
12220
+ # Output only. The errors from initialization or from the latest connector run.
12221
+ # Corresponds to the JSON property `errors`
12222
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
12223
+ attr_accessor :errors
12224
+
12225
+ # The refresh interval to sync the Access Control List information for the
12226
+ # documents ingested by this connector. If not set, the access control list will
12227
+ # be refreshed at the default interval of 30 minutes. The identity refresh
12228
+ # interval can be at least 30 minutes and at most 7 days.
12229
+ # Corresponds to the JSON property `identityRefreshInterval`
11327
12230
  # @return [String]
11328
- attr_accessor :error_message
12231
+ attr_accessor :identity_refresh_interval
11329
12232
 
11330
- # The metrics of the trained model.
11331
- # Corresponds to the JSON property `metrics`
11332
- # @return [Hash<String,Float>]
11333
- attr_accessor :metrics
12233
+ # The configuration for the identity data synchronization runs.
12234
+ # Corresponds to the JSON property `identityScheduleConfig`
12235
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig]
12236
+ attr_accessor :identity_schedule_config
11334
12237
 
11335
- # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
11336
- # Corresponds to the JSON property `modelState`
12238
+ # Input only. The KMS key to be used to protect the DataStores managed by this
12239
+ # connector. Must be set for requests that need to comply with CMEK Org Policy
12240
+ # protections. If this field is set and processed successfully, the DataStores
12241
+ # created by this connector will be protected by the KMS key.
12242
+ # Corresponds to the JSON property `kmsKeyName`
11337
12243
  # @return [String]
11338
- attr_accessor :model_state
12244
+ attr_accessor :kms_key_name
11339
12245
 
11340
- # The version of the model.
11341
- # Corresponds to the JSON property `modelVersion`
11342
- # @return [Fixnum]
11343
- attr_accessor :model_version
12246
+ # Output only. For periodic connectors only, the last time a data sync was
12247
+ # completed.
12248
+ # Corresponds to the JSON property `lastSyncTime`
12249
+ # @return [String]
12250
+ attr_accessor :last_sync_time
11344
12251
 
11345
- # Required. The fully qualified resource name of the model. Format: `projects/`
11346
- # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
11347
- # customTuningModels/`custom_tuning_model``. Model must be an alpha-numerical
11348
- # string with limit of 40 characters.
12252
+ # Output only. The most recent timestamp when this DataConnector was paused,
12253
+ # affecting all functionalities such as data synchronization. Pausing a
12254
+ # connector has the following effects: - All functionalities, including data
12255
+ # synchronization, are halted. - Any ongoing data synchronization job will be
12256
+ # canceled. - No future data synchronization runs will be scheduled nor can be
12257
+ # triggered.
12258
+ # Corresponds to the JSON property `latestPauseTime`
12259
+ # @return [String]
12260
+ attr_accessor :latest_pause_time
12261
+
12262
+ # Output only. The full resource name of the Data Connector. Format: `projects/*/
12263
+ # locations/*/collections/*/dataConnector`.
11349
12264
  # Corresponds to the JSON property `name`
11350
12265
  # @return [String]
11351
12266
  attr_accessor :name
11352
12267
 
11353
- # Timestamp the model training was initiated.
11354
- # Corresponds to the JSON property `trainingStartTime`
12268
+ # Represents civil time (or occasionally physical time). This type can represent
12269
+ # a civil time in one of a few possible ways: * When utc_offset is set and
12270
+ # time_zone is unset: a civil time on a calendar day with a particular offset
12271
+ # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a
12272
+ # calendar day in a particular time zone. * When neither time_zone nor
12273
+ # utc_offset is set: a civil time on a calendar day in local time. The date is
12274
+ # relative to the Proleptic Gregorian Calendar. If year, month, or day are 0,
12275
+ # the DateTime is considered not to have a specific year, month, or day
12276
+ # respectively. This type may also be used to represent a physical time if all
12277
+ # the date and time fields are set and either case of the `time_offset` oneof is
12278
+ # set. Consider using `Timestamp` message for physical time instead. If your use
12279
+ # case also would like to store the user's timezone, that can be done in another
12280
+ # field. This type is more flexible than some applications may want. Make sure
12281
+ # to document and validate your application's limitations.
12282
+ # Corresponds to the JSON property `nextSyncTime`
12283
+ # @return [Google::Apis::DiscoveryengineV1::GoogleTypeDateTime]
12284
+ attr_accessor :next_sync_time
12285
+
12286
+ # Required. Params needed to access the source in the format of (Key, Value)
12287
+ # pairs. Required parameters for all data sources: * Key: `instance_uri` * Value:
12288
+ # type STRING. The uri to access the data source. Required parameters for
12289
+ # sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value:
12290
+ # type STRING. The client id for the third party service provider to identify
12291
+ # your application. * Key: `client_secret` * Value:type STRING. The client
12292
+ # secret generated by the third party authorization server. * Key: `access_token`
12293
+ # * Value: type STRING. OAuth token for UCS to access to the protected resource.
12294
+ # * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to
12295
+ # obtain a new access token without user interaction. Required parameters for
12296
+ # sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `
12297
+ # user_account` * Value: type STRING. The username or email with the source. *
12298
+ # Key: `api_token` * Value: type STRING. The API token generated for the source
12299
+ # account, that is used for authenticating anywhere where you would have used a
12300
+ # password. Example: ```json ` "instance_uri": "https://xxx.atlassian.net", "
12301
+ # user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" ` ``` Optional
12302
+ # parameter to specify the authorization type to use for multiple authorization
12303
+ # types support: * Key: `auth_type` * Value: type STRING. The authorization type
12304
+ # for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `
12305
+ # OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `
12306
+ # OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
12307
+ # Corresponds to the JSON property `params`
12308
+ # @return [Hash<String,Object>]
12309
+ attr_accessor :params
12310
+
12311
+ # Output only. The tenant project ID associated with private connectivity
12312
+ # connectors. This project must be allowlisted by in order for the connector to
12313
+ # function.
12314
+ # Corresponds to the JSON property `privateConnectivityProjectId`
11355
12315
  # @return [String]
11356
- attr_accessor :training_start_time
12316
+ attr_accessor :private_connectivity_project_id
12317
+
12318
+ # Required. The refresh interval for data sync. If duration is set to 0, the
12319
+ # data will be synced in real time. The streaming feature is not supported yet.
12320
+ # The minimum is 30 minutes and maximum is 7 days.
12321
+ # Corresponds to the JSON property `refreshInterval`
12322
+ # @return [String]
12323
+ attr_accessor :refresh_interval
12324
+
12325
+ # Output only. State of the connector.
12326
+ # Corresponds to the JSON property `state`
12327
+ # @return [String]
12328
+ attr_accessor :state
12329
+
12330
+ # Output only. The static IP addresses used by this connector.
12331
+ # Corresponds to the JSON property `staticIpAddresses`
12332
+ # @return [Array<String>]
12333
+ attr_accessor :static_ip_addresses
12334
+
12335
+ # Optional. Whether customer has enabled static IP addresses for this connector.
12336
+ # Corresponds to the JSON property `staticIpEnabled`
12337
+ # @return [Boolean]
12338
+ attr_accessor :static_ip_enabled
12339
+ alias_method :static_ip_enabled?, :static_ip_enabled
12340
+
12341
+ # The data synchronization mode supported by the data connector.
12342
+ # Corresponds to the JSON property `syncMode`
12343
+ # @return [String]
12344
+ attr_accessor :sync_mode
12345
+
12346
+ # Output only. Timestamp the DataConnector was last updated.
12347
+ # Corresponds to the JSON property `updateTime`
12348
+ # @return [String]
12349
+ attr_accessor :update_time
11357
12350
 
11358
12351
  def initialize(**args)
11359
12352
  update!(**args)
@@ -11361,14 +12354,79 @@ module Google
11361
12354
 
11362
12355
  # Update properties of this object
11363
12356
  def update!(**args)
12357
+ @action_config = args[:action_config] if args.key?(:action_config)
12358
+ @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
12359
+ @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
11364
12360
  @create_time = args[:create_time] if args.key?(:create_time)
11365
- @display_name = args[:display_name] if args.key?(:display_name)
11366
- @error_message = args[:error_message] if args.key?(:error_message)
11367
- @metrics = args[:metrics] if args.key?(:metrics)
11368
- @model_state = args[:model_state] if args.key?(:model_state)
11369
- @model_version = args[:model_version] if args.key?(:model_version)
12361
+ @data_source = args[:data_source] if args.key?(:data_source)
12362
+ @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
12363
+ @entities = args[:entities] if args.key?(:entities)
12364
+ @errors = args[:errors] if args.key?(:errors)
12365
+ @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
12366
+ @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
12367
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
12368
+ @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time)
12369
+ @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
11370
12370
  @name = args[:name] if args.key?(:name)
11371
- @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
12371
+ @next_sync_time = args[:next_sync_time] if args.key?(:next_sync_time)
12372
+ @params = args[:params] if args.key?(:params)
12373
+ @private_connectivity_project_id = args[:private_connectivity_project_id] if args.key?(:private_connectivity_project_id)
12374
+ @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
12375
+ @state = args[:state] if args.key?(:state)
12376
+ @static_ip_addresses = args[:static_ip_addresses] if args.key?(:static_ip_addresses)
12377
+ @static_ip_enabled = args[:static_ip_enabled] if args.key?(:static_ip_enabled)
12378
+ @sync_mode = args[:sync_mode] if args.key?(:sync_mode)
12379
+ @update_time = args[:update_time] if args.key?(:update_time)
12380
+ end
12381
+ end
12382
+
12383
+ # Represents an entity in the data source. For example, the `Account` object in
12384
+ # Salesforce.
12385
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity
12386
+ include Google::Apis::Core::Hashable
12387
+
12388
+ # Output only. The full resource name of the associated data store for the
12389
+ # source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`.
12390
+ # When the connector is initialized by the DataConnectorService.
12391
+ # SetUpDataConnector method, a DataStore is automatically created for each
12392
+ # source entity.
12393
+ # Corresponds to the JSON property `dataStore`
12394
+ # @return [String]
12395
+ attr_accessor :data_store
12396
+
12397
+ # The name of the entity. Supported values by data source: * Salesforce: `Lead`,
12398
+ # `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `
12399
+ # Issue` * Confluence: `Content`, `Space`
12400
+ # Corresponds to the JSON property `entityName`
12401
+ # @return [String]
12402
+ attr_accessor :entity_name
12403
+
12404
+ # Attributes for indexing. Key: Field name. Value: The key property to map a
12405
+ # field to, such as `title`, and `description`. Supported key properties: * `
12406
+ # title`: The title for data record. This would be displayed on search results. *
12407
+ # `description`: The description for data record. This would be displayed on
12408
+ # search results.
12409
+ # Corresponds to the JSON property `keyPropertyMappings`
12410
+ # @return [Hash<String,String>]
12411
+ attr_accessor :key_property_mappings
12412
+
12413
+ # The parameters for the entity to facilitate data ingestion. E.g. for BQ
12414
+ # connectors: * Key: `document_id_column` * Value: type STRING. The value of the
12415
+ # column id.
12416
+ # Corresponds to the JSON property `params`
12417
+ # @return [Hash<String,Object>]
12418
+ attr_accessor :params
12419
+
12420
+ def initialize(**args)
12421
+ update!(**args)
12422
+ end
12423
+
12424
+ # Update properties of this object
12425
+ def update!(**args)
12426
+ @data_store = args[:data_store] if args.key?(:data_store)
12427
+ @entity_name = args[:entity_name] if args.key?(:entity_name)
12428
+ @key_property_mappings = args[:key_property_mappings] if args.key?(:key_property_mappings)
12429
+ @params = args[:params] if args.key?(:params)
11372
12430
  end
11373
12431
  end
11374
12432
 
@@ -11442,6 +12500,12 @@ module Google
11442
12500
  # @return [String]
11443
12501
  attr_accessor :industry_vertical
11444
12502
 
12503
+ # Optional. If set, this DataStore is an Infobot FAQ DataStore.
12504
+ # Corresponds to the JSON property `isInfobotFaqDataStore`
12505
+ # @return [Boolean]
12506
+ attr_accessor :is_infobot_faq_data_store
12507
+ alias_method :is_infobot_faq_data_store?, :is_infobot_faq_data_store
12508
+
11445
12509
  # Input only. The KMS key to be used to protect this DataStore at creation time.
11446
12510
  # Must be set for requests that need to comply with CMEK Org Policy protections.
11447
12511
  # If this field is set and processed successfully, the DataStore will be
@@ -11508,6 +12572,7 @@ module Google
11508
12572
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
11509
12573
  @idp_config = args[:idp_config] if args.key?(:idp_config)
11510
12574
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
12575
+ @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
11511
12576
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
11512
12577
  @language_info = args[:language_info] if args.key?(:language_info)
11513
12578
  @name = args[:name] if args.key?(:name)
@@ -11615,6 +12680,34 @@ module Google
11615
12680
  end
11616
12681
  end
11617
12682
 
12683
+ # Metadata related to the progress of the CollectionService.UpdateCollection
12684
+ # operation. This will be returned by the google.longrunning.Operation.metadata
12685
+ # field.
12686
+ class GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata
12687
+ include Google::Apis::Core::Hashable
12688
+
12689
+ # Operation create time.
12690
+ # Corresponds to the JSON property `createTime`
12691
+ # @return [String]
12692
+ attr_accessor :create_time
12693
+
12694
+ # Operation last update time. If the operation is done, this is also the finish
12695
+ # time.
12696
+ # Corresponds to the JSON property `updateTime`
12697
+ # @return [String]
12698
+ attr_accessor :update_time
12699
+
12700
+ def initialize(**args)
12701
+ update!(**args)
12702
+ end
12703
+
12704
+ # Update properties of this object
12705
+ def update!(**args)
12706
+ @create_time = args[:create_time] if args.key?(:create_time)
12707
+ @update_time = args[:update_time] if args.key?(:update_time)
12708
+ end
12709
+ end
12710
+
11618
12711
  # Metadata related to the progress of the DataStoreService.DeleteDataStore
11619
12712
  # operation. This will be returned by the google.longrunning.Operation.metadata
11620
12713
  # field.
@@ -11751,16 +12844,72 @@ module Google
11751
12844
  class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
11752
12845
  include Google::Apis::Core::Hashable
11753
12846
 
11754
- # Operation create time.
11755
- # Corresponds to the JSON property `createTime`
12847
+ # Operation create time.
12848
+ # Corresponds to the JSON property `createTime`
12849
+ # @return [String]
12850
+ attr_accessor :create_time
12851
+
12852
+ # Operation last update time. If the operation is done, this is also the finish
12853
+ # time.
12854
+ # Corresponds to the JSON property `updateTime`
12855
+ # @return [String]
12856
+ attr_accessor :update_time
12857
+
12858
+ def initialize(**args)
12859
+ update!(**args)
12860
+ end
12861
+
12862
+ # Update properties of this object
12863
+ def update!(**args)
12864
+ @create_time = args[:create_time] if args.key?(:create_time)
12865
+ @update_time = args[:update_time] if args.key?(:update_time)
12866
+ end
12867
+ end
12868
+
12869
+ # Defines target endpoints used to connect to third-party sources.
12870
+ class GoogleCloudDiscoveryengineV1alphaDestinationConfig
12871
+ include Google::Apis::Core::Hashable
12872
+
12873
+ # Optional. The destinations for the corresponding key.
12874
+ # Corresponds to the JSON property `destinations`
12875
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination>]
12876
+ attr_accessor :destinations
12877
+
12878
+ # Optional. Unique destination identifier that is supported by the connector.
12879
+ # Corresponds to the JSON property `key`
12880
+ # @return [String]
12881
+ attr_accessor :key
12882
+
12883
+ # Optional. Additional parameters for this destination config.
12884
+ # Corresponds to the JSON property `params`
12885
+ # @return [Hash<String,Object>]
12886
+ attr_accessor :params
12887
+
12888
+ def initialize(**args)
12889
+ update!(**args)
12890
+ end
12891
+
12892
+ # Update properties of this object
12893
+ def update!(**args)
12894
+ @destinations = args[:destinations] if args.key?(:destinations)
12895
+ @key = args[:key] if args.key?(:key)
12896
+ @params = args[:params] if args.key?(:params)
12897
+ end
12898
+ end
12899
+
12900
+ # Defines a target endpoint
12901
+ class GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination
12902
+ include Google::Apis::Core::Hashable
12903
+
12904
+ # Publicly routable host.
12905
+ # Corresponds to the JSON property `host`
11756
12906
  # @return [String]
11757
- attr_accessor :create_time
12907
+ attr_accessor :host
11758
12908
 
11759
- # Operation last update time. If the operation is done, this is also the finish
11760
- # time.
11761
- # Corresponds to the JSON property `updateTime`
11762
- # @return [String]
11763
- attr_accessor :update_time
12909
+ # Optional. Target port number accepted by the destination.
12910
+ # Corresponds to the JSON property `port`
12911
+ # @return [Fixnum]
12912
+ attr_accessor :port
11764
12913
 
11765
12914
  def initialize(**args)
11766
12915
  update!(**args)
@@ -11768,8 +12917,8 @@ module Google
11768
12917
 
11769
12918
  # Update properties of this object
11770
12919
  def update!(**args)
11771
- @create_time = args[:create_time] if args.key?(:create_time)
11772
- @update_time = args[:update_time] if args.key?(:update_time)
12920
+ @host = args[:host] if args.key?(:host)
12921
+ @port = args[:port] if args.key?(:port)
11773
12922
  end
11774
12923
  end
11775
12924
 
@@ -12084,8 +13233,8 @@ module Google
12084
13233
  attr_accessor :display_name
12085
13234
 
12086
13235
  # The industry vertical that the engine registers. The restriction of the Engine
12087
- # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
12088
- # Vertical on Engine has to match vertical of the DataStore linked to the engine.
13236
+ # industry vertical is based on DataStore: Vertical on Engine has to match
13237
+ # vertical of the DataStore linked to the engine.
12089
13238
  # Corresponds to the JSON property `industryVertical`
12090
13239
  # @return [String]
12091
13240
  attr_accessor :industry_vertical
@@ -12835,6 +13984,28 @@ module Google
12835
13984
  end
12836
13985
  end
12837
13986
 
13987
+ # The configuration for the identity data synchronization runs.
13988
+ class GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig
13989
+ include Google::Apis::Core::Hashable
13990
+
13991
+ # Optional. The refresh interval to sync the Access Control List information for
13992
+ # the documents ingested by this connector. If not set, the access control list
13993
+ # will be refreshed at the default interval of 30 minutes. The identity refresh
13994
+ # interval can be at least 30 minutes and at most 7 days.
13995
+ # Corresponds to the JSON property `refreshInterval`
13996
+ # @return [String]
13997
+ attr_accessor :refresh_interval
13998
+
13999
+ def initialize(**args)
14000
+ update!(**args)
14001
+ end
14002
+
14003
+ # Update properties of this object
14004
+ def update!(**args)
14005
+ @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
14006
+ end
14007
+ end
14008
+
12838
14009
  # Identity Provider Config.
12839
14010
  class GoogleCloudDiscoveryengineV1alphaIdpConfig
12840
14011
  include Google::Apis::Core::Hashable
@@ -13325,25 +14496,6 @@ module Google
13325
14496
  end
13326
14497
  end
13327
14498
 
13328
- # Response message for SearchTuningService.ListCustomModels method.
13329
- class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
13330
- include Google::Apis::Core::Hashable
13331
-
13332
- # List of custom tuning models.
13333
- # Corresponds to the JSON property `models`
13334
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
13335
- attr_accessor :models
13336
-
13337
- def initialize(**args)
13338
- update!(**args)
13339
- end
13340
-
13341
- # Update properties of this object
13342
- def update!(**args)
13343
- @models = args[:models] if args.key?(:models)
13344
- end
13345
- end
13346
-
13347
14499
  # Request for ListSessions method.
13348
14500
  class GoogleCloudDiscoveryengineV1alphaListSessionsRequest
13349
14501
  include Google::Apis::Core::Hashable
@@ -15523,6 +16675,19 @@ module Google
15523
16675
  end
15524
16676
  end
15525
16677
 
16678
+ # Metadata for DataConnectorService.SetUpDataConnector method.
16679
+ class GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata
16680
+ include Google::Apis::Core::Hashable
16681
+
16682
+ def initialize(**args)
16683
+ update!(**args)
16684
+ end
16685
+
16686
+ # Update properties of this object
16687
+ def update!(**args)
16688
+ end
16689
+ end
16690
+
15526
16691
  # Metadata related to the progress of the SiteSearchEngineService.
15527
16692
  # SetUriPatternDocumentData operation. This will be returned by the google.
15528
16693
  # longrunning.Operation.metadata field.
@@ -15564,6 +16729,27 @@ module Google
15564
16729
  end
15565
16730
  end
15566
16731
 
16732
+ # Metadata for single-regional CMEKs.
16733
+ class GoogleCloudDiscoveryengineV1alphaSingleRegionKey
16734
+ include Google::Apis::Core::Hashable
16735
+
16736
+ # Required. Single-regional kms key resource name which will be used to encrypt
16737
+ # resources `projects/`project`/locations/`location`/keyRings/`keyRing`/
16738
+ # cryptoKeys/`keyId``.
16739
+ # Corresponds to the JSON property `kmsKey`
16740
+ # @return [String]
16741
+ attr_accessor :kms_key
16742
+
16743
+ def initialize(**args)
16744
+ update!(**args)
16745
+ end
16746
+
16747
+ # Update properties of this object
16748
+ def update!(**args)
16749
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
16750
+ end
16751
+ end
16752
+
15567
16753
  # Verification information for target sites in advanced site search.
15568
16754
  class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
15569
16755
  include Google::Apis::Core::Hashable
@@ -15883,6 +17069,34 @@ module Google
15883
17069
  end
15884
17070
  end
15885
17071
 
17072
+ # Metadata related to the progress of the CollectionService.UpdateCollection
17073
+ # operation. This will be returned by the google.longrunning.Operation.metadata
17074
+ # field.
17075
+ class GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata
17076
+ include Google::Apis::Core::Hashable
17077
+
17078
+ # Operation create time.
17079
+ # Corresponds to the JSON property `createTime`
17080
+ # @return [String]
17081
+ attr_accessor :create_time
17082
+
17083
+ # Operation last update time. If the operation is done, this is also the finish
17084
+ # time.
17085
+ # Corresponds to the JSON property `updateTime`
17086
+ # @return [String]
17087
+ attr_accessor :update_time
17088
+
17089
+ def initialize(**args)
17090
+ update!(**args)
17091
+ end
17092
+
17093
+ # Update properties of this object
17094
+ def update!(**args)
17095
+ @create_time = args[:create_time] if args.key?(:create_time)
17096
+ @update_time = args[:update_time] if args.key?(:update_time)
17097
+ end
17098
+ end
17099
+
15886
17100
  # Metadata for UpdateSchema LRO.
15887
17101
  class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
15888
17102
  include Google::Apis::Core::Hashable
@@ -16133,6 +17347,11 @@ module Google
16133
17347
  # @return [String]
16134
17348
  attr_accessor :name
16135
17349
 
17350
+ # Optional. Single-regional CMEKs that are required for some VAIS features.
17351
+ # Corresponds to the JSON property `singleRegionKeys`
17352
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
17353
+ attr_accessor :single_region_keys
17354
+
16136
17355
  # Output only. State of the CmekConfig.
16137
17356
  # Corresponds to the JSON property `state`
16138
17357
  # @return [String]
@@ -16149,6 +17368,7 @@ module Google
16149
17368
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
16150
17369
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
16151
17370
  @name = args[:name] if args.key?(:name)
17371
+ @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
16152
17372
  @state = args[:state] if args.key?(:state)
16153
17373
  end
16154
17374
  end
@@ -16622,71 +17842,6 @@ module Google
16622
17842
  end
16623
17843
  end
16624
17844
 
16625
- # Metadata that describes a custom tuned model.
16626
- class GoogleCloudDiscoveryengineV1betaCustomTuningModel
16627
- include Google::Apis::Core::Hashable
16628
-
16629
- # Deprecated: Timestamp the Model was created at.
16630
- # Corresponds to the JSON property `createTime`
16631
- # @return [String]
16632
- attr_accessor :create_time
16633
-
16634
- # The display name of the model.
16635
- # Corresponds to the JSON property `displayName`
16636
- # @return [String]
16637
- attr_accessor :display_name
16638
-
16639
- # Currently this is only populated if the model state is `
16640
- # INPUT_VALIDATION_FAILED`.
16641
- # Corresponds to the JSON property `errorMessage`
16642
- # @return [String]
16643
- attr_accessor :error_message
16644
-
16645
- # The metrics of the trained model.
16646
- # Corresponds to the JSON property `metrics`
16647
- # @return [Hash<String,Float>]
16648
- attr_accessor :metrics
16649
-
16650
- # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
16651
- # Corresponds to the JSON property `modelState`
16652
- # @return [String]
16653
- attr_accessor :model_state
16654
-
16655
- # The version of the model.
16656
- # Corresponds to the JSON property `modelVersion`
16657
- # @return [Fixnum]
16658
- attr_accessor :model_version
16659
-
16660
- # Required. The fully qualified resource name of the model. Format: `projects/`
16661
- # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
16662
- # customTuningModels/`custom_tuning_model``. Model must be an alpha-numerical
16663
- # string with limit of 40 characters.
16664
- # Corresponds to the JSON property `name`
16665
- # @return [String]
16666
- attr_accessor :name
16667
-
16668
- # Timestamp the model training was initiated.
16669
- # Corresponds to the JSON property `trainingStartTime`
16670
- # @return [String]
16671
- attr_accessor :training_start_time
16672
-
16673
- def initialize(**args)
16674
- update!(**args)
16675
- end
16676
-
16677
- # Update properties of this object
16678
- def update!(**args)
16679
- @create_time = args[:create_time] if args.key?(:create_time)
16680
- @display_name = args[:display_name] if args.key?(:display_name)
16681
- @error_message = args[:error_message] if args.key?(:error_message)
16682
- @metrics = args[:metrics] if args.key?(:metrics)
16683
- @model_state = args[:model_state] if args.key?(:model_state)
16684
- @model_version = args[:model_version] if args.key?(:model_version)
16685
- @name = args[:name] if args.key?(:name)
16686
- @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
16687
- end
16688
- end
16689
-
16690
17845
  # DataStore captures global settings and configs at the DataStore level.
16691
17846
  class GoogleCloudDiscoveryengineV1betaDataStore
16692
17847
  include Google::Apis::Core::Hashable
@@ -16741,6 +17896,12 @@ module Google
16741
17896
  # @return [String]
16742
17897
  attr_accessor :industry_vertical
16743
17898
 
17899
+ # Optional. If set, this DataStore is an Infobot FAQ DataStore.
17900
+ # Corresponds to the JSON property `isInfobotFaqDataStore`
17901
+ # @return [Boolean]
17902
+ attr_accessor :is_infobot_faq_data_store
17903
+ alias_method :is_infobot_faq_data_store?, :is_infobot_faq_data_store
17904
+
16744
17905
  # Input only. The KMS key to be used to protect this DataStore at creation time.
16745
17906
  # Must be set for requests that need to comply with CMEK Org Policy protections.
16746
17907
  # If this field is set and processed successfully, the DataStore will be
@@ -16805,6 +17966,7 @@ module Google
16805
17966
  @display_name = args[:display_name] if args.key?(:display_name)
16806
17967
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
16807
17968
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
17969
+ @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
16808
17970
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
16809
17971
  @language_info = args[:language_info] if args.key?(:language_info)
16810
17972
  @name = args[:name] if args.key?(:name)
@@ -17333,8 +18495,8 @@ module Google
17333
18495
  attr_accessor :display_name
17334
18496
 
17335
18497
  # The industry vertical that the engine registers. The restriction of the Engine
17336
- # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
17337
- # Vertical on Engine has to match vertical of the DataStore linked to the engine.
18498
+ # industry vertical is based on DataStore: Vertical on Engine has to match
18499
+ # vertical of the DataStore linked to the engine.
17338
18500
  # Corresponds to the JSON property `industryVertical`
17339
18501
  # @return [String]
17340
18502
  attr_accessor :industry_vertical
@@ -18132,25 +19294,6 @@ module Google
18132
19294
  end
18133
19295
  end
18134
19296
 
18135
- # Response message for SearchTuningService.ListCustomModels method.
18136
- class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
18137
- include Google::Apis::Core::Hashable
18138
-
18139
- # List of custom tuning models.
18140
- # Corresponds to the JSON property `models`
18141
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCustomTuningModel>]
18142
- attr_accessor :models
18143
-
18144
- def initialize(**args)
18145
- update!(**args)
18146
- end
18147
-
18148
- # Update properties of this object
18149
- def update!(**args)
18150
- @models = args[:models] if args.key?(:models)
18151
- end
18152
- end
18153
-
18154
19297
  # Configuration for Natural Language Query Understanding.
18155
19298
  class GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig
18156
19299
  include Google::Apis::Core::Hashable
@@ -19774,6 +20917,27 @@ module Google
19774
20917
  end
19775
20918
  end
19776
20919
 
20920
+ # Metadata for single-regional CMEKs.
20921
+ class GoogleCloudDiscoveryengineV1betaSingleRegionKey
20922
+ include Google::Apis::Core::Hashable
20923
+
20924
+ # Required. Single-regional kms key resource name which will be used to encrypt
20925
+ # resources `projects/`project`/locations/`location`/keyRings/`keyRing`/
20926
+ # cryptoKeys/`keyId``.
20927
+ # Corresponds to the JSON property `kmsKey`
20928
+ # @return [String]
20929
+ attr_accessor :kms_key
20930
+
20931
+ def initialize(**args)
20932
+ update!(**args)
20933
+ end
20934
+
20935
+ # Update properties of this object
20936
+ def update!(**args)
20937
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
20938
+ end
20939
+ end
20940
+
19777
20941
  # Verification information for target sites in advanced site search.
19778
20942
  class GoogleCloudDiscoveryengineV1betaSiteVerificationInfo
19779
20943
  include Google::Apis::Core::Hashable
@@ -20597,6 +21761,121 @@ module Google
20597
21761
  @year = args[:year] if args.key?(:year)
20598
21762
  end
20599
21763
  end
21764
+
21765
+ # Represents civil time (or occasionally physical time). This type can represent
21766
+ # a civil time in one of a few possible ways: * When utc_offset is set and
21767
+ # time_zone is unset: a civil time on a calendar day with a particular offset
21768
+ # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a
21769
+ # calendar day in a particular time zone. * When neither time_zone nor
21770
+ # utc_offset is set: a civil time on a calendar day in local time. The date is
21771
+ # relative to the Proleptic Gregorian Calendar. If year, month, or day are 0,
21772
+ # the DateTime is considered not to have a specific year, month, or day
21773
+ # respectively. This type may also be used to represent a physical time if all
21774
+ # the date and time fields are set and either case of the `time_offset` oneof is
21775
+ # set. Consider using `Timestamp` message for physical time instead. If your use
21776
+ # case also would like to store the user's timezone, that can be done in another
21777
+ # field. This type is more flexible than some applications may want. Make sure
21778
+ # to document and validate your application's limitations.
21779
+ class GoogleTypeDateTime
21780
+ include Google::Apis::Core::Hashable
21781
+
21782
+ # Optional. Day of month. Must be from 1 to 31 and valid for the year and month,
21783
+ # or 0 if specifying a datetime without a day.
21784
+ # Corresponds to the JSON property `day`
21785
+ # @return [Fixnum]
21786
+ attr_accessor :day
21787
+
21788
+ # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to
21789
+ # 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios
21790
+ # like business closing time.
21791
+ # Corresponds to the JSON property `hours`
21792
+ # @return [Fixnum]
21793
+ attr_accessor :hours
21794
+
21795
+ # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
21796
+ # Corresponds to the JSON property `minutes`
21797
+ # @return [Fixnum]
21798
+ attr_accessor :minutes
21799
+
21800
+ # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime
21801
+ # without a month.
21802
+ # Corresponds to the JSON property `month`
21803
+ # @return [Fixnum]
21804
+ attr_accessor :month
21805
+
21806
+ # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999,
21807
+ # defaults to 0.
21808
+ # Corresponds to the JSON property `nanos`
21809
+ # @return [Fixnum]
21810
+ attr_accessor :nanos
21811
+
21812
+ # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
21813
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
21814
+ # Corresponds to the JSON property `seconds`
21815
+ # @return [Fixnum]
21816
+ attr_accessor :seconds
21817
+
21818
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
21819
+ # time-zones).
21820
+ # Corresponds to the JSON property `timeZone`
21821
+ # @return [Google::Apis::DiscoveryengineV1::GoogleTypeTimeZone]
21822
+ attr_accessor :time_zone
21823
+
21824
+ # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For
21825
+ # example, a UTC offset of -4:00 would be represented as ` seconds: -14400 `.
21826
+ # Corresponds to the JSON property `utcOffset`
21827
+ # @return [String]
21828
+ attr_accessor :utc_offset
21829
+
21830
+ # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime
21831
+ # without a year.
21832
+ # Corresponds to the JSON property `year`
21833
+ # @return [Fixnum]
21834
+ attr_accessor :year
21835
+
21836
+ def initialize(**args)
21837
+ update!(**args)
21838
+ end
21839
+
21840
+ # Update properties of this object
21841
+ def update!(**args)
21842
+ @day = args[:day] if args.key?(:day)
21843
+ @hours = args[:hours] if args.key?(:hours)
21844
+ @minutes = args[:minutes] if args.key?(:minutes)
21845
+ @month = args[:month] if args.key?(:month)
21846
+ @nanos = args[:nanos] if args.key?(:nanos)
21847
+ @seconds = args[:seconds] if args.key?(:seconds)
21848
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
21849
+ @utc_offset = args[:utc_offset] if args.key?(:utc_offset)
21850
+ @year = args[:year] if args.key?(:year)
21851
+ end
21852
+ end
21853
+
21854
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
21855
+ # time-zones).
21856
+ class GoogleTypeTimeZone
21857
+ include Google::Apis::Core::Hashable
21858
+
21859
+ # IANA Time Zone Database time zone. For example "America/New_York".
21860
+ # Corresponds to the JSON property `id`
21861
+ # @return [String]
21862
+ attr_accessor :id
21863
+
21864
+ # Optional. IANA Time Zone Database version number. For example "2019a".
21865
+ # Corresponds to the JSON property `version`
21866
+ # @return [String]
21867
+ attr_accessor :version
21868
+
21869
+ def initialize(**args)
21870
+ update!(**args)
21871
+ end
21872
+
21873
+ # Update properties of this object
21874
+ def update!(**args)
21875
+ @id = args[:id] if args.key?(:id)
21876
+ @version = args[:version] if args.key?(:version)
21877
+ end
21878
+ end
20600
21879
  end
20601
21880
  end
20602
21881
  end