google-apis-discoveryengine_v1 0.10.0 → 0.12.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1861b8ceb2fc3bbef20c94dfa880d117634736ba3db00f4402ab5a9ca2acd689
4
- data.tar.gz: e545831cdddfa27c2def75c6428ba49113f235fea41fe48b7801ede6dbf04f73
3
+ metadata.gz: 6330c29a724e9eaebfc878f9f381ac2024db4004d5935a82f257a78d527ac8e6
4
+ data.tar.gz: cc454bf1ecfa37b14bcbc57139d9f0148dccd49e1d6b4d562c54f1ba584e5962
5
5
  SHA512:
6
- metadata.gz: 5dd35d46c5eb6cf62d379928326fe3e44434866b5ab6128d306e1eb8e82a54941519e11c10b6eadcab6b64d6b38df2d8b06f8926c4bb9b13b4c2919f1c1c0edb
7
- data.tar.gz: 43f5cb184e5171a86f19545d1d76268cfd81bb5d992588b107c3b5bdb9c7ba16ecc8e951fc47d5b4e89ec66ffe5761f5328bbc58ef830588122ea0cf97d8339f
6
+ metadata.gz: 6572d86d268bbcacc0bc6250075a37dd2204cd48195cae206966855d55e4e084759de6ba745db94c46c7236ab2a9dbea7a94d0414dfef5f63e357118e3e6bc7b
7
+ data.tar.gz: d1af9cf1258319f787b1d3ff72119442b05b7f9b85fc8c5812ee4c3b0b0a326dfff8dc34cad18f5eeb70391ffda5701c6d4d26990e8a090a9a2237560802c68b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1
2
2
 
3
+ ### v0.12.0 (2024-08-18)
4
+
5
+ * Regenerated from discovery document revision 20240813
6
+
7
+ ### v0.11.0 (2024-08-11)
8
+
9
+ * Regenerated from discovery document revision 20240801
10
+
3
11
  ### v0.10.0 (2024-08-04)
4
12
 
5
13
  * Regenerated from discovery document revision 20240729
@@ -307,7 +307,7 @@ module Google
307
307
  # @return [String]
308
308
  attr_accessor :location_id
309
309
 
310
- # The project ID that the AlloyDB source is in with a length limit of 128
310
+ # The project ID that contains the AlloyDB source. Has a length limit of 128
311
311
  # characters. If not specified, inherits the project ID from the parent request.
312
312
  # Corresponds to the JSON property `projectId`
313
313
  # @return [String]
@@ -1648,6 +1648,75 @@ module Google
1648
1648
  end
1649
1649
  end
1650
1650
 
1651
+ # Response message for DocumentService.BatchGetDocumentsMetadata method.
1652
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
1653
+ include Google::Apis::Core::Hashable
1654
+
1655
+ # The metadata of the Documents.
1656
+ # Corresponds to the JSON property `documentsMetadata`
1657
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata>]
1658
+ attr_accessor :documents_metadata
1659
+
1660
+ def initialize(**args)
1661
+ update!(**args)
1662
+ end
1663
+
1664
+ # Update properties of this object
1665
+ def update!(**args)
1666
+ @documents_metadata = args[:documents_metadata] if args.key?(:documents_metadata)
1667
+ end
1668
+ end
1669
+
1670
+ # The metadata of a Document.
1671
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata
1672
+ include Google::Apis::Core::Hashable
1673
+
1674
+ # The timestamp of the last time the Document was last indexed.
1675
+ # Corresponds to the JSON property `lastRefreshedTime`
1676
+ # @return [String]
1677
+ attr_accessor :last_refreshed_time
1678
+
1679
+ # The value of the matcher that was used to match the Document.
1680
+ # Corresponds to the JSON property `matcherValue`
1681
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue]
1682
+ attr_accessor :matcher_value
1683
+
1684
+ # The status of the document.
1685
+ # Corresponds to the JSON property `status`
1686
+ # @return [String]
1687
+ attr_accessor :status
1688
+
1689
+ def initialize(**args)
1690
+ update!(**args)
1691
+ end
1692
+
1693
+ # Update properties of this object
1694
+ def update!(**args)
1695
+ @last_refreshed_time = args[:last_refreshed_time] if args.key?(:last_refreshed_time)
1696
+ @matcher_value = args[:matcher_value] if args.key?(:matcher_value)
1697
+ @status = args[:status] if args.key?(:status)
1698
+ end
1699
+ end
1700
+
1701
+ # The value of the matcher that was used to match the Document.
1702
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue
1703
+ include Google::Apis::Core::Hashable
1704
+
1705
+ # If match by URI, the URI of the Document.
1706
+ # Corresponds to the JSON property `uri`
1707
+ # @return [String]
1708
+ attr_accessor :uri
1709
+
1710
+ def initialize(**args)
1711
+ update!(**args)
1712
+ end
1713
+
1714
+ # Update properties of this object
1715
+ def update!(**args)
1716
+ @uri = args[:uri] if args.key?(:uri)
1717
+ end
1718
+ end
1719
+
1651
1720
  # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
1652
1721
  class GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest
1653
1722
  include Google::Apis::Core::Hashable
@@ -1701,7 +1770,7 @@ module Google
1701
1770
  # @return [Google::Apis::DiscoveryengineV1::GoogleTypeDate]
1702
1771
  attr_accessor :partition_date
1703
1772
 
1704
- # The project ID (can be project # or ID) that the BigQuery source is in with a
1773
+ # The project ID or the project number that contains the BigQuery source. Has a
1705
1774
  # length limit of 128 characters. If not specified, inherits the project ID from
1706
1775
  # the parent request.
1707
1776
  # Corresponds to the JSON property `projectId`
@@ -1866,7 +1935,7 @@ module Google
1866
1935
  # @return [String]
1867
1936
  attr_accessor :instance_id
1868
1937
 
1869
- # The project ID that the Bigtable source is in with a length limit of 128
1938
+ # The project ID that contains the Bigtable source. Has a length limit of 128
1870
1939
  # characters. If not specified, inherits the project ID from the parent request.
1871
1940
  # Corresponds to the JSON property `projectId`
1872
1941
  # @return [String]
@@ -2003,6 +2072,11 @@ module Google
2003
2072
  attr_accessor :grounding_check_required
2004
2073
  alias_method :grounding_check_required?, :grounding_check_required
2005
2074
 
2075
+ # Confidence score for the claim in the answer candidate, in the range of [0, 1].
2076
+ # Corresponds to the JSON property `score`
2077
+ # @return [Float]
2078
+ attr_accessor :score
2079
+
2006
2080
  # Position indicating the start of the claim in the answer candidate, measured
2007
2081
  # in bytes.
2008
2082
  # Corresponds to the JSON property `startPos`
@@ -2019,6 +2093,7 @@ module Google
2019
2093
  @claim_text = args[:claim_text] if args.key?(:claim_text)
2020
2094
  @end_pos = args[:end_pos] if args.key?(:end_pos)
