google-apis-discoveryengine_v1beta 0.42.0 → 0.44.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -741,8 +741,8 @@ module Google
741
741
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
742
742
  include Google::Apis::Core::Hashable
743
743
 
744
- # Apply additional enhanced OCR processing to a list of document elements.
745
- # Supported values: * `table`: advanced table parsing model.
744
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
745
+ # elements processing, please switch to `layout_parsing_config`.
746
746
  # Corresponds to the JSON property `enhancedDocumentElements`
747
747
  # @return [Array<String>]
748
748
  attr_accessor :enhanced_document_elements
@@ -917,8 +917,8 @@ module Google
917
917
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
918
918
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
919
919
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
920
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
921
- # agent association after Engine is created.
920
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
921
+ # association after Engine is created.
922
922
  # Corresponds to the JSON property `dialogflowAgentToLink`
923
923
  # @return [String]
924
924
  attr_accessor :dialogflow_agent_to_link
@@ -1031,7 +1031,7 @@ module Google
1031
1031
  attr_accessor :search_add_ons
1032
1032
 
1033
1033
  # The search feature tier of this engine. Different tiers might have different
1034
- # pricing. To learn more, please check the pricing documentation. Defaults to
1034
+ # pricing. To learn more, check the pricing documentation. Defaults to
1035
1035
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
1036
1036
  # Corresponds to the JSON property `searchTier`
1037
1037
  # @return [String]
@@ -1507,6 +1507,11 @@ module Google
1507
1507
  # @return [String]
1508
1508
  attr_accessor :provided_uri_pattern
1509
1509
 
1510
+ # Output only. Root domain of the provided_uri_pattern.
1511
+ # Corresponds to the JSON property `rootDomainUri`
1512
+ # @return [String]
1513
+ attr_accessor :root_domain_uri
1514
+
1510
1515
  # Verification information for target sites in advanced site search.
1511
1516
  # Corresponds to the JSON property `siteVerificationInfo`
1512
1517
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SiteVerificationInfo]
@@ -1535,6 +1540,7 @@ module Google
1535
1540
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
1536
1541
  @name = args[:name] if args.key?(:name)
1537
1542
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
1543
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
1538
1544
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
1539
1545
  @type = args[:type] if args.key?(:type)
1540
1546
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -1691,8 +1697,8 @@ module Google
1691
1697
  # @return [String]
1692
1698
  attr_accessor :create_time
1693
1699
 
1694
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
1695
- # collection`/engines/`engine`/sessions/*/answers/*`
1700
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1701
+ # collections/`collection`/engines/`engine`/sessions/*/answers/*`
1696
1702
  # Corresponds to the JSON property `name`
1697
1703
  # @return [String]
1698
1704
  attr_accessor :name
@@ -2355,6 +2361,58 @@ module Google
2355
2361
  end
2356
2362
  end
2357
2363
 
2364
+ # Metadata that describes a custom tuned model.
2365
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
2366
+ include Google::Apis::Core::Hashable
2367
+
2368
+ # Timestamp the Model was created at.
2369
+ # Corresponds to the JSON property `createTime`
2370
+ # @return [String]
2371
+ attr_accessor :create_time
2372
+
2373
+ # The display name of the model.
2374
+ # Corresponds to the JSON property `displayName`
2375
+ # @return [String]
2376
+ attr_accessor :display_name
2377
+
2378
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
2379
+ # Corresponds to the JSON property `modelState`
2380
+ # @return [String]
2381
+ attr_accessor :model_state
2382
+
2383
+ #
2384
+ # Corresponds to the JSON property `modelVersion`
2385
+ # @return [Fixnum]
2386
+ attr_accessor :model_version
2387
+
2388
+ # Required. The fully qualified resource name of the model. Format: `projects/`
2389
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
2390
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
2391
+ # numerical string with limit of 40 characters.
2392
+ # Corresponds to the JSON property `name`
2393
+ # @return [String]
2394
+ attr_accessor :name
2395
+
2396
+ # Timestamp the model training was initiated.
2397
+ # Corresponds to the JSON property `trainingStartTime`
2398
+ # @return [String]
2399
+ attr_accessor :training_start_time
2400
+
2401
+ def initialize(**args)
2402
+ update!(**args)
2403
+ end
2404
+
2405
+ # Update properties of this object
2406
+ def update!(**args)
2407
+ @create_time = args[:create_time] if args.key?(:create_time)
2408
+ @display_name = args[:display_name] if args.key?(:display_name)
2409
+ @model_state = args[:model_state] if args.key?(:model_state)
2410
+ @model_version = args[:model_version] if args.key?(:model_version)
2411
+ @name = args[:name] if args.key?(:name)
2412
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
2413
+ end
2414
+ end
2415
+
2358
2416
  # DataStore captures global settings and configs at the DataStore level.
