google-apis-discoveryengine_v1beta 0.43.0 → 0.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +297 -72
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +85 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +171 -59
- metadata +5 -5
@@ -849,8 +849,7 @@ module Google
|
|
849
849
|
|
850
850
|
# The industry vertical that the engine registers. The restriction of the Engine
|
851
851
|
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
852
|
-
# Vertical on Engine has to match vertical of the DataStore
|
853
|
-
# engine.
|
852
|
+
# Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
854
853
|
# Corresponds to the JSON property `industryVertical`
|
855
854
|
# @return [String]
|
856
855
|
attr_accessor :industry_vertical
|
@@ -1507,6 +1506,11 @@ module Google
|
|
1507
1506
|
# @return [String]
|
1508
1507
|
attr_accessor :provided_uri_pattern
|
1509
1508
|
|
1509
|
+
# Output only. Root domain of the provided_uri_pattern.
|
1510
|
+
# Corresponds to the JSON property `rootDomainUri`
|
1511
|
+
# @return [String]
|
1512
|
+
attr_accessor :root_domain_uri
|
1513
|
+
|
1510
1514
|
# Verification information for target sites in advanced site search.
|
1511
1515
|
# Corresponds to the JSON property `siteVerificationInfo`
|
1512
1516
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SiteVerificationInfo]
|
@@ -1535,6 +1539,7 @@ module Google
|
|
1535
1539
|
@indexing_status = args[:indexing_status] if args.key?(:indexing_status)
|
1536
1540
|
@name = args[:name] if args.key?(:name)
|
1537
1541
|
@provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
|
1542
|
+
@root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
|
1538
1543
|
@site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
|
1539
1544
|
@type = args[:type] if args.key?(:type)
|
1540
1545
|
@update_time = args[:update_time] if args.key?(:update_time)
|
@@ -2355,6 +2360,58 @@ module Google
|
|
2355
2360
|
end
|
2356
2361
|
end
|
2357
2362
|
|
2363
|
+
# Metadata that describes a custom tuned model.
|
2364
|
+
class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
|
2365
|
+
include Google::Apis::Core::Hashable
|
2366
|
+
|
2367
|
+
# Timestamp the Model was created at.
|
2368
|
+
# Corresponds to the JSON property `createTime`
|
2369
|
+
# @return [String]
|
2370
|
+
attr_accessor :create_time
|
2371
|
+
|
2372
|
+
# The display name of the model.
|
2373
|
+
# Corresponds to the JSON property `displayName`
|
2374
|
+
# @return [String]
|
2375
|
+
attr_accessor :display_name
|
2376
|
+
|
2377
|
+
# The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
|
2378
|
+
# Corresponds to the JSON property `modelState`
|
2379
|
+
# @return [String]
|
2380
|
+
attr_accessor :model_state
|
2381
|
+
|
2382
|
+
#
|
2383
|
+
# Corresponds to the JSON property `modelVersion`
|
2384
|
+
# @return [Fixnum]
|
2385
|
+
attr_accessor :model_version
|
2386
|
+
|
2387
|
+
# Required. The fully qualified resource name of the model. Format: `projects/`
|
2388
|
+
# project_number`/locations/`location`/collections/`collection`/dataStores/`
|
2389
|
+
# data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
|
2390
|
+
# numerical string with limit of 40 characters.
|
2391
|
+
# Corresponds to the JSON property `name`
|
2392
|
+
# @return [String]
|
2393
|
+
attr_accessor :name
|
2394
|
+
|
2395
|
+
# Timestamp the model training was initiated.
|
2396
|
+
# Corresponds to the JSON property `trainingStartTime`
|
2397
|
+
# @return [String]
|
2398
|
+
attr_accessor :training_start_time
|
2399
|
+
|
2400
|
+
def initialize(**args)
|
2401
|
+
update!(**args)
|
2402
|
+
end
|
2403
|
+
|
2404
|
+
# Update properties of this object
|
2405
|
+
def update!(**args)
|
2406
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
2407
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
2408
|
+
@model_state = args[:model_state] if args.key?(:model_state)
|
2409
|
+
@model_version = args[:model_version] if args.key?(:model_version)
|
2410
|
+
@name = args[:name] if args.key?(:name)
|
2411
|
+
@training_start_time = args[:training_start_time] if args.key?(:training_start_time)
|
2412
|
+
end
|
2413
|
+
end
|
2414
|
+
|
2358
2415
|
# DataStore captures global settings and configs at the DataStore level.
|
2359
2416
|
class GoogleCloudDiscoveryengineV1alphaDataStore
|
2360
2417
|
include Google::Apis::Core::Hashable
|
@@ -2862,8 +2919,7 @@ module Google
|
|
2862
2919
|
|
2863
2920
|
# The industry vertical that the engine registers. The restriction of the Engine
|
2864
2921
|
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
2865
|
-
# Vertical on Engine has to match vertical of the DataStore
|
2866
|
-
# engine.
|
2922
|
+
# Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
2867
2923
|
# Corresponds to the JSON property `industryVertical`
|
2868
2924
|
# @return [String]
|
2869
2925
|
attr_accessor :industry_vertical
|
@@ -3662,6 +3718,25 @@ module Google
|
|
3662
3718
|
end
|
3663
3719
|
end
|
3664
3720
|
|
3721
|
+
# Response message for SearchTuningService.ListCustomModels method.
|
3722
|
+
class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
|
3723
|
+
include Google::Apis::Core::Hashable
|
3724
|
+
|
3725
|
+
# List of custom tuning models.
|
3726
|
+
# Corresponds to the JSON property `models`
|
3727
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
|
3728
|
+
attr_accessor :models
|
3729
|
+
|
3730
|
+
def initialize(**args)
|
3731
|
+
update!(**args)
|
3732
|
+
end
|
3733
|
+
|
3734
|
+
# Update properties of this object
|
3735
|
+
def update!(**args)
|
3736
|
+
@models = args[:models] if args.key?(:models)
|
3737
|
+
end
|
3738
|
+
end
|
3739
|
+
|
3665
3740
|
# Metadata and configurations for a Google Cloud project in the service.
|
3666
3741
|
class GoogleCloudDiscoveryengineV1alphaProject
|
3667
3742
|
include Google::Apis::Core::Hashable
|
@@ -4206,7 +4281,8 @@ module Google
|
|
4206
4281
|
class GoogleCloudDiscoveryengineV1alphaSessionTurn
|
4207
4282
|
include Google::Apis::Core::Hashable
|
4208
4283
|
|
4209
|
-
# The resource name of the answer to the user query.
|
4284
|
+
# The resource name of the answer to the user query. Only set if the answer
|
4285
|
+
# generation (/answer API call) happened in this turn.
|
4210
4286
|
# Corresponds to the JSON property `answer`
|
4211
4287
|
# @return [String]
|
4212
4288
|
attr_accessor :answer
|
@@ -4296,6 +4372,11 @@ module Google
|
|
4296
4372
|
# @return [String]
|
4297
4373
|
attr_accessor :provided_uri_pattern
|
4298
4374
|
|
4375
|
+
# Output only. Root domain of the provided_uri_pattern.
|
4376
|
+
# Corresponds to the JSON property `rootDomainUri`
|
4377
|
+
# @return [String]
|
4378
|
+
attr_accessor :root_domain_uri
|
4379
|
+
|
4299
4380
|
# Verification information for target sites in advanced site search.
|
4300
4381
|
# Corresponds to the JSON property `siteVerificationInfo`
|
4301
4382
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo]
|
@@ -4324,6 +4405,7 @@ module Google
|
|
4324
4405
|
@indexing_status = args[:indexing_status] if args.key?(:indexing_status)
|
4325
4406
|
@name = args[:name] if args.key?(:name)
|
4326
4407
|
@provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
|
4408
|
+
@root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
|
4327
4409
|
@site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
|
4328
4410
|
@type = args[:type] if args.key?(:type)
|
4329
4411
|
@update_time = args[:update_time] if args.key?(:update_time)
|
@@ -4416,6 +4498,11 @@ module Google
|
|
4416
4498
|
# @return [Hash<String,Float>]
|
4417
4499
|
attr_accessor :metrics
|
4418
4500
|
|
4501
|
+
# Fully qualified name of the CustomTuningModel.
|
4502
|
+
# Corresponds to the JSON property `modelName`
|
4503
|
+
# @return [String]
|
4504
|
+
attr_accessor :model_name
|
4505
|
+
|
4419
4506
|
# The trained model status. Possible values are: * **bad-data**: The training
|
4420
4507
|
# data quality is bad. * **no-improvement**: Tuning didn't improve performance.
|
4421
4508
|
# Won't deploy. * **in-progress**: Model training job creation is in progress. *
|
@@ -4435,6 +4522,7 @@ module Google
|
|
4435
4522
|
@error_config = args[:error_config] if args.key?(:error_config)
|
4436
4523
|
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
4437
4524
|
@metrics = args[:metrics] if args.key?(:metrics)
|
4525
|
+
@model_name = args[:model_name] if args.key?(:model_name)
|
4438
4526
|
@model_status = args[:model_status] if args.key?(:model_status)
|
4439
4527
|
end
|
4440
4528
|
end
|
@@ -4704,7 +4792,7 @@ module Google
|
|
4704
4792
|
|
4705
4793
|
# The session resource name. Not required. When session field is not set, the
|
4706
4794
|
# API is in sessionless mode. We support auto session mode: users can use the
|
4707
|
-
# wildcard symbol
|
4795
|
+
# wildcard symbol `-` as session ID. A new ID will be automatically generated
|
4708
4796
|
# and assigned.
|
4709
4797
|
# Corresponds to the JSON property `session`
|
4710
4798
|
# @return [String]
|
@@ -5977,7 +6065,7 @@ module Google
|
|
5977
6065
|
class GoogleCloudDiscoveryengineV1betaCheckGroundingRequest
|
5978
6066
|
include Google::Apis::Core::Hashable
|
5979
6067
|
|
5980
|
-
# Answer candidate to check.
|
6068
|
+
# Answer candidate to check. Can have a maximum length of 1024 characters.
|
5981
6069
|
# Corresponds to the JSON property `answerCandidate`
|
5982
6070
|
# @return [String]
|
5983
6071
|
attr_accessor :answer_candidate
|
@@ -5992,6 +6080,21 @@ module Google
|
|
5992
6080
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingSpec]
|
5993
6081
|
attr_accessor :grounding_spec
|
5994
6082
|
|
6083
|
+
# The user labels applied to a resource must meet the following requirements: *
|
6084
|
+
# Each resource can have multiple labels, up to a maximum of 64. * Each label
|
6085
|
+
# must be a key-value pair. * Keys have a minimum length of 1 character and a
|
6086
|
+
# maximum length of 63 characters and cannot be empty. Values can be empty and
|
6087
|
+
# have a maximum length of 63 characters. * Keys and values can contain only
|
6088
|
+
# lowercase letters, numeric characters, underscores, and dashes. All characters
|
6089
|
+
# must use UTF-8 encoding, and international characters are allowed. * The key
|
6090
|
+
# portion of a label must be unique. However, you can use the same key with
|
6091
|
+
# multiple resources. * Keys must start with a lowercase letter or international
|
6092
|
+
# character. See [Google Cloud Document](https://cloud.google.com/resource-
|
6093
|
+
# manager/docs/creating-managing-labels#requirements) for more details.
|
6094
|
+
# Corresponds to the JSON property `userLabels`
|
6095
|
+
# @return [Hash<String,String>]
|
6096
|
+
attr_accessor :user_labels
|
6097
|
+
|
5995
6098
|
def initialize(**args)
|
5996
6099
|
update!(**args)
|
5997
6100
|
end
|
@@ -6001,6 +6104,7 @@ module Google
|
|
6001
6104
|
@answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
|
6002
6105
|
@facts = args[:facts] if args.key?(:facts)
|
6003
6106
|
@grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
|
6107
|
+
@user_labels = args[:user_labels] if args.key?(:user_labels)
|
6004
6108
|
end
|
6005
6109
|
end
|
6006
6110
|
|
@@ -6061,6 +6165,15 @@ module Google
|
|
6061
6165
|
# @return [Fixnum]
|
6062
6166
|
attr_accessor :end_pos
|
6063
6167
|
|
6168
|
+
# Indicates that this claim required grounding check. When the system decided
|
6169
|
+
# this claim doesn't require attribution/grounding check, this field will be set
|
6170
|
+
# to false. In that case, no grounding check was done for the claim and
|
6171
|
+
# therefore citation_indices, and anti_citation_indices should not be returned.
|
6172
|
+
# Corresponds to the JSON property `groundingCheckRequired`
|
6173
|
+
# @return [Boolean]
|
6174
|
+
attr_accessor :grounding_check_required
|
6175
|
+
alias_method :grounding_check_required?, :grounding_check_required
|
6176
|
+
|
6064
6177
|
# Position indicating the start of the claim in the answer candidate, measured
|
6065
6178
|
# in bytes.
|
6066
6179
|
# Corresponds to the JSON property `startPos`
|
@@ -6076,6 +6189,7 @@ module Google
|
|
6076
6189
|
@citation_indices = args[:citation_indices] if args.key?(:citation_indices)
|
6077
6190
|
@claim_text = args[:claim_text] if args.key?(:claim_text)
|
6078
6191
|
@end_pos = args[:end_pos] if args.key?(:end_pos)
|
6192
|
+
@grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
|
6079
6193
|
@start_pos = args[:start_pos] if args.key?(:start_pos)
|
6080
6194
|
end
|
6081
6195
|
end
|
@@ -6646,6 +6760,58 @@ module Google
|
|
6646
6760
|
end
|
6647
6761
|
end
|
6648
6762
|
|
6763
|
+
# Metadata that describes a custom tuned model.
|
6764
|
+
class GoogleCloudDiscoveryengineV1betaCustomTuningModel
|
6765
|
+
include Google::Apis::Core::Hashable
|
6766
|
+
|
6767
|
+
# Timestamp the Model was created at.
|
6768
|
+
# Corresponds to the JSON property `createTime`
|
6769
|
+
# @return [String]
|
6770
|
+
attr_accessor :create_time
|
6771
|
+
|
6772
|
+
# The display name of the model.
|
6773
|
+
# Corresponds to the JSON property `displayName`
|
6774
|
+
# @return [String]
|
6775
|
+
attr_accessor :display_name
|
6776
|
+
|
6777
|
+
# The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
|
6778
|
+
# Corresponds to the JSON property `modelState`
|
6779
|
+
# @return [String]
|
6780
|
+
attr_accessor :model_state
|
6781
|
+
|
6782
|
+
#
|
6783
|
+
# Corresponds to the JSON property `modelVersion`
|
6784
|
+
# @return [Fixnum]
|
6785
|
+
attr_accessor :model_version
|
6786
|
+
|
6787
|
+
# Required. The fully qualified resource name of the model. Format: `projects/`
|
6788
|
+
# project_number`/locations/`location`/collections/`collection`/dataStores/`
|
6789
|
+
# data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
|
6790
|
+
# numerical string with limit of 40 characters.
|
6791
|
+
# Corresponds to the JSON property `name`
|
6792
|
+
# @return [String]
|
6793
|
+
attr_accessor :name
|
6794
|
+
|
6795
|
+
# Timestamp the model training was initiated.
|
6796
|
+
# Corresponds to the JSON property `trainingStartTime`
|
6797
|
+
# @return [String]
|
6798
|
+
attr_accessor :training_start_time
|
6799
|
+
|
6800
|
+
def initialize(**args)
|
6801
|
+
update!(**args)
|
6802
|
+
end
|
6803
|
+
|
6804
|
+
# Update properties of this object
|
6805
|
+
def update!(**args)
|
6806
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
6807
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
6808
|
+
@model_state = args[:model_state] if args.key?(:model_state)
|
6809
|
+
@model_version = args[:model_version] if args.key?(:model_version)
|
6810
|
+
@name = args[:name] if args.key?(:name)
|
6811
|
+
@training_start_time = args[:training_start_time] if args.key?(:training_start_time)
|
6812
|
+
end
|
6813
|
+
end
|
6814
|
+
|
6649
6815
|
# DataStore captures global settings and configs at the DataStore level.
|
6650
6816
|
class GoogleCloudDiscoveryengineV1betaDataStore
|
6651
6817
|
include Google::Apis::Core::Hashable
|
@@ -7034,9 +7200,9 @@ module Google
|
|
7034
7200
|
attr_accessor :promotion_ids
|
7035
7201
|
|
7036
7202
|
# Quantity of the Document associated with the user event. Defaults to 1. For
|
7037
|
-
# example, this field
|
7038
|
-
#
|
7039
|
-
#
|
7203
|
+
# example, this field is 2 if two quantities of the same Document are involved
|
7204
|
+
# in a `add-to-cart` event. Required for events of the following event types: * `
|
7205
|
+
# add-to-cart` * `purchase`
|
7040
7206
|
# Corresponds to the JSON property `quantity`
|
7041
7207
|
# @return [Fixnum]
|
7042
7208
|
attr_accessor :quantity
|
@@ -7300,8 +7466,7 @@ module Google
|
|
7300
7466
|
|
7301
7467
|
# The industry vertical that the engine registers. The restriction of the Engine
|
7302
7468
|
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
7303
|
-
# Vertical on Engine has to match vertical of the DataStore
|
7304
|
-
# engine.
|
7469
|
+
# Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
7305
7470
|
# Corresponds to the JSON property `industryVertical`
|
7306
7471
|
# @return [String]
|
7307
7472
|
attr_accessor :industry_vertical
|
@@ -7508,6 +7673,11 @@ module Google
|
|
7508
7673
|
# @return [String]
|
7509
7674
|
attr_accessor :chunk_text
|
7510
7675
|
|
7676
|
+
# The index of this chunk. Currently, only used for the streaming mode.
|
7677
|
+
# Corresponds to the JSON property `index`
|
7678
|
+
# @return [Fixnum]
|
7679
|
+
attr_accessor :index
|
7680
|
+
|
7511
7681
|
# Source from which this fact chunk was retrieved. If it was retrieved from the
|
7512
7682
|
# GroundingFacts provided in the request then this field will contain the index
|
7513
7683
|
# of the specific fact from which this chunk was retrieved.
|
@@ -7527,6 +7697,7 @@ module Google
|
|
7527
7697
|
# Update properties of this object
|
7528
7698
|
def update!(**args)
|
7529
7699
|
@chunk_text = args[:chunk_text] if args.key?(:chunk_text)
|
7700
|
+
@index = args[:index] if args.key?(:index)
|
7530
7701
|
@source = args[:source] if args.key?(:source)
|
7531
7702
|
@source_metadata = args[:source_metadata] if args.key?(:source_metadata)
|
7532
7703
|
end
|
@@ -7599,8 +7770,8 @@ module Google
|
|
7599
7770
|
class GoogleCloudDiscoveryengineV1betaFirestoreSource
|
7600
7771
|
include Google::Apis::Core::Hashable
|
7601
7772
|
|
7602
|
-
# Required. The Firestore collection to copy the data from with a
|
7603
|
-
# of 1,500 characters.
|
7773
|
+
# Required. The Firestore collection (or entity) to copy the data from with a
|
7774
|
+
# length limit of 1,500 characters.
|
7604
7775
|
# Corresponds to the JSON property `collectionId`
|
7605
7776
|
# @return [String]
|
7606
7777
|
attr_accessor :collection_id
|
@@ -7653,17 +7824,17 @@ module Google
|
|
7653
7824
|
# vertical. * `csv`: A CSV file with header conforming to the defined Schema of
|
7654
7825
|
# the data store. Each entry after the header is imported as a Document. This
|
7655
7826
|
# can only be used by the GENERIC Data Store vertical. Supported values for user
|
7656
|
-
#
|
7827
|
+
# event imports: * `user_event` (default): One JSON UserEvent per line.
|
7657
7828
|
# Corresponds to the JSON property `dataSchema`
|
7658
7829
|
# @return [String]
|
7659
7830
|
attr_accessor :data_schema
|
7660
7831
|
|
7661
|
-
# Required. Cloud Storage URIs to input files. URI can be up to 2000
|
7662
|
-
# long. URIs can match the full object path (for example, `gs://
|
7663
|
-
# object.json`) or a pattern matching one or more files, such
|
7664
|
-
# directory/*.json`. A request can contain at most 100 files (or
|
7665
|
-
# if `data_schema` is `content`). Each file can be up to 2 GB (or
|
7666
|
-
# data_schema` is `content`).
|
7832
|
+
# Required. Cloud Storage URIs to input files. Each URI can be up to 2000
|
7833
|
+
# characters long. URIs can match the full object path (for example, `gs://
|
7834
|
+
# bucket/directory/object.json`) or a pattern matching one or more files, such
|
7835
|
+
# as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or
|
7836
|
+
# 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or
|
7837
|
+
# 100 MB if `data_schema` is `content`).
|
7667
7838
|
# Corresponds to the JSON property `inputUris`
|
7668
7839
|
# @return [Array<String>]
|
7669
7840
|
attr_accessor :input_uris
|
@@ -8235,6 +8406,25 @@ module Google
|
|
8235
8406
|
end
|
8236
8407
|
end
|
8237
8408
|
|
8409
|
+
# Response message for SearchTuningService.ListCustomModels method.
|
8410
|
+
class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
|
8411
|
+
include Google::Apis::Core::Hashable
|
8412
|
+
|
8413
|
+
# List of custom tuning models.
|
8414
|
+
# Corresponds to the JSON property `models`
|
8415
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCustomTuningModel>]
|
8416
|
+
attr_accessor :models
|
8417
|
+
|
8418
|
+
def initialize(**args)
|
8419
|
+
update!(**args)
|
8420
|
+
end
|
8421
|
+
|
8422
|
+
# Update properties of this object
|
8423
|
+
def update!(**args)
|
8424
|
+
@models = args[:models] if args.key?(:models)
|
8425
|
+
end
|
8426
|
+
end
|
8427
|
+
|
8238
8428
|
# Response message for DataStoreService.ListDataStores method.
|
8239
8429
|
class GoogleCloudDiscoveryengineV1betaListDataStoresResponse
|
8240
8430
|
include Google::Apis::Core::Hashable
|
@@ -8868,45 +9058,44 @@ module Google
|
|
8868
9058
|
# field, then attribute-based expressions are expected instead of the above
|
8869
9059
|
# described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
|
8870
9060
|
# categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
|
8871
|
-
# OR (categories: ANY("Movie")) If your filter blocks all results, the API
|
8872
|
-
#
|
8873
|
-
# strictly matching the filters, set `strictFiltering` to
|
9061
|
+
# OR (categories: ANY("Movie")) If your filter blocks all results, the API
|
9062
|
+
# returns generic (unfiltered) popular Documents. If you only want results
|
9063
|
+
# strictly matching the filters, set `strictFiltering` to `true` in
|
8874
9064
|
# RecommendRequest.params to receive empty results instead. Note that the API
|
8875
|
-
#
|
9065
|
+
# never returns Documents with `storageStatus` as `EXPIRED` or `DELETED`
|
8876
9066
|
# regardless of filter choices.
|
8877
9067
|
# Corresponds to the JSON property `filter`
|
8878
9068
|
# @return [String]
|
8879
9069
|
attr_accessor :filter
|
8880
9070
|
|
8881
9071
|
# Maximum number of results to return. Set this property to the number of
|
8882
|
-
# recommendation results needed. If zero, the service
|
8883
|
-
# default. The maximum allowed value is 100. Values above 100
|
8884
|
-
# 100.
|
9072
|
+
# recommendation results needed. If zero, the service chooses a reasonable
|
9073
|
+
# default. The maximum allowed value is 100. Values above 100 are set to 100.
|
8885
9074
|
# Corresponds to the JSON property `pageSize`
|
8886
9075
|
# @return [Fixnum]
|
8887
9076
|
attr_accessor :page_size
|
8888
9077
|
|
8889
9078
|
# Additional domain specific parameters for the recommendations. Allowed values:
|
8890
|
-
# * `returnDocument`: Boolean. If set to true
|
8891
|
-
#
|
8892
|
-
#
|
8893
|
-
#
|
8894
|
-
#
|
8895
|
-
#
|
8896
|
-
#
|
8897
|
-
#
|
8898
|
-
#
|
8899
|
-
#
|
8900
|
-
#
|
8901
|
-
#
|
8902
|
-
#
|
8903
|
-
#
|
9079
|
+
# * `returnDocument`: Boolean. If set to `true`, the associated Document object
|
9080
|
+
# is returned in RecommendResponse.RecommendationResult.document. * `returnScore`
|
9081
|
+
# : Boolean. If set to true, the recommendation score corresponding to each
|
9082
|
+
# returned Document is set in RecommendResponse.RecommendationResult.metadata.
|
9083
|
+
# The given score indicates the probability of a Document conversion given the
|
9084
|
+
# user's context and history. * `strictFiltering`: Boolean. True by default. If
|
9085
|
+
# set to `false`, the service returns generic (unfiltered) popular Documents
|
9086
|
+
# instead of empty if your filter blocks all recommendation results. * `
|
9087
|
+
# diversityLevel`: String. Default empty. If set to be non-empty, then it needs
|
9088
|
+
# to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-
|
9089
|
+
# diversity` * `auto-diversity` This gives request-level control and adjusts
|
9090
|
+
# recommendation results based on Document category. * `attributeFilteringSyntax`
|
9091
|
+
# : Boolean. False by default. If set to true, the `filter` field is interpreted
|
9092
|
+
# according to the new, attribute-based syntax.
|
8904
9093
|
# Corresponds to the JSON property `params`
|
8905
9094
|
# @return [Hash<String,Object>]
|
8906
9095
|
attr_accessor :params
|
8907
9096
|
|
8908
9097
|
# UserEvent captures all metadata information Discovery Engine API needs to know
|
8909
|
-
# about how end users interact with
|
9098
|
+
# about how end users interact with your website.
|
8910
9099
|
# Corresponds to the JSON property `userEvent`
|
8911
9100
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent]
|
8912
9101
|
attr_accessor :user_event
|
@@ -8926,10 +9115,9 @@ module Google
|
|
8926
9115
|
# @return [Hash<String,String>]
|
8927
9116
|
attr_accessor :user_labels
|
8928
9117
|
|
8929
|
-
# Use validate only mode for this recommendation query. If set to true
|
8930
|
-
# model
|
8931
|
-
#
|
8932
|
-
# ready.
|
9118
|
+
# Use validate only mode for this recommendation query. If set to `true`, a fake
|
9119
|
+
# model is used that returns arbitrary Document IDs. Note that the validate only
|
9120
|
+
# mode should only be used for testing the API, or if the model is not ready.
|
8933
9121
|
# Corresponds to the JSON property `validateOnly`
|
8934
9122
|
# @return [Boolean]
|
8935
9123
|
attr_accessor :validate_only
|
@@ -9008,7 +9196,7 @@ module Google
|
|
9008
9196
|
# @return [String]
|
9009
9197
|
attr_accessor :id
|
9010
9198
|
|
9011
|
-
# Additional Document metadata
|
9199
|
+
# Additional Document metadata or annotations. Possible values: * `score`:
|
9012
9200
|
# Recommendation score in double value. Is set if `returnScore` is set to true
|
9013
9201
|
# in RecommendRequest.params.
|
9014
9202
|
# Corresponds to the JSON property `metadata`
|
@@ -9062,7 +9250,7 @@ module Google
|
|
9062
9250
|
# @return [String]
|
9063
9251
|
attr_accessor :reply
|
9064
9252
|
|
9065
|
-
# Summary of the top N search
|
9253
|
+
# Summary of the top N search results specified by the summary spec.
|
9066
9254
|
# Corresponds to the JSON property `summary`
|
9067
9255
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummary]
|
9068
9256
|
attr_accessor :summary
|
@@ -9242,7 +9430,10 @@ module Google
|
|
9242
9430
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
|
9243
9431
|
attr_accessor :content_search_spec
|
9244
9432
|
|
9245
|
-
#
|
9433
|
+
# Specs defining dataStores to filter on in a search call and configurations for
|
9434
|
+
# those dataStores. This is only considered for engines with multiple dataStores
|
9435
|
+
# use case. For single dataStore within an engine, they should use the specs at
|
9436
|
+
# the top level.
|
9246
9437
|
# Corresponds to the JSON property `dataStoreSpecs`
|
9247
9438
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
|
9248
9439
|
attr_accessor :data_store_specs
|
@@ -9290,9 +9481,9 @@ module Google
|
|
9290
9481
|
|
9291
9482
|
# The order in which documents are returned. Documents can be ordered by a field
|
9292
9483
|
# in an Document object. Leave it unset if ordered by relevance. `order_by`
|
9293
|
-
# expression is case-sensitive. For more information on ordering
|
9294
|
-
# https://cloud.google.com/retail/docs/filter-and-order#
|
9295
|
-
# unrecognizable, an `INVALID_ARGUMENT` is returned.
|
9484
|
+
# expression is case-sensitive. For more information on ordering for retail
|
9485
|
+
# search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
|
9486
|
+
# order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
9296
9487
|
# Corresponds to the JSON property `orderBy`
|
9297
9488
|
# @return [String]
|
9298
9489
|
attr_accessor :order_by
|
@@ -9316,12 +9507,12 @@ module Google
|
|
9316
9507
|
|
9317
9508
|
# Additional search parameters. For public website search only, supported values
|
9318
9509
|
# are: * `user_country_code`: string. Default empty. If set to non-empty,
|
9319
|
-
# results are restricted or boosted based on the location provided.
|
9320
|
-
# user_country_code: "au" For available codes see [Country Codes](https://
|
9510
|
+
# results are restricted or boosted based on the location provided. For example,
|
9511
|
+
# `user_country_code: "au"` For available codes see [Country Codes](https://
|
9321
9512
|
# developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `
|
9322
9513
|
# search_type`: double. Default empty. Enables non-webpage searching depending
|
9323
9514
|
# on the value. The only valid non-default value is 1, which enables image
|
9324
|
-
# searching.
|
9515
|
+
# searching. For example, `search_type: 1`
|
9325
9516
|
# Corresponds to the JSON property `params`
|
9326
9517
|
# @return [Hash<String,Object>]
|
9327
9518
|
attr_accessor :params
|
@@ -9845,7 +10036,9 @@ module Google
|
|
9845
10036
|
end
|
9846
10037
|
end
|
9847
10038
|
|
9848
|
-
# A struct to define data stores to filter on in a search call
|
10039
|
+
# A struct to define data stores to filter on in a search call and
|
10040
|
+
# configurations for those data stores. A maximum of 1 DataStoreSpec per
|
10041
|
+
# data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
9849
10042
|
class GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec
|
9850
10043
|
include Google::Apis::Core::Hashable
|
9851
10044
|
|
@@ -9961,9 +10154,9 @@ module Google
|
|
9961
10154
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey]
|
9962
10155
|
attr_accessor :facet_key
|
9963
10156
|
|
9964
|
-
# Maximum
|
9965
|
-
# defaults to 20. The maximum allowed value is 300. Values above 300 are
|
9966
|
-
#
|
10157
|
+
# Maximum facet values that are returned for this facet. If unspecified,
|
10158
|
+
# defaults to 20. The maximum allowed value is 300. Values above 300 are coerced
|
10159
|
+
# to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
9967
10160
|
# Corresponds to the JSON property `limit`
|
9968
10161
|
# @return [Fixnum]
|
9969
10162
|
attr_accessor :limit
|
@@ -9992,7 +10185,7 @@ module Google
|
|
9992
10185
|
attr_accessor :case_insensitive
|
9993
10186
|
alias_method :case_insensitive?, :case_insensitive
|
9994
10187
|
|
9995
|
-
# Only get facet values that
|
10188
|
+
# Only get facet values that contain the given strings. For example, suppose "
|
9996
10189
|
# category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022"
|
9997
10190
|
# . If set "contains" to "2022", the "category" facet only contains "Action >
|
9998
10191
|
# 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
|
@@ -10109,8 +10302,8 @@ module Google
|
|
10109
10302
|
class GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec
|
10110
10303
|
include Google::Apis::Core::Hashable
|
10111
10304
|
|
10112
|
-
# The mode under which spell correction
|
10113
|
-
#
|
10305
|
+
# The mode under which spell correction replaces the original search query.
|
10306
|
+
# Defaults to Mode.AUTO.
|
10114
10307
|
# Corresponds to the JSON property `mode`
|
10115
10308
|
# @return [String]
|
10116
10309
|
attr_accessor :mode
|
@@ -10188,7 +10381,7 @@ module Google
|
|
10188
10381
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult>]
|
10189
10382
|
attr_accessor :results
|
10190
10383
|
|
10191
|
-
# Summary of the top N search
|
10384
|
+
# Summary of the top N search results specified by the summary spec.
|
10192
10385
|
# Corresponds to the JSON property `summary`
|
10193
10386
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummary]
|
10194
10387
|
attr_accessor :summary
|
@@ -10231,8 +10424,8 @@ module Google
|
|
10231
10424
|
attr_accessor :dynamic_facet
|
10232
10425
|
alias_method :dynamic_facet?, :dynamic_facet
|
10233
10426
|
|
10234
|
-
# The key for this facet.
|
10235
|
-
# FacetSpec.FacetKey.key.
|
10427
|
+
# The key for this facet. For example, `"colors"` or `"price"`. It matches
|
10428
|
+
# SearchRequest.FacetSpec.FacetKey.key.
|
10236
10429
|
# Corresponds to the JSON property `key`
|
10237
10430
|
# @return [String]
|
10238
10431
|
attr_accessor :key
|
@@ -10341,12 +10534,12 @@ module Google
|
|
10341
10534
|
class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute
|
10342
10535
|
include Google::Apis::Core::Hashable
|
10343
10536
|
|
10344
|
-
# Attribute key used to refine the results
|
10537
|
+
# Attribute key used to refine the results. For example, `"movie_type"`.
|
10345
10538
|
# Corresponds to the JSON property `attributeKey`
|
10346
10539
|
# @return [String]
|
10347
10540
|
attr_accessor :attribute_key
|
10348
10541
|
|
10349
|
-
# Attribute value used to refine the results
|
10542
|
+
# Attribute value used to refine the results. For example, `"drama"`.
|
10350
10543
|
# Corresponds to the JSON property `attributeValue`
|
10351
10544
|
# @return [String]
|
10352
10545
|
attr_accessor :attribute_value
|
@@ -10422,7 +10615,7 @@ module Google
|
|
10422
10615
|
end
|
10423
10616
|
end
|
10424
10617
|
|
10425
|
-
# Summary of the top N search
|
10618
|
+
# Summary of the top N search results specified by the summary spec.
|
10426
10619
|
class GoogleCloudDiscoveryengineV1betaSearchResponseSummary
|
10427
10620
|
include Google::Apis::Core::Hashable
|
10428
10621
|
|
@@ -10962,7 +11155,8 @@ module Google
|
|
10962
11155
|
class GoogleCloudDiscoveryengineV1betaSessionTurn
|
10963
11156
|
include Google::Apis::Core::Hashable
|
10964
11157
|
|
10965
|
-
# The resource name of the answer to the user query.
|
11158
|
+
# The resource name of the answer to the user query. Only set if the answer
|
11159
|
+
# generation (/answer API call) happened in this turn.
|
10966
11160
|
# Corresponds to the JSON property `answer`
|
10967
11161
|
# @return [String]
|
10968
11162
|
attr_accessor :answer
|
@@ -11148,6 +11342,11 @@ module Google
|
|
11148
11342
|
# @return [String]
|
11149
11343
|
attr_accessor :provided_uri_pattern
|
11150
11344
|
|
11345
|
+
# Output only. Root domain of the provided_uri_pattern.
|
11346
|
+
# Corresponds to the JSON property `rootDomainUri`
|
11347
|
+
# @return [String]
|
11348
|
+
attr_accessor :root_domain_uri
|
11349
|
+
|
11151
11350
|
# Verification information for target sites in advanced site search.
|
11152
11351
|
# Corresponds to the JSON property `siteVerificationInfo`
|
11153
11352
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo]
|
@@ -11176,6 +11375,7 @@ module Google
|
|
11176
11375
|
@indexing_status = args[:indexing_status] if args.key?(:indexing_status)
|
11177
11376
|
@name = args[:name] if args.key?(:name)
|
11178
11377
|
@provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
|
11378
|
+
@root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
|
11179
11379
|
@site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
|
11180
11380
|
@type = args[:type] if args.key?(:type)
|
11181
11381
|
@update_time = args[:update_time] if args.key?(:update_time)
|
@@ -11287,6 +11487,11 @@ module Google
|
|
11287
11487
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput]
|
11288
11488
|
attr_accessor :gcs_training_input
|
11289
11489
|
|
11490
|
+
# If not provided, a UUID will be generated.
|
11491
|
+
# Corresponds to the JSON property `modelId`
|
11492
|
+
# @return [String]
|
11493
|
+
attr_accessor :model_id
|
11494
|
+
|
11290
11495
|
# Model to be trained. Supported values are: * **search-tuning**: Fine tuning
|
11291
11496
|
# the search system based on data provided.
|
11292
11497
|
# Corresponds to the JSON property `modelType`
|
@@ -11301,6 +11506,7 @@ module Google
|
|
11301
11506
|
def update!(**args)
|
11302
11507
|
@error_config = args[:error_config] if args.key?(:error_config)
|
11303
11508
|
@gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
|
11509
|
+
@model_id = args[:model_id] if args.key?(:model_id)
|
11304
11510
|
@model_type = args[:model_type] if args.key?(:model_type)
|
11305
11511
|
end
|
11306
11512
|
end
|
@@ -11374,6 +11580,11 @@ module Google
|
|
11374
11580
|
# @return [Hash<String,Float>]
|
11375
11581
|
attr_accessor :metrics
|
11376
11582
|
|
11583
|
+
# Fully qualified name of the CustomTuningModel.
|
11584
|
+
# Corresponds to the JSON property `modelName`
|
11585
|
+
# @return [String]
|
11586
|
+
attr_accessor :model_name
|
11587
|
+
|
11377
11588
|
# The trained model status. Possible values are: * **bad-data**: The training
|
11378
11589
|
# data quality is bad. * **no-improvement**: Tuning didn't improve performance.
|
11379
11590
|
# Won't deploy. * **in-progress**: Model training job creation is in progress. *
|
@@ -11393,6 +11604,7 @@ module Google
|
|
11393
11604
|
@error_config = args[:error_config] if args.key?(:error_config)
|
11394
11605
|
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
11395
11606
|
@metrics = args[:metrics] if args.key?(:metrics)
|
11607
|
+
@model_name = args[:model_name] if args.key?(:model_name)
|
11396
11608
|
@model_status = args[:model_status] if args.key?(:model_status)
|
11397
11609
|
end
|
11398
11610
|
end
|
@@ -11559,7 +11771,7 @@ module Google
|
|
11559
11771
|
end
|
11560
11772
|
|
11561
11773
|
# UserEvent captures all metadata information Discovery Engine API needs to know
|
11562
|
-
# about how end users interact with
|
11774
|
+
# about how end users interact with your website.
|
11563
11775
|
class GoogleCloudDiscoveryengineV1betaUserEvent
|
11564
11776
|
include Google::Apis::Core::Hashable
|
11565
11777
|
|
@@ -11698,7 +11910,7 @@ module Google
|
|
11698
11910
|
|
11699
11911
|
# A list of identifiers for the independent experiment groups this user event
|
11700
11912
|
# belongs to. This is used to distinguish between user events associated with
|
11701
|
-
# different experiment setups
|
11913
|
+
# different experiment setups.
|
11702
11914
|
# Corresponds to the JSON property `tagIds`
|
11703
11915
|
# @return [Array<String>]
|
11704
11916
|
attr_accessor :tag_ids
|
@@ -11788,6 +12000,19 @@ module Google
|
|
11788
12000
|
end
|
11789
12001
|
end
|
11790
12002
|
|
12003
|
+
# The request message for Operations.CancelOperation.
|
12004
|
+
class GoogleLongrunningCancelOperationRequest
|
12005
|
+
include Google::Apis::Core::Hashable
|
12006
|
+
|
12007
|
+
def initialize(**args)
|
12008
|
+
update!(**args)
|
12009
|
+
end
|
12010
|
+
|
12011
|
+
# Update properties of this object
|
12012
|
+
def update!(**args)
|
12013
|
+
end
|
12014
|
+
end
|
12015
|
+
|
11791
12016
|
# The response message for Operations.ListOperations.
|
11792
12017
|
class GoogleLongrunningListOperationsResponse
|
11793
12018
|
include Google::Apis::Core::Hashable
|