2021
2095
  @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
2096
+ @score = args[:score] if args.key?(:score)
2022
2097
  @start_pos = args[:start_pos] if args.key?(:start_pos)
2023
2098
  end
2024
2099
  end
@@ -2236,7 +2311,7 @@ module Google
2236
2311
  attr_accessor :offload
2237
2312
  alias_method :offload?, :offload
2238
2313
 
2239
- # The project ID that the Cloud SQL source is in with a length limit of 128
2314
+ # The project ID that contains the Cloud SQL source. Has a length limit of 128
2240
2315
  # characters. If not specified, inherits the project ID from the parent request.
2241
2316
  # Corresponds to the JSON property `projectId`
2242
2317
  # @return [String]
@@ -2490,7 +2565,7 @@ module Google
2490
2565
  class GoogleCloudDiscoveryengineV1Control
2491
2566
  include Google::Apis::Core::Hashable
2492
2567
 
2493
- # Output only. List of all ServingConfig ids this control is attached to. May
2568
+ # Output only. List of all ServingConfig IDs this control is attached to. May
2494
2569
  # take up to 10 minutes to update after changes.
2495
2570
  # Corresponds to the JSON property `associatedServingConfigIds`
2496
2571
  # @return [Array<String>]
@@ -3075,6 +3150,64 @@ module Google
3075
3150
  end
3076
3151
  end
3077
3152
 
3153
+ # Metadata that describes a custom tuned model.
3154
+ class GoogleCloudDiscoveryengineV1CustomTuningModel
3155
+ include Google::Apis::Core::Hashable
3156
+
3157
+ # Timestamp the Model was created at.
3158
+ # Corresponds to the JSON property `createTime`
3159
+ # @return [String]
3160
+ attr_accessor :create_time
3161
+
3162
+ # The display name of the model.
3163
+ # Corresponds to the JSON property `displayName`
3164
+ # @return [String]
3165
+ attr_accessor :display_name
3166
+
3167
+ # The metrics of the trained model.
3168
+ # Corresponds to the JSON property `metrics`
3169
+ # @return [Hash<String,Float>]
3170
+ attr_accessor :metrics
3171
+
3172
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
3173
+ # Corresponds to the JSON property `modelState`
3174
+ # @return [String]
3175
+ attr_accessor :model_state
3176
+
3177
+ # The version of the model.
3178
+ # Corresponds to the JSON property `modelVersion`
3179
+ # @return [Fixnum]
3180
+ attr_accessor :model_version
3181
+
3182
+ # Required. The fully qualified resource name of the model. Format: `projects/`
3183
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
3184
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
3185
+ # numerical string with limit of 40 characters.
3186
+ # Corresponds to the JSON property `name`
3187
+ # @return [String]
3188
+ attr_accessor :name
3189
+
3190
+ # Timestamp the model training was initiated.
3191
+ # Corresponds to the JSON property `trainingStartTime`
3192
+ # @return [String]
3193
+ attr_accessor :training_start_time
3194
+
3195
+ def initialize(**args)
3196
+ update!(**args)
3197
+ end
3198
+
3199
+ # Update properties of this object
3200
+ def update!(**args)
3201
+ @create_time = args[:create_time] if args.key?(:create_time)
3202
+ @display_name = args[:display_name] if args.key?(:display_name)
3203
+ @metrics = args[:metrics] if args.key?(:metrics)
3204
+ @model_state = args[:model_state] if args.key?(:model_state)
3205
+ @model_version = args[:model_version] if args.key?(:model_version)
3206
+ @name = args[:name] if args.key?(:name)
3207
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
3208
+ end
3209
+ end
3210
+
3078
3211
  # DataStore captures global settings and configs at the DataStore level.
3079
3212
  class GoogleCloudDiscoveryengineV1DataStore
3080
3213
  include Google::Apis::Core::Hashable
@@ -3135,6 +3268,11 @@ module Google
3135
3268
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema]
3136
3269
  attr_accessor :starting_schema
3137
3270
 
3271
+ # Config to store data store type configuration for workspace data
3272
+ # Corresponds to the JSON property `workspaceConfig`
3273
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WorkspaceConfig]
3274
+ attr_accessor :workspace_config
3275
+
3138
3276
  def initialize(**args)
3139
3277
  update!(**args)
3140
3278
  end
@@ -3150,6 +3288,7 @@ module Google
3150
3288
  @name = args[:name] if args.key?(:name)
3151
3289
  @solution_types = args[:solution_types] if args.key?(:solution_types)
3152
3290
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
3291
+ @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
3153
3292
  end
3154
3293
  end
3155
3294
 
@@ -3449,6 +3588,12 @@ module Google
3449
3588
  # @return [String]
3450
3589
  attr_accessor :id
3451
3590
 
3591
+ # Output only. Whether the referenced Document can be found in the data store.
3592
+ # Corresponds to the JSON property `joined`
3593
+ # @return [Boolean]
3594
+ attr_accessor :joined
3595
+ alias_method :joined?, :joined
3596
+
3452
3597
  # The Document resource full name, of the form: `projects/`project_id`/locations/
3453
3598
  # `location`/collections/`collection_id`/dataStores/`data_store_id`/branches/`
3454
3599
  # branch_id`/documents/`document_id``
@@ -3482,6 +3627,7 @@ module Google
3482
3627
  # Update properties of this object
3483
3628
  def update!(**args)
3484
3629
  @id = args[:id] if args.key?(:id)
3630
+ @joined = args[:joined] if args.key?(:joined)
3485
3631
  @name = args[:name] if args.key?(:name)
3486
3632
  @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
3487
3633
  @quantity = args[:quantity] if args.key?(:quantity)
@@ -3517,7 +3663,9 @@ module Google
3517
3663
  # Override parsing config for HTML files, only digital parsing and layout
3518
3664
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
3519
3665
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
3520
- # config for PPTX files, only digital parsing and layout parsing are supported.
3666
+ # config for PPTX files, only digital parsing and layout parsing are supported. *
3667
+ # `xlsx`: Override parsing config for XLSX files, only digital parsing and
3668
+ # layout parsing are supported.
3521
3669
  # Corresponds to the JSON property `parsingConfigOverrides`
3522
3670
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig>]
3523
3671
  attr_accessor :parsing_config_overrides
@@ -4053,6 +4201,14 @@ module Google
4053
4201
  # @return [String]
4054
4202
  attr_accessor :gcs_staging_dir
4055
4203
 
4204
+ # The FHIR resource types to import. The resource types should be a subset of
4205
+ # all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-
4206
+ # builder/docs/fhir-schema-reference#resource-level-specification). Default to
4207
+ # all supported FHIR resource types if empty.
4208
+ # Corresponds to the JSON property `resourceTypes`
4209
+ # @return [Array<String>]
4210
+ attr_accessor :resource_types
4211
+
4056
4212
  def initialize(**args)
4057
4213
  update!(**args)
4058
4214
  end