2359
2417
  class GoogleCloudDiscoveryengineV1alphaDataStore
2360
2418
  include Google::Apis::Core::Hashable
@@ -2754,8 +2812,8 @@ module Google
2754
2812
  class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig
2755
2813
  include Google::Apis::Core::Hashable
2756
2814
 
2757
- # Apply additional enhanced OCR processing to a list of document elements.
2758
- # Supported values: * `table`: advanced table parsing model.
2815
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
2816
+ # elements processing, please switch to `layout_parsing_config`.
2759
2817
  # Corresponds to the JSON property `enhancedDocumentElements`
2760
2818
  # @return [Array<String>]
2761
2819
  attr_accessor :enhanced_document_elements
@@ -2948,8 +3006,8 @@ module Google
2948
3006
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
2949
3007
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
2950
3008
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
2951
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
2952
- # agent association after Engine is created.
3009
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
3010
+ # association after Engine is created.
2953
3011
  # Corresponds to the JSON property `dialogflowAgentToLink`
2954
3012
  # @return [String]
2955
3013
  attr_accessor :dialogflow_agent_to_link
@@ -3184,7 +3242,7 @@ module Google
3184
3242
  attr_accessor :search_add_ons
3185
3243
 
3186
3244
  # The search feature tier of this engine. Different tiers might have different
3187
- # pricing. To learn more, please check the pricing documentation. Defaults to
3245
+ # pricing. To learn more, check the pricing documentation. Defaults to
3188
3246
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
3189
3247
  # Corresponds to the JSON property `searchTier`
3190
3248
  # @return [String]
@@ -3266,6 +3324,15 @@ module Google
3266
3324
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
3267
3325
  include Google::Apis::Core::Hashable
3268
3326
 
3327
+ # If this field is set, only the corresponding source will be indexed for this
3328
+ # field. Otherwise, the values from different sources are merged. Assuming a
3329
+ # page with `` in meta tag, and `` in page map: if this enum is set to METATAGS,
3330
+ # we will only index ``; if this enum is not set, we will merge them and index ``
3331
+ # .
3332
+ # Corresponds to the JSON property `advancedSiteSearchDataSources`
3333
+ # @return [Array<String>]
3334
+ attr_accessor :advanced_site_search_data_sources
3335
+
3269
3336
  # If completable_option is COMPLETABLE_ENABLED, field values are directly used
3270
3337
  # and returned as suggestions for Autocomplete in CompletionService.
3271
3338
  # CompleteQuery. If completable_option is unset, the server behavior defaults to
@@ -3366,6 +3433,7 @@ module Google
3366
3433
 
3367
3434
  # Update properties of this object
3368
3435
  def update!(**args)
3436
+ @advanced_site_search_data_sources = args[:advanced_site_search_data_sources] if args.key?(:advanced_site_search_data_sources)
3369
3437
  @completable_option = args[:completable_option] if args.key?(:completable_option)
3370
3438
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
3371
3439
  @field_path = args[:field_path] if args.key?(:field_path)
@@ -3422,66 +3490,6 @@ module Google
3422
3490
  end
3423
3491
  end
3424
3492
 
3425
- # Metadata related to the progress of the ImportCompletionSuggestions operation.
3426
- # This will be returned by the google.longrunning.Operation.metadata field.
3427
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
3428
- include Google::Apis::Core::Hashable
3429
-
3430
- # Operation create time.
3431
- # Corresponds to the JSON property `createTime`
3432
- # @return [String]
3433
- attr_accessor :create_time
3434
-
3435
- # Operation last update time. If the operation is done, this is also the finish
3436
- # time.
3437
- # Corresponds to the JSON property `updateTime`
3438
- # @return [String]
3439
- attr_accessor :update_time
3440
-
3441
- def initialize(**args)
3442
- update!(**args)
3443
- end
3444
-
3445
- # Update properties of this object
3446
- def update!(**args)
3447
- @create_time = args[:create_time] if args.key?(:create_time)
3448
- @update_time = args[:update_time] if args.key?(:update_time)
3449
- end
3450
- end
3451
-
3452
- # Response of the CompletionService.ImportCompletionSuggestions method. If the
3453
- # long running operation is done, this message is returned by the google.
3454
- # longrunning.Operations.response field if the operation is successful.
3455
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
3456
- include Google::Apis::Core::Hashable
3457
-
3458
- # A sample of errors encountered while processing the request.
3459
- # Corresponds to the JSON property `errorSamples`
3460
- # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
3461
- attr_accessor :error_samples
3462
-
3463
- # Count of CompletionSuggestions that failed to be imported.
3464
- # Corresponds to the JSON property `failureCount`
3465
- # @return [Fixnum]
3466
- attr_accessor :failure_count
3467
-
3468
- # Count of CompletionSuggestions successfully imported.
3469
- # Corresponds to the JSON property `successCount`
3470
- # @return [Fixnum]
3471
- attr_accessor :success_count
3472
-
3473
- def initialize(**args)
3474
- update!(**args)
3475
- end
3476
-
3477
- # Update properties of this object
3478
- def update!(**args)
3479
- @error_samples = args[:error_samples] if args.key?(:error_samples)
3480
- @failure_count = args[:failure_count] if args.key?(:failure_count)
3481
- @success_count = args[:success_count] if args.key?(:success_count)
3482
- end
3483
- end
3484
-
3485
3493
  # Metadata related to the progress of the ImportDocuments operation. This is