@@ -4061,6 +4217,7 @@ module Google
4061
4217
  def update!(**args)
4062
4218
  @fhir_store = args[:fhir_store] if args.key?(:fhir_store)
4063
4219
  @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
4220
+ @resource_types = args[:resource_types] if args.key?(:resource_types)
4064
4221
  end
4065
4222
  end
4066
4223
 
@@ -4857,6 +5014,25 @@ module Google
4857
5014
  end
4858
5015
  end
4859
5016
 
5017
+ # Response message for SearchTuningService.ListCustomModels method.
5018
+ class GoogleCloudDiscoveryengineV1ListCustomModelsResponse
5019
+ include Google::Apis::Core::Hashable
5020
+
5021
+ # List of custom tuning models.
5022
+ # Corresponds to the JSON property `models`
5023
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CustomTuningModel>]
5024
+ attr_accessor :models
5025
+
5026
+ def initialize(**args)
5027
+ update!(**args)
5028
+ end
5029
+
5030
+ # Update properties of this object
5031
+ def update!(**args)
5032
+ @models = args[:models] if args.key?(:models)
5033
+ end
5034
+ end
5035
+
4860
5036
  # Response message for DataStoreService.ListDataStores method.
4861
5037
  class GoogleCloudDiscoveryengineV1ListDataStoresResponse
4862
5038
  include Google::Apis::Core::Hashable
@@ -7589,7 +7765,7 @@ module Google
7589
7765
  # @return [String]
7590
7766
  attr_accessor :instance_id
7591
7767
 
7592
- # The project ID that the Spanner source is in with a length limit of 128
7768
+ # The project ID that contains the Spanner source. Has a length limit of 128
7593
7769
  # characters. If not specified, inherits the project ID from the parent request.
7594
7770
  # Corresponds to the JSON property `projectId`
7595
7771
  # @return [String]
@@ -7790,6 +7966,169 @@ module Google
7790
7966
  end
7791
7967
  end
7792
7968
 
7969
+ # Metadata related to the progress of the TrainCustomModel operation. This is
7970
+ # returned by the google.longrunning.Operation.metadata field.
7971
+ class GoogleCloudDiscoveryengineV1TrainCustomModelMetadata
7972
+ include Google::Apis::Core::Hashable
7973
+
7974
+ # Operation create time.
7975
+ # Corresponds to the JSON property `createTime`
7976
+ # @return [String]
7977
+ attr_accessor :create_time
7978
+
7979
+ # Operation last update time. If the operation is done, this is also the finish
7980
+ # time.
7981
+ # Corresponds to the JSON property `updateTime`
7982
+ # @return [String]
7983
+ attr_accessor :update_time
7984
+
7985
+ def initialize(**args)
7986
+ update!(**args)
7987
+ end
7988
+
7989
+ # Update properties of this object
7990
+ def update!(**args)
7991
+ @create_time = args[:create_time] if args.key?(:create_time)
7992
+ @update_time = args[:update_time] if args.key?(:update_time)
7993
+ end
7994
+ end
7995
+
7996
+ # Request message for SearchTuningService.TrainCustomModel method.
7997
+ class GoogleCloudDiscoveryengineV1TrainCustomModelRequest
7998
+ include Google::Apis::Core::Hashable
7999
+
8000
+ # Configuration of destination for Import related errors.
8001
+ # Corresponds to the JSON property `errorConfig`
8002
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
8003
+ attr_accessor :error_config
8004
+
8005
+ # Cloud Storage training data input.
8006
+ # Corresponds to the JSON property `gcsTrainingInput`
8007
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput]
8008
+ attr_accessor :gcs_training_input
8009
+
8010
+ # If not provided, a UUID will be generated.
8011
+ # Corresponds to the JSON property `modelId`
8012
+ # @return [String]
8013
+ attr_accessor :model_id
8014
+
8015
+ # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
8016
+ # the search system based on data provided.
8017
+ # Corresponds to the JSON property `modelType`
8018
+ # @return [String]
8019
+ attr_accessor :model_type
8020
+
8021
+ def initialize(**args)
8022
+ update!(**args)
8023
+ end
8024
+
8025
+ # Update properties of this object
8026
+ def update!(**args)
8027
+ @error_config = args[:error_config] if args.key?(:error_config)
8028
+ @gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
8029
+ @model_id = args[:model_id] if args.key?(:model_id)
8030
+ @model_type = args[:model_type] if args.key?(:model_type)
8031
+ end
8032
+ end
8033
+
8034
+ # Cloud Storage training data input.
8035
+ class GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput
8036
+ include Google::Apis::Core::Hashable
8037
+
8038
+ # The Cloud Storage corpus data which could be associated in train data. The
8039
+ # data path format is `gs:///`. A newline delimited jsonl/ndjson file. For
8040
+ # search-tuning model, each line should have the _id, title and text. Example: ``
8041
+ # "_id": "doc1", title: "relevant doc", "text": "relevant text"``
8042
+ # Corresponds to the JSON property `corpusDataPath`
8043
+ # @return [String]
8044
+ attr_accessor :corpus_data_path
8045
+
8046
+ # The gcs query data which could be associated in train data. The data path
8047
+ # format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning
8048
+ # model, each line should have the _id and text. Example: `"_id": "query1", "
8049
+ # text": "example query"`
8050
+ # Corresponds to the JSON property `queryDataPath`
8051
+ # @return [String]
8052
+ attr_accessor :query_data_path
8053
+
8054
+ # Cloud Storage test data. Same format as train_data_path. If not provided, a
8055
+ # random 80/20 train/test split will be performed on train_data_path.
8056
+ # Corresponds to the JSON property `testDataPath`
8057
+ # @return [String]
8058
+ attr_accessor :test_data_path
8059
+
8060
+ # Cloud Storage training data path whose format should be `gs:///`. The file
8061
+ # should be in tsv format. Each line should have the doc_id and query_id and
8062
+ # score (number). For search-tuning model, it should have the query-id corpus-id
8063
+ # score as tsv file header. The score should be a number in `[0, inf+)`. The
8064
+ # larger the number is, the more relevant the pair is. Example: * `query-id\
8065
+ # tcorpus-id\tscore` * `query1\tdoc1\t1`
8066
+ # Corresponds to the JSON property `trainDataPath`
8067
+ # @return [String]
8068
+ attr_accessor :train_data_path
8069
+
8070
+ def initialize(**args)
8071
+ update!(**args)
8072
+ end
8073
+
8074
+ # Update properties of this object
8075
+ def update!(**args)
8076
+ @corpus_data_path = args[:corpus_data_path] if args.key?(:corpus_data_path)
8077
+ @query_data_path = args[:query_data_path] if args.key?(:query_data_path)
8078
+ @test_data_path = args[:test_data_path] if args.key?(:test_data_path)
8079
+ @train_data_path = args[:train_data_path] if args.key?(:train_data_path)
8080
+ end
8081
+ end
8082
+
8083
+ # Response of the TrainCustomModelRequest. This message is returned by the
8084
+ # google.longrunning.Operations.response field.
8085
+ class GoogleCloudDiscoveryengineV1TrainCustomModelResponse
8086
+ include Google::Apis::Core::Hashable
8087
+
8088
+ # Configuration of destination for Import related errors.
8089
+ # Corresponds to the JSON property `errorConfig`
8090
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig]
8091
+ attr_accessor :error_config
8092
+
8093
+ # A sample of errors encountered while processing the data.
8094
+ # Corresponds to the JSON property `errorSamples`
8095
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
8096
+ attr_accessor :error_samples
8097
+
8098
+ # The metrics of the trained model.
8099
+ # Corresponds to the JSON property `metrics`
8100
+ # @return [Hash<String,Float>]
8101
+ attr_accessor :metrics
8102
+
8103
+ # Fully qualified name of the CustomTuningModel.
8104
+ # Corresponds to the JSON property `modelName`
8105
+ # @return [String]
8106
+ attr_accessor :model_name
8107
+
8108
+ # The trained model status. Possible values are: * **bad-data**: The training
8109
+ # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
8110
+ # Won't deploy. * **in-progress**: Model training job creation is in progress. *
8111
+ # **training**: Model is actively training. * **evaluating**: The model is
8112
+ # evaluating trained metrics. * **indexing**: The model trained metrics are
8113
+ # indexing. * **ready**: The model is ready for serving.
8114
+ # Corresponds to the JSON property `modelStatus`
8115
+ # @return [String]
8116
+ attr_accessor :model_status
8117
+
8118
+ def initialize(**args)
8119
+ update!(**args)
8120
+ end
8121
+
8122
+ # Update properties of this object
8123
+ def update!(**args)
8124
+ @error_config = args[:error_config] if args.key?(:error_config)
8125
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
8126
+ @metrics = args[:metrics] if args.key?(:metrics)
8127
+ @model_name = args[:model_name] if args.key?(:model_name)
8128
+ @model_status = args[:model_status] if args.key?(:model_status)
8129
+ end
8130
+ end
8131
+
7793
8132
  # A transaction represents the entire purchase transaction.
7794
8133
  class GoogleCloudDiscoveryengineV1TransactionInfo
7795
8134
  include Google::Apis::Core::Hashable
@@ -8152,6 +8491,31 @@ module Google
8152
8491
  end
8153
8492
  end
8154
8493
 
8494
+ # Config to store data store type configuration for workspace data
8495
+ class GoogleCloudDiscoveryengineV1WorkspaceConfig
8496
+ include Google::Apis::Core::Hashable
8497
+
8498
+ # Obfuscated Dasher customer ID.
8499
+ # Corresponds to the JSON property `dasherCustomerId`
8500
+ # @return [String]
8501
+ attr_accessor :dasher_customer_id
8502
+
8503
+ # The Google Workspace data source.
8504
+ # Corresponds to the JSON property `type`
8505
+ # @return [String]
8506
+ attr_accessor :type
8507
+
8508
+ def initialize(**args)
8509
+ update!(**args)
8510
+ end
8511
+
8512
+ # Update properties of this object
8513
+ def update!(**args)
8514
+ @dasher_customer_id = args[:dasher_customer_id] if args.key?(:dasher_customer_id)
8515
+ @type = args[:type] if args.key?(:type)
8516
+ end
8517
+ end
8518
+
8155
8519
  # Access Control Configuration.
8156
8520
  class GoogleCloudDiscoveryengineV1alphaAclConfig
8157
8521
  include Google::Apis::Core::Hashable
@@ -8916,7 +9280,7 @@ module Google
8916
9280
  class GoogleCloudDiscoveryengineV1alphaControl
8917
9281
  include Google::Apis::Core::Hashable
8918
9282
 
8919
- # Output only. List of all ServingConfig ids this control is attached to. May
9283
+ # Output only. List of all ServingConfig IDs this control is attached to. May
8920
9284
  # take up to 10 minutes to update after changes.
8921
9285
  # Corresponds to the JSON property `associatedServingConfigIds`
8922
9286
  # @return [Array<String>]
@@ -9387,6 +9751,11 @@ module Google
9387
9751
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSchema]
9388
9752
  attr_accessor :starting_schema
9389
9753
 
9754
+ # Config to store data store type configuration for workspace data
9755
+ # Corresponds to the JSON property `workspaceConfig`
9756
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaWorkspaceConfig]
9757
+ attr_accessor :workspace_config
9758
+
9390
9759
  def initialize(**args)
9391
9760
  update!(**args)
9392
9761
  end
@@ -9405,6 +9774,7 @@ module Google
9405
9774
  @name = args[:name] if args.key?(:name)
9406
9775
  @solution_types = args[:solution_types] if args.key?(:solution_types)
9407
9776
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
9777
+ @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
9408
9778
  end
9409
9779
  end
9410
9780
 
@@ -9586,7 +9956,9 @@ module Google
9586
9956
  # Override parsing config for HTML files, only digital parsing and layout
9587
9957
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
9588
9958
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
9589
- # config for PPTX files, only digital parsing and layout parsing are supported.
9959
+ # config for PPTX files, only digital parsing and layout parsing are supported. *
9960
+ # `xlsx`: Override parsing config for XLSX files, only digital parsing and
9961
+ # layout parsing are supported.
9590
9962
  # Corresponds to the JSON property `parsingConfigOverrides`
9591
9963
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig>]
9592
9964
  attr_accessor :parsing_config_overrides
@@ -10333,59 +10705,6 @@ module Google
10333
10705
  end
10334
10706
  end
10335
10707
 
10336
- # Metadata related to the progress of the Export operation. This is returned by
10337
- # the google.longrunning.Operation.metadata field.
10338
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata
10339
- include Google::Apis::Core::Hashable
10340
-
10341
- # Operation create time.
10342
- # Corresponds to the JSON property `createTime`
10343
- # @return [String]
10344
- attr_accessor :create_time
10345
-
10346
- # Operation last update time. If the operation is done, this is also the finish
10347
- # time.
10348
- # Corresponds to the JSON property `updateTime`
10349
- # @return [String]
10350
- attr_accessor :update_time
10351
-
10352
- def initialize(**args)
10353
- update!(**args)
10354
- end
10355
-
10356
- # Update properties of this object
10357
- def update!(**args)
10358
- @create_time = args[:create_time] if args.key?(:create_time)
10359
- @update_time = args[:update_time] if args.key?(:update_time)
10360
- end
10361
- end
10362
-
10363
- # Response of the ExportUserEventsRequest. If the long running operation was
10364
- # successful, then this message is returned by the google.longrunning.Operations.
10365
- # response field.
10366
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
10367
- include Google::Apis::Core::Hashable
10368
-
10369
- # The `Status` type defines a logical error model that is suitable for different
10370
- # programming environments, including REST APIs and RPC APIs. It is used by [
10371
- # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10372
- # data: error code, error message, and error details. You can find out more
10373
- # about this error model and how to work with it in the [API Design Guide](https:
10374
- # //cloud.google.com/apis/design/errors).
10375
- # Corresponds to the JSON property `status`
10376
- # @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
10377
- attr_accessor :status
10378
-
10379
- def initialize(**args)
10380
- update!(**args)
10381
- end
10382
-
10383
- # Update properties of this object
10384
- def update!(**args)
10385
- @status = args[:status] if args.key?(:status)
10386
- end
10387
- end
10388
-
10389
10708
  # Configurations for fields of a schema. For example, configuring a field is