3486
3494
  # returned by the google.longrunning.Operation.metadata field.
3487
3495
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -3712,6 +3720,127 @@ module Google
3712
3720
  end
3713
3721
  end
3714
3722
 
3723
+ # Response message for SearchTuningService.ListCustomModels method.
3724
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
3725
+ include Google::Apis::Core::Hashable
3726
+
3727
+ # List of custom tuning models.
3728
+ # Corresponds to the JSON property `models`
3729
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
3730
+ attr_accessor :models
3731
+
3732
+ def initialize(**args)
3733
+ update!(**args)
3734
+ end
3735
+
3736
+ # Update properties of this object
3737
+ def update!(**args)
3738
+ @models = args[:models] if args.key?(:models)
3739
+ end
3740
+ end
3741
+
3742
+ # Metadata and configurations for a Google Cloud project in the service.
3743
+ class GoogleCloudDiscoveryengineV1alphaProject
3744
+ include Google::Apis::Core::Hashable
3745
+
3746
+ # Output only. The timestamp when this project is created.
3747
+ # Corresponds to the JSON property `createTime`
3748
+ # @return [String]
3749
+ attr_accessor :create_time
3750
+
3751
+ # Output only. Full resource name of the project, for example `projects/`
3752
+ # project_number``. Note that when making requests, project number and project
3753
+ # id are both acceptable, but the server will always respond in project number.
3754
+ # Corresponds to the JSON property `name`
3755
+ # @return [String]
3756
+ attr_accessor :name
3757
+
3758
+ # Output only. The timestamp when this project is successfully provisioned.
3759
+ # Empty value means this project is still provisioning and is not ready for use.
3760
+ # Corresponds to the JSON property `provisionCompletionTime`
3761
+ # @return [String]
3762
+ attr_accessor :provision_completion_time
3763
+
3764
+ # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
3765
+ # Corresponds to the JSON property `serviceTermsMap`
3766
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaProjectServiceTerms>]
3767
+ attr_accessor :service_terms_map
3768
+
3769
+ def initialize(**args)
3770
+ update!(**args)
3771
+ end
3772
+
3773
+ # Update properties of this object
3774
+ def update!(**args)
3775
+ @create_time = args[:create_time] if args.key?(:create_time)
3776
+ @name = args[:name] if args.key?(:name)
3777
+ @provision_completion_time = args[:provision_completion_time] if args.key?(:provision_completion_time)
3778
+ @service_terms_map = args[:service_terms_map] if args.key?(:service_terms_map)
3779
+ end
3780
+ end
3781
+
3782
+ # Metadata about the terms of service.
3783
+ class GoogleCloudDiscoveryengineV1alphaProjectServiceTerms
3784
+ include Google::Apis::Core::Hashable
3785
+
3786
+ # The last time when the project agreed to the terms of service.
3787
+ # Corresponds to the JSON property `acceptTime`
3788
+ # @return [String]
3789
+ attr_accessor :accept_time
3790
+
3791
+ # The last time when the project declined or revoked the agreement to terms of
3792
+ # service.
3793
+ # Corresponds to the JSON property `declineTime`
3794
+ # @return [String]
3795
+ attr_accessor :decline_time
3796
+
3797
+ # The unique identifier of this terms of service. Available terms: * `
3798
+ # GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-
3799
+ # use-terms). When using this as `id`, the acceptable version to provide is `
3800
+ # 2022-11-23`.
3801
+ # Corresponds to the JSON property `id`
3802
+ # @return [String]
3803
+ attr_accessor :id
3804
+
3805
+ # Whether the project has accepted/rejected the service terms or it is still
3806
+ # pending.
3807
+ # Corresponds to the JSON property `state`
3808
+ # @return [String]
3809
+ attr_accessor :state
3810
+
3811
+ # The version string of the terms of service. For acceptable values, see the
3812
+ # comments for id above.
3813
+ # Corresponds to the JSON property `version`
3814
+ # @return [String]
3815
+ attr_accessor :version
3816
+
3817
+ def initialize(**args)
3818
+ update!(**args)
3819
+ end
3820
+
3821
+ # Update properties of this object
3822
+ def update!(**args)
3823
+ @accept_time = args[:accept_time] if args.key?(:accept_time)
3824
+ @decline_time = args[:decline_time] if args.key?(:decline_time)
3825
+ @id = args[:id] if args.key?(:id)
3826
+ @state = args[:state] if args.key?(:state)
3827
+ @version = args[:version] if args.key?(:version)
3828
+ end
3829
+ end
3830
+
3831
+ # Metadata associated with a project provision operation.
3832
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata
3833
+ include Google::Apis::Core::Hashable
3834
+
3835
+ def initialize(**args)
3836
+ update!(**args)
3837
+ end
3838
+
3839
+ # Update properties of this object
3840
+ def update!(**args)
3841
+ end
3842
+ end
3843
+
3715
3844
  # Metadata related to the progress of the PurgeDocuments operation. This will be