10390
10709
  # indexable, or searchable.
10391
10710
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -13301,6 +13620,31 @@ module Google
13301
13620
  end
13302
13621
  end
13303
13622
 
13623
+ # Config to store data store type configuration for workspace data
13624
+ class GoogleCloudDiscoveryengineV1alphaWorkspaceConfig
13625
+ include Google::Apis::Core::Hashable
13626
+
13627
+ # Obfuscated Dasher customer ID.
13628
+ # Corresponds to the JSON property `dasherCustomerId`
13629
+ # @return [String]
13630
+ attr_accessor :dasher_customer_id
13631
+
13632
+ # The Google Workspace data source.
13633
+ # Corresponds to the JSON property `type`
13634
+ # @return [String]
13635
+ attr_accessor :type
13636
+
13637
+ def initialize(**args)
13638
+ update!(**args)
13639
+ end
13640
+
13641
+ # Update properties of this object
13642
+ def update!(**args)
13643
+ @dasher_customer_id = args[:dasher_customer_id] if args.key?(:dasher_customer_id)
13644
+ @type = args[:type] if args.key?(:type)
13645
+ end
13646
+ end
13647
+
13304
13648
  # Metadata related to the progress of the SiteSearchEngineService.
13305
13649
  # BatchCreateTargetSites operation. This will be returned by the google.
13306
13650
  # longrunning.Operation.metadata field.
@@ -13433,7 +13777,7 @@ module Google
13433
13777
  class GoogleCloudDiscoveryengineV1betaControl
13434
13778
  include Google::Apis::Core::Hashable
13435
13779
 
13436
- # Output only. List of all ServingConfig ids this control is attached to. May
13780
+ # Output only. List of all ServingConfig IDs this control is attached to. May
13437
13781
  # take up to 10 minutes to update after changes.
13438
13782
  # Corresponds to the JSON property `associatedServingConfigIds`
13439
13783
  # @return [Array<String>]
@@ -13868,6 +14212,11 @@ module Google
13868
14212
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSchema]
13869
14213
  attr_accessor :starting_schema
13870
14214
 
14215
+ # Config to store data store type configuration for workspace data
14216
+ # Corresponds to the JSON property `workspaceConfig`
14217
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaWorkspaceConfig]
14218
+ attr_accessor :workspace_config
14219
+
13871
14220
  def initialize(**args)
13872
14221
  update!(**args)
13873
14222
  end
@@ -13884,6 +14233,7 @@ module Google
13884
14233
  @name = args[:name] if args.key?(:name)
13885
14234
  @solution_types = args[:solution_types] if args.key?(:solution_types)
13886
14235
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
14236
+ @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
13887
14237
  end
13888
14238
  end
13889
14239
 
@@ -14065,7 +14415,9 @@ module Google
14065
14415
  # Override parsing config for HTML files, only digital parsing and layout
14066
14416
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
14067
14417
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
14068
- # config for PPTX files, only digital parsing and layout parsing are supported.
14418
+ # config for PPTX files, only digital parsing and layout parsing are supported. *
14419
+ # `xlsx`: Override parsing config for XLSX files, only digital parsing and
14420
+ # layout parsing are supported.
14069
14421
  # Corresponds to the JSON property `parsingConfigOverrides`
14070
14422
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig>]
14071
14423
  attr_accessor :parsing_config_overrides
@@ -15591,6 +15943,13 @@ module Google
15591
15943
  # @return [String]
15592
15944
  attr_accessor :region_code
15593
15945
 
15946
+ # The relevance threshold of the search results. Default to Google defined
15947
+ # threshold, leveraging a balance of precision and recall to deliver both highly
15948
+ # accurate results and comprehensive coverage of relevant information.
15949
+ # Corresponds to the JSON property `relevanceThreshold`
15950
+ # @return [String]
15951
+ attr_accessor :relevance_threshold
15952
+
15594
15953
  # Whether to turn on safe search. This is only supported for website search.
15595
15954
  # Corresponds to the JSON property `safeSearch`
15596
15955
  # @return [Boolean]
@@ -15703,6 +16062,7 @@ module Google
15703
16062
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
15704
16063
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
15705
16064
  @region_code = args[:region_code] if args.key?(:region_code)
16065
+ @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
15706
16066
  @safe_search = args[:safe_search] if args.key?(:safe_search)
15707
16067
  @search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec)
15708
16068
  @serving_config = args[:serving_config] if args.key?(:serving_config)
@@ -16911,6 +17271,31 @@ module Google
16911
17271
  end
16912
17272
  end
16913
17273
 
17274
+ # Config to store data store type configuration for workspace data
17275
+ class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
17276
+ include Google::Apis::Core::Hashable
17277
+
17278
+ # Obfuscated Dasher customer ID.
17279
+ # Corresponds to the JSON property `dasherCustomerId`
17280
+ # @return [String]
17281
+ attr_accessor :dasher_customer_id
17282
+
17283
+ # The Google Workspace data source.
17284
+ # Corresponds to the JSON property `type`
17285
+ # @return [String]
17286
+ attr_accessor :type
17287
+
17288
+ def initialize(**args)
17289
+ update!(**args)
17290
+ end
17291
+
17292
+ # Update properties of this object
17293
+ def update!(**args)
17294
+ @dasher_customer_id = args[:dasher_customer_id] if args.key?(:dasher_customer_id)
17295
+ @type = args[:type] if args.key?(:type)
17296
+ end
17297
+ end
17298
+
16914
17299
  # The request message for Operations.CancelOperation.
16915
17300
  class GoogleLongrunningCancelOperationRequest
16916
17301
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1
18
18
  # Version of the google-apis-discoveryengine_v1 gem
19
- GEM_VERSION = "0.10.0"
19
+ GEM_VERSION = "0.12.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240729"
25
+ REVISION = "20240813"
26
26
  end
27
27
  end
28
28
  end
@@ -310,6 +310,24 @@ module Google
310
310
  include Google::Apis::Core::JsonObjectSupport
311
311
  end
312
312
 
313
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
314
+ class Representation < Google::Apis::Core::JsonRepresentation; end
315
+
316
+ include Google::Apis::Core::JsonObjectSupport
317
+ end
318
+
319
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata
320
+ class Representation < Google::Apis::Core::JsonRepresentation; end
321
+
322
+ include Google::Apis::Core::JsonObjectSupport
323
+ end
324
+
325
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue
326
+ class Representation < Google::Apis::Core::JsonRepresentation; end
327
+
328
+ include Google::Apis::Core::JsonObjectSupport
329
+ end
330
+
313
331
  class GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest
314
332
  class Representation < Google::Apis::Core::JsonRepresentation; end
315
333
 
@@ -538,6 +556,12 @@ module Google
538
556
  include Google::Apis::Core::JsonObjectSupport
539
557
  end
540
558
 
559
+ class GoogleCloudDiscoveryengineV1CustomTuningModel
560
+ class Representation < Google::Apis::Core::JsonRepresentation; end
561
+
562
+ include Google::Apis::Core::JsonObjectSupport
563
+ end
564
+
541
565
  class GoogleCloudDiscoveryengineV1DataStore
542
566
  class Representation < Google::Apis::Core::JsonRepresentation; end
543
567
 
@@ -856,6 +880,12 @@ module Google
856
880
  include Google::Apis::Core::JsonObjectSupport
857
881
  end
858
882
 
883
+ class GoogleCloudDiscoveryengineV1ListCustomModelsResponse
884
+ class Representation < Google::Apis::Core::JsonRepresentation; end
885
+
886
+ include Google::Apis::Core::JsonObjectSupport
887
+ end
888
+
859
889
  class GoogleCloudDiscoveryengineV1ListDataStoresResponse
860
890
  class Representation < Google::Apis::Core::JsonRepresentation; end
861
891
 
@@ -1324,6 +1354,30 @@ module Google
1324
1354
  include Google::Apis::Core::JsonObjectSupport
1325
1355
  end
1326
1356
 
1357
+ class GoogleCloudDiscoveryengineV1TrainCustomModelMetadata
1358
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1359
+
1360
+ include Google::Apis::Core::JsonObjectSupport
1361
+ end
1362
+
1363
+ class GoogleCloudDiscoveryengineV1TrainCustomModelRequest
1364
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1365
+
1366
+ include Google::Apis::Core::JsonObjectSupport
1367
+ end
1368
+
1369
+ class GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput
1370
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1371
+
1372
+ include Google::Apis::Core::JsonObjectSupport
1373
+ end
1374
+
1375
+ class GoogleCloudDiscoveryengineV1TrainCustomModelResponse
1376
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1377
+
1378
+ include Google::Apis::Core::JsonObjectSupport
1379
+ end
1380
+
1327
1381
  class GoogleCloudDiscoveryengineV1TransactionInfo
1328
1382
  class Representation < Google::Apis::Core::JsonRepresentation; end
1329
1383
 
@@ -1354,6 +1408,12 @@ module Google
1354
1408
  include Google::Apis::Core::JsonObjectSupport
1355
1409
  end
1356
1410
 
1411
+ class GoogleCloudDiscoveryengineV1WorkspaceConfig
1412
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1413
+
1414
+ include Google::Apis::Core::JsonObjectSupport
1415
+ end
1416
+
1357
1417
  class GoogleCloudDiscoveryengineV1alphaAclConfig
1358
1418
  class Representation < Google::Apis::Core::JsonRepresentation; end
1359
1419
 
@@ -1756,18 +1816,6 @@ module Google
1756
1816
  include Google::Apis::Core::JsonObjectSupport
1757
1817
  end
1758
1818
 
1759
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata
1760
- class Representation < Google::Apis::Core::JsonRepresentation; end
1761
-
1762
- include Google::Apis::Core::JsonObjectSupport
1763
- end
1764
-
1765
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
1766
- class Representation < Google::Apis::Core::JsonRepresentation; end
1767
-
1768
- include Google::Apis::Core::JsonObjectSupport
1769
- end
1770
-
1771
1819
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
1772
1820
  class Representation < Google::Apis::Core::JsonRepresentation; end
1773
1821
 
@@ -2218,6 +2266,12 @@ module Google
2218
2266
  include Google::Apis::Core::JsonObjectSupport
2219
2267
  end
2220
2268
 
2269
+ class GoogleCloudDiscoveryengineV1alphaWorkspaceConfig
2270
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2271
+
2272
+ include Google::Apis::Core::JsonObjectSupport
2273
+ end
2274
+
2221
2275
  class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata
2222
2276
  class Representation < Google::Apis::Core::JsonRepresentation; end
2223
2277
 
@@ -2812,6 +2866,12 @@ module Google
2812
2866
  include Google::Apis::Core::JsonObjectSupport
2813
2867
  end
2814
2868
 
2869
+ class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
2870
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2871
+
2872
+ include Google::Apis::Core::JsonObjectSupport
2873
+ end
2874
+
2815
2875
  class GoogleLongrunningCancelOperationRequest
2816
2876
  class Representation < Google::Apis::Core::JsonRepresentation; end
2817
2877
 
@@ -3326,6 +3386,31 @@ module Google
3326
3386
  end
3327
3387
  end
3328
3388
 
3389
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
3390
+ # @private
3391
+ class Representation < Google::Apis::Core::JsonRepresentation
3392
+ collection :documents_metadata, as: 'documentsMetadata', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata::Representation
3393
+
3394
+ end
3395
+ end
3396
+
3397
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata
3398
+ # @private
3399
+ class Representation < Google::Apis::Core::JsonRepresentation
3400
+ property :last_refreshed_time, as: 'lastRefreshedTime'
3401
+ property :matcher_value, as: 'matcherValue', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue::Representation
3402
+
3403
+ property :status, as: 'status'
3404
+ end
3405
+ end
3406
+
3407
+ class GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue
3408
+ # @private
3409
+ class Representation < Google::Apis::Core::JsonRepresentation
3410
+ property :uri, as: 'uri'
3411
+ end
3412
+ end
3413
+
3329
3414
  class GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest
3330
3415
  # @private
3331
3416
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3416,6 +3501,7 @@ module Google
3416
3501
  property :claim_text, as: 'claimText'
3417
3502
  property :end_pos, as: 'endPos'
3418
3503
  property :grounding_check_required, as: 'groundingCheckRequired'
3504
+ property :score, as: 'score'
3419
3505
  property :start_pos, as: 'startPos'
3420
3506
  end
3421
3507
  end
@@ -3710,6 +3796,19 @@ module Google
3710
3796
  end
3711
3797
  end
3712
3798
 
3799
+ class GoogleCloudDiscoveryengineV1CustomTuningModel
3800
+ # @private
3801
+ class Representation < Google::Apis::Core::JsonRepresentation
3802
+ property :create_time, as: 'createTime'
3803
+ property :display_name, as: 'displayName'
3804
+ hash :metrics, as: 'metrics'
3805
+ property :model_state, as: 'modelState'
3806
+ property :model_version, :numeric_string => true, as: 'modelVersion'
3807
+ property :name, as: 'name'
3808
+ property :training_start_time, as: 'trainingStartTime'
3809
+ end
3810
+ end
3811
+
3713
3812
  class GoogleCloudDiscoveryengineV1DataStore