3716
3845
  # returned by the google.longrunning.Operation.metadata field.
3717
3846
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -4109,8 +4238,8 @@ module Google
4109
4238
  # @return [String]
4110
4239
  attr_accessor :end_time
4111
4240
 
4112
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
4113
- # collection`/engines/`engine`/sessions/*`
4241
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
4242
+ # collections/`collection`/engines/`engine`/sessions/*`
4114
4243
  # Corresponds to the JSON property `name`
4115
4244
  # @return [String]
4116
4245
  attr_accessor :name
@@ -4244,6 +4373,11 @@ module Google
4244
4373
  # @return [String]
4245
4374
  attr_accessor :provided_uri_pattern
4246
4375
 
4376
+ # Output only. Root domain of the provided_uri_pattern.
4377
+ # Corresponds to the JSON property `rootDomainUri`
4378
+ # @return [String]
4379
+ attr_accessor :root_domain_uri
4380
+
4247
4381
  # Verification information for target sites in advanced site search.
4248
4382
  # Corresponds to the JSON property `siteVerificationInfo`
4249
4383
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo]
@@ -4272,6 +4406,7 @@ module Google
4272
4406
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
4273
4407
  @name = args[:name] if args.key?(:name)
4274
4408
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
4409
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
4275
4410
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
4276
4411
  @type = args[:type] if args.key?(:type)
4277
4412
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -4364,6 +4499,11 @@ module Google
4364
4499
  # @return [Hash<String,Float>]
4365
4500
  attr_accessor :metrics
4366
4501
 
4502
+ # Fully qualified name of the CustomTuningModel.
4503
+ # Corresponds to the JSON property `modelName`
4504
+ # @return [String]
4505
+ attr_accessor :model_name
4506
+
4367
4507
  # The trained model status. Possible values are: * **bad-data**: The training
4368
4508
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
4369
4509
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -4383,6 +4523,7 @@ module Google
4383
4523
  @error_config = args[:error_config] if args.key?(:error_config)
4384
4524
  @error_samples = args[:error_samples] if args.key?(:error_samples)
4385
4525
  @metrics = args[:metrics] if args.key?(:metrics)
4526
+ @model_name = args[:model_name] if args.key?(:model_name)
4386
4527
  @model_status = args[:model_status] if args.key?(:model_status)
4387
4528
  end
4388
4529
  end
@@ -4505,8 +4646,8 @@ module Google
4505
4646
  # @return [String]
4506
4647
  attr_accessor :create_time
4507
4648
 
4508
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
4509
- # collection`/engines/`engine`/sessions/*/answers/*`
4649
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
4650
+ # collections/`collection`/engines/`engine`/sessions/*/answers/*`
4510
4651
  # Corresponds to the JSON property `name`
4511
4652
  # @return [String]
4512
4653
  attr_accessor :name
@@ -4845,7 +4986,7 @@ module Google
4845
4986
  attr_accessor :disable
4846
4987
  alias_method :disable?, :disable
4847
4988
 
4848
- # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it
4989
+ # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it
4849
4990
  # will be set to 1 by default.
4850
4991
  # Corresponds to the JSON property `maxRephraseSteps`
4851
4992
  # @return [Fixnum]
@@ -5183,6 +5324,11 @@ module Google
5183
5324
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer]
5184
5325
  attr_accessor :answer
5185
5326
 