3714
3813
  # @private
3715
3814
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3724,6 +3823,8 @@ module Google
3724
3823
  collection :solution_types, as: 'solutionTypes'
3725
3824
  property :starting_schema, as: 'startingSchema', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
3726
3825
 
3826
+ property :workspace_config, as: 'workspaceConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WorkspaceConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WorkspaceConfig::Representation
3827
+
3727
3828
  end
3728
3829
  end
3729
3830
 
@@ -3808,6 +3909,7 @@ module Google
3808
3909
  # @private
3809
3910
  class Representation < Google::Apis::Core::JsonRepresentation
3810
3911
  property :id, as: 'id'
3912
+ property :joined, as: 'joined'
3811
3913
  property :name, as: 'name'
3812
3914
  collection :promotion_ids, as: 'promotionIds'
3813
3915
  property :quantity, as: 'quantity'
@@ -3983,6 +4085,7 @@ module Google
3983
4085
  class Representation < Google::Apis::Core::JsonRepresentation
3984
4086
  property :fhir_store, as: 'fhirStore'
3985
4087
  property :gcs_staging_dir, as: 'gcsStagingDir'
4088
+ collection :resource_types, as: 'resourceTypes'
3986
4089
  end
3987
4090
  end
3988
4091
 
@@ -4228,6 +4331,14 @@ module Google
4228
4331
  end
4229
4332
  end
4230
4333
 
4334
+ class GoogleCloudDiscoveryengineV1ListCustomModelsResponse
4335
+ # @private
4336
+ class Representation < Google::Apis::Core::JsonRepresentation
4337
+ collection :models, as: 'models', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CustomTuningModel, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CustomTuningModel::Representation
4338
+
4339
+ end
4340
+ end
4341
+
4231
4342
  class GoogleCloudDiscoveryengineV1ListDataStoresResponse
4232
4343
  # @private
4233
4344
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4994,6 +5105,49 @@ module Google
4994
5105
  end
4995
5106
  end
4996
5107
 
5108
+ class GoogleCloudDiscoveryengineV1TrainCustomModelMetadata
5109
+ # @private
5110
+ class Representation < Google::Apis::Core::JsonRepresentation
5111
+ property :create_time, as: 'createTime'
5112
+ property :update_time, as: 'updateTime'
5113
+ end
5114
+ end
5115
+
5116
+ class GoogleCloudDiscoveryengineV1TrainCustomModelRequest
5117
+ # @private
5118
+ class Representation < Google::Apis::Core::JsonRepresentation
5119
+ property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig::Representation
5120
+
5121
+ property :gcs_training_input, as: 'gcsTrainingInput', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput::Representation
5122
+
5123
+ property :model_id, as: 'modelId'
5124
+ property :model_type, as: 'modelType'
5125
+ end
5126
+ end
5127
+
5128
+ class GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput
5129
+ # @private
5130
+ class Representation < Google::Apis::Core::JsonRepresentation
5131
+ property :corpus_data_path, as: 'corpusDataPath'
5132
+ property :query_data_path, as: 'queryDataPath'
5133
+ property :test_data_path, as: 'testDataPath'
5134
+ property :train_data_path, as: 'trainDataPath'
5135
+ end
5136
+ end
5137
+
5138
+ class GoogleCloudDiscoveryengineV1TrainCustomModelResponse
5139
+ # @private
5140
+ class Representation < Google::Apis::Core::JsonRepresentation
5141
+ property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig::Representation
5142
+
5143
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
5144
+
5145
+ hash :metrics, as: 'metrics'
5146
+ property :model_name, as: 'modelName'
5147
+ property :model_status, as: 'modelStatus'
5148
+ end
5149
+ end
5150
+
4997
5151
  class GoogleCloudDiscoveryengineV1TransactionInfo
4998
5152
  # @private
4999
5153
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5065,6 +5219,14 @@ module Google
5065
5219
  end
5066
5220
  end
5067
5221
 
5222
+ class GoogleCloudDiscoveryengineV1WorkspaceConfig
5223
+ # @private
5224
+ class Representation < Google::Apis::Core::JsonRepresentation
5225
+ property :dasher_customer_id, as: 'dasherCustomerId'
5226
+ property :type, as: 'type'
5227
+ end
5228
+ end
5229
+
5068
5230
  class GoogleCloudDiscoveryengineV1alphaAclConfig
5069
5231
  # @private
5070
5232
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5429,6 +5591,8 @@ module Google
5429
5591
  collection :solution_types, as: 'solutionTypes'
5430
5592
  property :starting_schema, as: 'startingSchema', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSchema, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSchema::Representation
5431
5593
 
5594
+ property :workspace_config, as: 'workspaceConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaWorkspaceConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaWorkspaceConfig::Representation
5595
+
5432
5596
  end
5433
5597
  end
5434
5598
 
@@ -5706,22 +5870,6 @@ module Google
5706
5870
  end
5707
5871
  end
5708
5872
 
5709
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata
5710
- # @private
5711
- class Representation < Google::Apis::Core::JsonRepresentation
5712
- property :create_time, as: 'createTime'
5713
- property :update_time, as: 'updateTime'
5714
- end
5715
- end
5716
-
5717
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
5718
- # @private
5719
- class Representation < Google::Apis::Core::JsonRepresentation
5720
- property :status, as: 'status', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
5721
-
5722
- end
5723
- end
5724
-
5725
5873
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
5726
5874
  # @private
5727
5875
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6470,6 +6618,14 @@ module Google
6470
6618
  end
6471
6619
  end
6472
6620
 
6621
+ class GoogleCloudDiscoveryengineV1alphaWorkspaceConfig
6622
+ # @private
6623
+ class Representation < Google::Apis::Core::JsonRepresentation
6624
+ property :dasher_customer_id, as: 'dasherCustomerId'
6625
+ property :type, as: 'type'
6626
+ end
6627
+ end
6628
+
6473
6629
  class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata
6474
6630
  # @private
6475
6631
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6631,6 +6787,8 @@ module Google
6631
6787
  collection :solution_types, as: 'solutionTypes'
6632
6788
  property :starting_schema, as: 'startingSchema', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSchema, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSchema::Representation
6633
6789
 
6790
+ property :workspace_config, as: 'workspaceConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaWorkspaceConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaWorkspaceConfig::Representation
6791
+
6634
6792
  end
6635
6793
  end
6636
6794
 
@@ -7119,6 +7277,7 @@ module Google
7119
7277
 
7120
7278
  property :ranking_expression, as: 'rankingExpression'
7121
7279
  property :region_code, as: 'regionCode'
7280
+ property :relevance_threshold, as: 'relevanceThreshold'
7122
7281
  property :safe_search, as: 'safeSearch'
7123
7282
  property :search_as_you_type_spec, as: 'searchAsYouTypeSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec::Representation
7124
7283
 
@@ -7438,6 +7597,14 @@ module Google
7438
7597
  end
7439
7598
  end
7440
7599
 
7600
+ class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
7601
+ # @private
7602
+ class Representation < Google::Apis::Core::JsonRepresentation
7603
+ property :dasher_customer_id, as: 'dasherCustomerId'
7604
+ property :type, as: 'type'
7605
+ end
7606
+ end
7607
+
7441
7608
  class GoogleLongrunningCancelOperationRequest
7442
7609
  # @private
7443
7610
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -468,6 +468,76 @@ module Google
468
468
  execute_or_queue_command(command, &block)
469
469
  end
470
470
 
471
+ # Trains a custom model.
472
+ # @param [String] data_store
473
+ # Required. The resource name of the Data Store, such as `projects/*/locations/
474
+ # global/collections/default_collection/dataStores/default_data_store`. This
475
+ # field is used to identify the data store where to train the models.
476
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequest] google_cloud_discoveryengine_v1_train_custom_model_request_object
477
+ # @param [String] fields
478
+ # Selector specifying which fields to include in a partial response.
479
+ # @param [String] quota_user
480
+ # Available to use for quota purposes for server-side applications. Can be any
481
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
482
+ # @param [Google::Apis::RequestOptions] options
483
+ # Request-specific options
484
+ #
485
+ # @yield [result, err] Result & error if block supplied
486
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
487
+ # @yieldparam err [StandardError] error object if request failed
488
+ #
489
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
490
+ #
491
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
492
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
493
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
494
+ def train_project_location_collection_data_store_custom_model(data_store, google_cloud_discoveryengine_v1_train_custom_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
495
+ command = make_simple_command(:post, 'v1/{+dataStore}:trainCustomModel', options)
496
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequest::Representation
497
+ command.request_object = google_cloud_discoveryengine_v1_train_custom_model_request_object
498
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
499
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
500
+ command.params['dataStore'] = data_store unless data_store.nil?
501
+ command.query['fields'] = fields unless fields.nil?
502
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
503
+ execute_or_queue_command(command, &block)
504
+ end
505
+
506
+ # Gets index freshness metadata for Documents. Supported for website search only.
507
+ # @param [String] parent
508
+ # Required. The parent branch resource name, such as `projects/`project`/
509
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
510
+ # `branch``.
511
+ # @param [Array<String>, String] matcher_uris_matcher_uris
512
+ # The exact URIs to match by.
513
+ # @param [String] fields
514
+ # Selector specifying which fields to include in a partial response.
515
+ # @param [String] quota_user
516
+ # Available to use for quota purposes for server-side applications. Can be any
517
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
518
+ # @param [Google::Apis::RequestOptions] options
519
+ # Request-specific options
520
+ #
521
+ # @yield [result, err] Result & error if block supplied
522
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse] parsed result object
523
+ # @yieldparam err [StandardError] error object if request failed
524
+ #
525
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse]
526
+ #
527
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
528
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
529
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
530
+ def batch_project_location_collection_data_store_branch_get_documents_metadata(parent, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
531
+ command = make_simple_command(:get, 'v1/{+parent}/batchGetDocumentsMetadata', options)
532
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse::Representation
533
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
534
+ command.params['parent'] = parent unless parent.nil?
535
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
536
+ command.query['fields'] = fields unless fields.nil?
537
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
538
+ execute_or_queue_command(command, &block)
539
+ end
540
+
471
541
  # Creates a Document.
472
542
  # @param [String] parent
473
543
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -1350,6 +1420,38 @@ module Google
1350
1420
  execute_or_queue_command(command, &block)
1351
1421
  end
1352
1422
 
1423
+ # Gets a list of all the custom models.
1424
+ # @param [String] data_store
1425
+ # Required. The resource name of the parent Data Store, such as `projects/*/
1426
+ # locations/global/collections/default_collection/dataStores/default_data_store`.
1427
+ # This field is used to identify the data store where to fetch the models from.
1428
+ # @param [String] fields
1429
+ # Selector specifying which fields to include in a partial response.
1430
+ # @param [String] quota_user
1431
+ # Available to use for quota purposes for server-side applications. Can be any
1432
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1433
+ # @param [Google::Apis::RequestOptions] options
1434
+ # Request-specific options
1435
+ #
1436
+ # @yield [result, err] Result & error if block supplied
1437
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse] parsed result object
1438
+ # @yieldparam err [StandardError] error object if request failed
1439
+ #
1440
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse]
1441
+ #
1442
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1443
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1444
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1445
+ def list_project_location_collection_data_store_custom_models(data_store, fields: nil, quota_user: nil, options: nil, &block)
1446
+ command = make_simple_command(:get, 'v1/{+dataStore}/customModels', options)
1447
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse::Representation
1448
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse
1449
+ command.params['dataStore'] = data_store unless data_store.nil?
1450
+ command.query['fields'] = fields unless fields.nil?
1451
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1452
+ execute_or_queue_command(command, &block)
1453
+ end
1454
+
1353
1455
  # Gets the latest state of a long-running operation. Clients can use this method
1354
1456
  # to poll the operation result at intervals as recommended by the API service.
1355
1457
  # @param [String] name
@@ -4265,6 +4367,41 @@ module Google
4265
4367
  execute_or_queue_command(command, &block)
4266
4368
  end
4267
4369
 
4370
+ # Gets index freshness metadata for Documents. Supported for website search only.
4371
+ # @param [String] parent
4372
+ # Required. The parent branch resource name, such as `projects/`project`/
4373
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
4374
+ # `branch``.
4375
+ # @param [Array<String>, String] matcher_uris_matcher_uris
4376
+ # The exact URIs to match by.
4377
+ # @param [String] fields
4378
+ # Selector specifying which fields to include in a partial response.
4379
+ # @param [String] quota_user
4380
+ # Available to use for quota purposes for server-side applications. Can be any
4381
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4382
+ # @param [Google::Apis::RequestOptions] options
4383
+ # Request-specific options
4384
+ #
4385
+ # @yield [result, err] Result & error if block supplied
4386
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse] parsed result object
4387
+ # @yieldparam err [StandardError] error object if request failed
4388
+ #
4389
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse]
4390
+ #
4391
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4392
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4393
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4394
+ def batch_project_location_data_store_branch_get_documents_metadata(parent, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
4395
+ command = make_simple_command(:get, 'v1/{+parent}/batchGetDocumentsMetadata', options)
4396
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse::Representation
4397
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
4398
+ command.params['parent'] = parent unless parent.nil?
4399
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
4400
+ command.query['fields'] = fields unless fields.nil?
4401
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4402
+ execute_or_queue_command(command, &block)
4403
+ end
4404
+
4268
4405
  # Creates a Document.
4269
4406
  # @param [String] parent
4270
4407
  # Required. The parent resource name, such as `projects/`project`/locations/`
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 0.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-08-04 00:00:00.000000000 Z
11
+ date: 2024-08-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.10.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.12.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
63
63
  post_install_message:
64
64
  rdoc_options: []