5327
+ # A global unique ID used for logging.
5328
+ # Corresponds to the JSON property `answerQueryToken`
5329
+ # @return [String]
5330
+ attr_accessor :answer_query_token
5331
+
5186
5332
  # External session proto definition.
5187
5333
  # Corresponds to the JSON property `session`
5188
5334
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
@@ -5195,6 +5341,7 @@ module Google
5195
5341
  # Update properties of this object
5196
5342
  def update!(**args)
5197
5343
  @answer = args[:answer] if args.key?(:answer)
5344
+ @answer_query_token = args[:answer_query_token] if args.key?(:answer_query_token)
5198
5345
  @session = args[:session] if args.key?(:session)
5199
5346
  end
5200
5347
  end
@@ -5919,7 +6066,7 @@ module Google
5919
6066
  class GoogleCloudDiscoveryengineV1betaCheckGroundingRequest
5920
6067
  include Google::Apis::Core::Hashable
5921
6068
 
5922
- # Answer candidate to check.
6069
+ # Answer candidate to check. Can have a maximum length of 1024 characters.
5923
6070
  # Corresponds to the JSON property `answerCandidate`
5924
6071
  # @return [String]
5925
6072
  attr_accessor :answer_candidate
@@ -5934,6 +6081,21 @@ module Google
5934
6081
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingSpec]
5935
6082
  attr_accessor :grounding_spec
5936
6083
 
6084
+ # The user labels applied to a resource must meet the following requirements: *
6085
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
6086
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
6087
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
6088
+ # have a maximum length of 63 characters. * Keys and values can contain only
6089
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
6090
+ # must use UTF-8 encoding, and international characters are allowed. * The key
6091
+ # portion of a label must be unique. However, you can use the same key with
6092
+ # multiple resources. * Keys must start with a lowercase letter or international
6093
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
6094
+ # manager/docs/creating-managing-labels#requirements) for more details.
6095
+ # Corresponds to the JSON property `userLabels`
6096
+ # @return [Hash<String,String>]
6097
+ attr_accessor :user_labels
6098
+
5937
6099
  def initialize(**args)
5938
6100
  update!(**args)
5939
6101
  end
@@ -5943,6 +6105,7 @@ module Google
5943
6105
  @answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
5944
6106
  @facts = args[:facts] if args.key?(:facts)
5945
6107
  @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
6108
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
5946
6109
  end
5947
6110
  end
5948
6111
 
@@ -6003,8 +6166,17 @@ module Google
6003
6166
  # @return [Fixnum]
6004
6167
  attr_accessor :end_pos
6005
6168
 
6169
+ # Indicates that this claim required grounding check. When the system decided
6170
+ # this claim doesn't require attribution/grounding check, this field will be set
6171
+ # to false. In that case, no grounding check was done for the claim and
6172
+ # therefore citation_indices, and anti_citation_indices should not be returned.
6173
+ # Corresponds to the JSON property `groundingCheckRequired`
6174
+ # @return [Boolean]
6175
+ attr_accessor :grounding_check_required
6176
+ alias_method :grounding_check_required?, :grounding_check_required
6177
+
6006
6178
  # Position indicating the start of the claim in the answer candidate, measured
6007
- # in bytes/unicode.
6179
+ # in bytes.
6008
6180
  # Corresponds to the JSON property `startPos`
6009
6181
  # @return [Fixnum]
6010
6182
  attr_accessor :start_pos
@@ -6018,6 +6190,7 @@ module Google
6018
6190
  @citation_indices = args[:citation_indices] if args.key?(:citation_indices)
6019
6191
  @claim_text = args[:claim_text] if args.key?(:claim_text)
6020
6192
  @end_pos = args[:end_pos] if args.key?(:end_pos)
6193
+ @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
6021
6194
  @start_pos = args[:start_pos] if args.key?(:start_pos)
6022
6195
  end
6023
6196
  end
@@ -6057,7 +6230,7 @@ module Google
6057
6230
 
6058
6231
  # Intermediate Cloud Storage directory used for the import with a length limit
6059
6232
  # of 2,000 characters. Can be specified if one wants to have the Cloud SQL
6060
- # export to a specific Cloud Storage directory. Please ensure that the Cloud SQL
6233
+ # export to a specific Cloud Storage directory. Ensure that the Cloud SQL
6061
6234
  # service account has the necessary Cloud Storage Admin permissions to access
6062
6235
  # the specified Cloud Storage directory.
6063
6236
  # Corresponds to the JSON property `gcsStagingDir`
@@ -6201,9 +6374,9 @@ module Google
6201
6374
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversationMessage>]
6202
6375
  attr_accessor :messages
6203
6376
 
6204
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
6205
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
6206
- # collections/`collection`/engines/*/conversations/*`.
6377
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
6378
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
6379
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
6207
6380
  # Corresponds to the JSON property `name`
6208
6381
  # @return [String]
6209
6382
  attr_accessor :name
@@ -6588,6 +6761,58 @@ module Google
6588
6761
  end
6589
6762
  end
6590
6763
 
6764
+ # Metadata that describes a custom tuned model.
6765
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
6766
+ include Google::Apis::Core::Hashable
6767
+
6768
+ # Timestamp the Model was created at.
6769
+ # Corresponds to the JSON property `createTime`
6770
+ # @return [String]
6771
+ attr_accessor :create_time
6772
+
6773
+ # The display name of the model.
6774
+ # Corresponds to the JSON property `displayName`
6775
+ # @return [String]
6776
+ attr_accessor :display_name
6777
+
6778
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
6779
+ # Corresponds to the JSON property `modelState`
6780
+ # @return [String]
6781
+ attr_accessor :model_state
6782
+
6783
+ #
6784
+ # Corresponds to the JSON property `modelVersion`
6785
+ # @return [Fixnum]
6786
+ attr_accessor :model_version
6787
+
6788
+ # Required. The fully qualified resource name of the model. Format: `projects/`
6789
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
6790
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
6791
+ # numerical string with limit of 40 characters.
6792
+ # Corresponds to the JSON property `name`
6793
+ # @return [String]
6794
+ attr_accessor :name
6795
+
6796
+ # Timestamp the model training was initiated.
6797
+ # Corresponds to the JSON property `trainingStartTime`
6798
+ # @return [String]
6799
+ attr_accessor :training_start_time
6800
+
6801
+ def initialize(**args)
6802
+ update!(**args)
6803
+ end
6804
+
6805
+ # Update properties of this object
6806
+ def update!(**args)
6807
+ @create_time = args[:create_time] if args.key?(:create_time)
6808
+ @display_name = args[:display_name] if args.key?(:display_name)
6809
+ @model_state = args[:model_state] if args.key?(:model_state)
6810
+ @model_version = args[:model_version] if args.key?(:model_version)
6811
+ @name = args[:name] if args.key?(:name)
6812
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
6813
+ end
6814
+ end
6815
+
6591
6816
  # DataStore captures global settings and configs at the DataStore level.
6592
6817
  class GoogleCloudDiscoveryengineV1betaDataStore
6593
6818
  include Google::Apis::Core::Hashable
@@ -7083,8 +7308,8 @@ module Google
7083
7308
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
7084
7309
  include Google::Apis::Core::Hashable
7085
7310
 
7086
- # Apply additional enhanced OCR processing to a list of document elements.
7087
- # Supported values: * `table`: advanced table parsing model.
7311
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
7312
+ # elements processing, please switch to `layout_parsing_config`.
7088
7313
  # Corresponds to the JSON property `enhancedDocumentElements`
7089
7314
  # @return [Array<String>]
7090
7315
  attr_accessor :enhanced_document_elements
@@ -7310,8 +7535,8 @@ module Google
7310
7535
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
7311
7536
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
7312
7537
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
7313
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
7314
- # agent association after Engine is created.
7538
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
7539
+ # association after Engine is created.
7315
7540
  # Corresponds to the JSON property `dialogflowAgentToLink`
7316
7541
  # @return [String]
7317
7542
  attr_accessor :dialogflow_agent_to_link
@@ -7424,7 +7649,7 @@ module Google
7424
7649
  attr_accessor :search_add_ons
7425
7650
 
7426
7651
  # The search feature tier of this engine. Different tiers might have different
7427
- # pricing. To learn more, please check the pricing documentation. Defaults to
7652
+ # pricing. To learn more, check the pricing documentation. Defaults to
7428
7653
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
7429
7654
  # Corresponds to the JSON property `searchTier`
7430
7655
  # @return [String]
@@ -7450,6 +7675,11 @@ module Google
7450
7675
  # @return [String]
7451
7676
  attr_accessor :chunk_text
7452
7677
 
7678
+ # The index of this chunk. Currently, only used for the streaming mode.
7679
+ # Corresponds to the JSON property `index`
7680
+ # @return [Fixnum]
7681
+ attr_accessor :index
7682
+
7453
7683
  # Source from which this fact chunk was retrieved. If it was retrieved from the
7454
7684
  # GroundingFacts provided in the request then this field will contain the index
7455
7685
  # of the specific fact from which this chunk was retrieved.
@@ -7469,6 +7699,7 @@ module Google
7469
7699
  # Update properties of this object
7470
7700
  def update!(**args)
7471
7701
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
7702
+ @index = args[:index] if args.key?(:index)
7472
7703
  @source = args[:source] if args.key?(:source)
7473
7704
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
7474
7705
  end
@@ -7555,7 +7786,7 @@ module Google
7555
7786
 
7556
7787
  # Intermediate Cloud Storage directory used for the import with a length limit
7557
7788
  # of 2,000 characters. Can be specified if one wants to have the Firestore
7558
- # export to a specific Cloud Storage directory. Please ensure that the Firestore
7789
+ # export to a specific Cloud Storage directory. Ensure that the Firestore
7559
7790
  # service account has the necessary Cloud Storage Admin permissions to access
7560
7791
  # the specified Cloud Storage directory.
7561
7792
  # Corresponds to the JSON property `gcsStagingDir`
@@ -8177,6 +8408,25 @@ module Google
8177
8408
  end
8178
8409
  end
8179
8410
 
8411
+ # Response message for SearchTuningService.ListCustomModels method.
8412
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
8413
+ include Google::Apis::Core::Hashable
8414
+
8415
+ # List of custom tuning models.
8416
+ # Corresponds to the JSON property `models`
8417
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCustomTuningModel>]
8418
+ attr_accessor :models
8419
+
8420
+ def initialize(**args)
8421
+ update!(**args)
8422
+ end
8423
+
8424
+ # Update properties of this object
8425
+ def update!(**args)
8426
+ @models = args[:models] if args.key?(:models)
8427
+ end
8428
+ end
8429
+
8180
8430
  # Response message for DataStoreService.ListDataStores method.
8181
8431
  class GoogleCloudDiscoveryengineV1betaListDataStoresResponse
8182
8432
  include Google::Apis::Core::Hashable
@@ -8399,12 +8649,12 @@ module Google
8399
8649
 
8400
8650
  # The most specific category associated with a category page. To represent full
8401
8651
  # path of category, use '>' sign to separate different hierarchies. If '>' is
8402
- # part of the category name, please replace it with other character(s). Category
8403
- # pages include special pages such as sales or promotions. For instance, a
8404
- # special sale page may have the category hierarchy: `"pageCategory" : "Sales >
8405
- # 2017 Black Friday Deals"`. Required for `view-category-page` events. Other
8406
- # event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
8407
- # is returned.
8652
+ # part of the category name, replace it with other character(s). Category pages
8653
+ # include special pages such as sales or promotions. For instance, a special
8654
+ # sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017
8655
+ # Black Friday Deals"`. Required for `view-category-page` events. Other event
8656
+ # types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is
8657
+ # returned.
8408
8658
  # Corresponds to the JSON property `pageCategory`
8409
8659
  # @return [String]
8410
8660
  attr_accessor :page_category
@@ -8715,7 +8965,7 @@ module Google
8715
8965
  # @return [String]
8716
8966
  attr_accessor :query
8717
8967
 
8718
- # Required. A list of records to rank. At most 100 records to rank.
8968
+ # Required. A list of records to rank. At most 200 records to rank.
8719
8969
  # Corresponds to the JSON property `records`
8720
8970
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankingRecord>]
8721
8971
  attr_accessor :records
@@ -9232,9 +9482,9 @@ module Google
9232
9482
 
9233
9483
  # The order in which documents are returned. Documents can be ordered by a field
9234
9484
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
9235
- # expression is case-sensitive. For more information on ordering, see [Ordering](
9236
- # https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
9237
- # unrecognizable, an `INVALID_ARGUMENT` is returned.
9485
+ # expression is case-sensitive. For more information on ordering for retail
9486
+ # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
9487
+ # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
9238
9488
  # Corresponds to the JSON property `orderBy`
9239
9489
  # @return [String]
9240
9490
  attr_accessor :order_by
@@ -9587,8 +9837,8 @@ module Google
9587
9837
 
9588
9838
  # Specifies whether to return the confidence score from the extractive segments
9589
9839
  # in each search result. This feature is available only for new or allowlisted
9590
- # data stores. To allowlist your data store, please contact your Customer
9591
- # Engineer. The default value is `false`.
9840
+ # data stores. To allowlist your data store, contact your Customer Engineer. The
9841
+ # default value is `false`.
9592
9842
  # Corresponds to the JSON property `returnExtractiveSegmentScore`
9593
9843
  # @return [Boolean]
9594
9844
  attr_accessor :return_extractive_segment_score
@@ -9707,13 +9957,15 @@ module Google
9707
9957
 
9708
9958
  # The number of top results to generate the summary from. If the number of
9709
9959
  # results returned is less than `summaryResultCount`, the summary is generated
9710
- # from all of the results. At most 10 results can be used to generate a summary.
9960
+ # from all of the results. At most 10 results for documents mode, or 50 for
9961
+ # chunks mode, can be used to generate a summary. The chunks mode is used when
9962
+ # SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
9711
9963
  # Corresponds to the JSON property `summaryResultCount`
9712
9964
  # @return [Fixnum]
9713
9965
  attr_accessor :summary_result_count
9714
9966
 
9715
9967
  # If true, answer will be generated from most relevant chunks from top search
9716
- # results. This feature will improve summary quality. Please note that with this
9968
+ # results. This feature will improve summary quality. Note that with this
9717
9969
  # feature enabled, not all top search results will be referenced and included in
9718
9970
  # the reference list, so the citation source index only points to the search
9719
9971
  # results listed in the reference list.
@@ -10857,8 +11109,8 @@ module Google
10857
11109
  # @return [String]
10858
11110
  attr_accessor :end_time
10859
11111
 
10860
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
10861
- # collection`/engines/`engine`/sessions/*`
11112
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
11113
+ # collections/`collection`/engines/`engine`/sessions/*`
10862
11114
  # Corresponds to the JSON property `name`
10863
11115
  # @return [String]
10864
11116
  attr_accessor :name
@@ -11088,6 +11340,11 @@ module Google
11088
11340
  # @return [String]
11089
11341
  attr_accessor :provided_uri_pattern
11090
11342
 
11343
+ # Output only. Root domain of the provided_uri_pattern.
11344
+ # Corresponds to the JSON property `rootDomainUri`
11345
+ # @return [String]
11346
+ attr_accessor :root_domain_uri
11347
+
11091
11348
  # Verification information for target sites in advanced site search.
11092
11349
  # Corresponds to the JSON property `siteVerificationInfo`
11093
11350
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo]
@@ -11116,6 +11373,7 @@ module Google
11116
11373
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
11117
11374
  @name = args[:name] if args.key?(:name)
11118
11375
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
11376
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
11119
11377
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
11120
11378
  @type = args[:type] if args.key?(:type)
11121
11379
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -11227,6 +11485,11 @@ module Google
11227
11485
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput]
11228
11486
  attr_accessor :gcs_training_input
11229
11487
 
11488
+ # If not provided, a UUID will be generated.
11489
+ # Corresponds to the JSON property `modelId`
11490
+ # @return [String]
11491
+ attr_accessor :model_id
11492
+
11230
11493
  # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
11231
11494
  # the search system based on data provided.
11232
11495
  # Corresponds to the JSON property `modelType`
@@ -11241,6 +11504,7 @@ module Google
11241
11504
  def update!(**args)
11242
11505
  @error_config = args[:error_config] if args.key?(:error_config)
11243
11506
  @gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
11507
+ @model_id = args[:model_id] if args.key?(:model_id)
11244
11508
  @model_type = args[:model_type] if args.key?(:model_type)
11245
11509
  end
11246
11510
  end
@@ -11314,6 +11578,11 @@ module Google
11314
11578
  # @return [Hash<String,Float>]
11315
11579
  attr_accessor :metrics
11316
11580
 
11581
+ # Fully qualified name of the CustomTuningModel.
11582
+ # Corresponds to the JSON property `modelName`
11583
+ # @return [String]
11584
+ attr_accessor :model_name
11585
+
11317
11586
  # The trained model status. Possible values are: * **bad-data**: The training
11318
11587
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
11319
11588
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -11333,6 +11602,7 @@ module Google
11333
11602
  @error_config = args[:error_config] if args.key?(:error_config)
11334
11603
  @error_samples = args[:error_samples] if args.key?(:error_samples)
11335
11604
  @metrics = args[:metrics] if args.key?(:metrics)
11605
+ @model_name = args[:model_name] if args.key?(:model_name)
11336
11606
  @model_status = args[:model_status] if args.key?(:model_status)
11337
11607
  end
11338
11608
  end
@@ -11431,6 +11701,19 @@ module Google
11431
11701
  end
11432
11702
  end
11433
11703
 
11704
+ # Response associated with a tune operation.
11705
+ class GoogleCloudDiscoveryengineV1betaTuneEngineResponse
11706
+ include Google::Apis::Core::Hashable
11707
+
11708
+ def initialize(**args)
11709
+ update!(**args)
11710
+ end
11711
+
11712
+ # Update properties of this object
11713
+ def update!(**args)
11714
+ end
11715
+ end
11716
+
11434
11717
  # Metadata for UpdateSchema LRO.
11435
11718
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
11436
11719
  include Google::Apis::Core::Hashable