google-apis-discoveryengine_v1alpha 0.39.0 → 0.40.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -619,19 +619,6 @@ module Google
619
619
  end
620
620
  end
621
621
 
622
- # The digital parsing configurations for documents.
623
- class GoogleCloudDiscoveryengineV1DigitalParsingConfig
624
- include Google::Apis::Core::Hashable
625
-
626
- def initialize(**args)
627
- update!(**args)
628
- end
629
-
630
- # Update properties of this object
631
- def update!(**args)
632
- end
633
- end
634
-
635
622
  # Metadata related to the progress of the SiteSearchEngineService.
636
623
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
637
624
  # longrunning.Operation.metadata field.
@@ -718,12 +705,12 @@ module Google
718
705
 
719
706
  # The digital parsing configurations for documents.
720
707
  # Corresponds to the JSON property `digitalParsingConfig`
721
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DigitalParsingConfig]
708
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig]
722
709
  attr_accessor :digital_parsing_config
723
710
 
724
711
  # The OCR parsing configurations for documents.
725
712
  # Corresponds to the JSON property `ocrParsingConfig`
726
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1OcrParsingConfig]
713
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig]
727
714
  attr_accessor :ocr_parsing_config
728
715
 
729
716
  def initialize(**args)
@@ -737,6 +724,47 @@ module Google
737
724
  end
738
725
  end
739
726
 
727
+ # The digital parsing configurations for documents.
728
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig
729
+ include Google::Apis::Core::Hashable
730
+
731
+ def initialize(**args)
732
+ update!(**args)
733
+ end
734
+
735
+ # Update properties of this object
736
+ def update!(**args)
737
+ end
738
+ end
739
+
740
+ # The OCR parsing configurations for documents.
741
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
742
+ include Google::Apis::Core::Hashable
743
+
744
+ # Apply additional enhanced OCR processing to a list of document elements.
745
+ # Supported values: * `table`: advanced table parsing model.
746
+ # Corresponds to the JSON property `enhancedDocumentElements`
747
+ # @return [Array<String>]
748
+ attr_accessor :enhanced_document_elements
749
+
750
+ # If true, will use native text instead of OCR text on pages containing native
751
+ # text.
752
+ # Corresponds to the JSON property `useNativeText`
753
+ # @return [Boolean]
754
+ attr_accessor :use_native_text
755
+ alias_method :use_native_text?, :use_native_text
756
+
757
+ def initialize(**args)
758
+ update!(**args)
759
+ end
760
+
761
+ # Update properties of this object
762
+ def update!(**args)
763
+ @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
764
+ @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
765
+ end
766
+ end
767
+
740
768
  # Metadata related to the progress of the SiteSearchEngineService.
741
769
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
742
770
  # longrunning.Operation.metadata field.
@@ -1244,34 +1272,6 @@ module Google
1244
1272
  end
1245
1273
  end
1246
1274
 
1247
- # The OCR parsing configurations for documents.
1248
- class GoogleCloudDiscoveryengineV1OcrParsingConfig
1249
- include Google::Apis::Core::Hashable
1250
-
1251
- # Apply additional enhanced OCR processing to a list of document elements.
1252
- # Supported values: * `table`: advanced table parsing model.
1253
- # Corresponds to the JSON property `enhancedDocumentElements`
1254
- # @return [Array<String>]
1255
- attr_accessor :enhanced_document_elements
1256
-
1257
- # If true, will use native text instead of OCR text on pages containing native
1258
- # text.
1259
- # Corresponds to the JSON property `useNativeText`
1260
- # @return [Boolean]
1261
- attr_accessor :use_native_text
1262
- alias_method :use_native_text?, :use_native_text
1263
-
1264
- def initialize(**args)
1265
- update!(**args)
1266
- end
1267
-
1268
- # Update properties of this object
1269
- def update!(**args)
1270
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
1271
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
1272
- end
1273
- end
1274
-
1275
1275
  # Metadata related to the progress of the PurgeDocuments operation. This will be
1276
1276
  # returned by the google.longrunning.Operation.metadata field.
1277
1277
  class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
@@ -1932,7 +1932,7 @@ module Google
1932
1932
  # imported search events. * `document-completable` - Using suggestions taken
1933
1933
  # directly from user-imported document fields marked as completable. Default
1934
1934
  # values: * `document` is the default model for regular dataStores. * `search-
1935
- # history` is the default model for site search dataStores. *
1935
+ # history` is the default model for site search dataStores.
1936
1936
  # Corresponds to the JSON property `queryModel`
1937
1937
  # @return [String]
1938
1938
  attr_accessor :query_model
@@ -2683,19 +2683,6 @@ module Google
2683
2683
  end
2684
2684
  end
2685
2685
 
2686
- # The digital parsing configurations for documents.
2687
- class GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig
2688
- include Google::Apis::Core::Hashable
2689
-
2690
- def initialize(**args)
2691
- update!(**args)
2692
- end
2693
-
2694
- # Update properties of this object
2695
- def update!(**args)
2696
- end
2697
- end
2698
-
2699
2686
  # Metadata related to the progress of the SiteSearchEngineService.
2700
2687
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
2701
2688
  # longrunning.Operation.metadata field.
@@ -2840,7 +2827,7 @@ module Google
2840
2827
  class GoogleCloudDiscoveryengineV1alphaDocumentAclInfo
2841
2828
  include Google::Apis::Core::Hashable
2842
2829
 
2843
- #
2830
+ # Readers of the document.
2844
2831
  # Corresponds to the JSON property `readers`
2845
2832
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction>]
2846
2833
  attr_accessor :readers
@@ -2997,11 +2984,6 @@ module Google
2997
2984
  # @return [String]
2998
2985
  attr_accessor :name
2999
2986
 
3000
- # The OCR options for parsing documents.
3001
- # Corresponds to the JSON property `ocrConfig`
3002
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaOcrConfig]
3003
- attr_accessor :ocr_config
3004
-
3005
2987
  # Map from file type to override the default parsing configuration based on the
3006
2988
  # file type. Supported keys: * `pdf`: Override parsing config for PDF files,
3007
2989
  # either digital parsing, ocr parsing or layout parsing is supported. * `html`:
@@ -3021,7 +3003,6 @@ module Google
3021
3003
  @chunking_config = args[:chunking_config] if args.key?(:chunking_config)
3022
3004
  @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
3023
3005
  @name = args[:name] if args.key?(:name)
3024
- @ocr_config = args[:ocr_config] if args.key?(:ocr_config)
3025
3006
  @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
3026
3007
  end
3027
3008
  end
@@ -3079,17 +3060,17 @@ module Google
3079
3060
 
3080
3061
  # The digital parsing configurations for documents.
3081
3062
  # Corresponds to the JSON property `digitalParsingConfig`
3082
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig]
3063
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
3083
3064
  attr_accessor :digital_parsing_config
3084
3065
 
3085
3066
  # The layout parsing configurations for documents.
3086
3067
  # Corresponds to the JSON property `layoutParsingConfig`
3087
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig]
3068
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig]
3088
3069
  attr_accessor :layout_parsing_config
3089
3070
 
3090
3071
  # The OCR parsing configurations for documents.
3091
3072
  # Corresponds to the JSON property `ocrParsingConfig`
3092
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaOcrParsingConfig]
3073
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig]
3093
3074
  attr_accessor :ocr_parsing_config
3094
3075
 
3095
3076
  def initialize(**args)
@@ -3104,6 +3085,60 @@ module Google
3104
3085
  end
3105
3086
  end
3106
3087
 
3088
+ # The digital parsing configurations for documents.
3089
+ class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig
3090
+ include Google::Apis::Core::Hashable
3091
+
3092
+ def initialize(**args)
3093
+ update!(**args)
3094
+ end
3095
+
3096
+ # Update properties of this object
3097
+ def update!(**args)
3098
+ end
3099
+ end
3100
+
3101
+ # The layout parsing configurations for documents.
3102
+ class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig
3103
+ include Google::Apis::Core::Hashable
3104
+
3105
+ def initialize(**args)
3106
+ update!(**args)
3107
+ end
3108
+
3109
+ # Update properties of this object
3110
+ def update!(**args)
3111
+ end
3112
+ end
3113
+
3114
+ # The OCR parsing configurations for documents.
3115
+ class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig
3116
+ include Google::Apis::Core::Hashable
3117
+
3118
+ # Apply additional enhanced OCR processing to a list of document elements.
3119
+ # Supported values: * `table`: advanced table parsing model.
3120
+ # Corresponds to the JSON property `enhancedDocumentElements`
3121
+ # @return [Array<String>]
3122
+ attr_accessor :enhanced_document_elements
3123
+
3124
+ # If true, will use native text instead of OCR text on pages containing native
3125
+ # text.
3126
+ # Corresponds to the JSON property `useNativeText`
3127
+ # @return [Boolean]
3128
+ attr_accessor :use_native_text
3129
+ alias_method :use_native_text?, :use_native_text
3130
+
3131
+ def initialize(**args)
3132
+ update!(**args)
3133
+ end
3134
+
3135
+ # Update properties of this object
3136
+ def update!(**args)
3137
+ @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
3138
+ @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
3139
+ end
3140
+ end
3141
+
3107
3142
  # Double list.
3108
3143
  class GoogleCloudDiscoveryengineV1alphaDoubleList
3109
3144
  include Google::Apis::Core::Hashable
@@ -3200,14 +3235,6 @@ module Google
3200
3235
  class GoogleCloudDiscoveryengineV1alphaEngine
3201
3236
  include Google::Apis::Core::Hashable
3202
3237
 
3203
- # Whether the search engine can associate with multiple data stores. If true,
3204
- # the generic search engine can associate with one or more data stores. This is
3205
- # an input-only field.
3206
- # Corresponds to the JSON property `allowMultipleDataStoresSearchEngine`
3207
- # @return [Boolean]
3208
- attr_accessor :allow_multiple_data_stores_search_engine
3209
- alias_method :allow_multiple_data_stores_search_engine?, :allow_multiple_data_stores_search_engine
3210
-
3211
3238
  # Configurations for a Chat Engine.
3212
3239
  # Corresponds to the JSON property `chatEngineConfig`
3213
3240
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
@@ -3298,7 +3325,6 @@ module Google
3298
3325
 
3299
3326
  # Update properties of this object
3300
3327
  def update!(**args)
3301
- @allow_multiple_data_stores_search_engine = args[:allow_multiple_data_stores_search_engine] if args.key?(:allow_multiple_data_stores_search_engine)
3302
3328
  @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
3303
3329
  @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
3304
3330
  @common_config = args[:common_config] if args.key?(:common_config)
@@ -4482,16 +4508,29 @@ module Google
4482
4508
  end
4483
4509
  end
4484
4510
 
4485
- # The layout parsing configurations for documents.
4486
- class GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig
4511
+ # Response message for ChunkService.ListChunks method.
4512
+ class GoogleCloudDiscoveryengineV1alphaListChunksResponse
4487
4513
  include Google::Apis::Core::Hashable
4488
4514
 
4515
+ # The Chunks.
4516
+ # Corresponds to the JSON property `chunks`
4517
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk>]
4518
+ attr_accessor :chunks
4519
+
4520
+ # A token that can be sent as ListChunksRequest.page_token to retrieve the next
4521
+ # page. If this field is omitted, there are no subsequent pages.
4522
+ # Corresponds to the JSON property `nextPageToken`
4523
+ # @return [String]
4524
+ attr_accessor :next_page_token
4525
+
4489
4526
  def initialize(**args)
4490
4527
  update!(**args)
4491
4528
  end
4492
4529
 
4493
4530
  # Update properties of this object
4494
4531
  def update!(**args)
4532
+ @chunks = args[:chunks] if args.key?(:chunks)
4533
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
4495
4534
  end
4496
4535
  end
4497
4536
 
@@ -4749,71 +4788,6 @@ module Google
4749
4788
  end
4750
4789
  end
4751
4790
 
4752
- # The OCR options for parsing documents.
4753
- class GoogleCloudDiscoveryengineV1alphaOcrConfig
4754
- include Google::Apis::Core::Hashable
4755
-
4756
- # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig
4757
- # options to apply. We will only perform OCR on the first 80 pages of the PDF
4758
- # files.
4759
- # Corresponds to the JSON property `enabled`
4760
- # @return [Boolean]
4761
- attr_accessor :enabled
4762
- alias_method :enabled?, :enabled
4763
-
4764
- # Apply additional enhanced OCR processing to a list of document elements.
4765
- # Supported values: * `table`: advanced table parsing model.
4766
- # Corresponds to the JSON property `enhancedDocumentElements`
4767
- # @return [Array<String>]
4768
- attr_accessor :enhanced_document_elements
4769
-
4770
- # If true, will use native text instead of OCR text on pages containing native
4771
- # text.
4772
- # Corresponds to the JSON property `useNativeText`
4773
- # @return [Boolean]
4774
- attr_accessor :use_native_text
4775
- alias_method :use_native_text?, :use_native_text
4776
-
4777
- def initialize(**args)
4778
- update!(**args)
4779
- end
4780
-
4781
- # Update properties of this object
4782
- def update!(**args)
4783
- @enabled = args[:enabled] if args.key?(:enabled)
4784
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
4785
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
4786
- end
4787
- end
4788
-
4789
- # The OCR parsing configurations for documents.
4790
- class GoogleCloudDiscoveryengineV1alphaOcrParsingConfig
4791
- include Google::Apis::Core::Hashable
4792
-
4793
- # Apply additional enhanced OCR processing to a list of document elements.
4794
- # Supported values: * `table`: advanced table parsing model.
4795
- # Corresponds to the JSON property `enhancedDocumentElements`
4796
- # @return [Array<String>]
4797
- attr_accessor :enhanced_document_elements
4798
-
4799
- # If true, will use native text instead of OCR text on pages containing native
4800
- # text.
4801
- # Corresponds to the JSON property `useNativeText`
4802
- # @return [Boolean]
4803
- attr_accessor :use_native_text
4804
- alias_method :use_native_text?, :use_native_text
4805
-
4806
- def initialize(**args)
4807
- update!(**args)
4808
- end
4809
-
4810
- # Update properties of this object
4811
- def update!(**args)
4812
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
4813
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
4814
- end
4815
- end
4816
-
4817
4791
  # Detailed page information.
4818
4792
  class GoogleCloudDiscoveryengineV1alphaPageInfo
4819
4793
  include Google::Apis::Core::Hashable
@@ -5786,6 +5760,11 @@ module Google
5786
5760
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
5787
5761
  attr_accessor :custom_fine_tuning_spec
5788
5762
 
5763
+ # A list of data store specs to apply on a search call.
5764
+ # Corresponds to the JSON property `dataStoreSpecs`
5765
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
5766
+ attr_accessor :data_store_specs
5767
+
5789
5768
  # The specification that uses customized query embedding vector to do semantic
5790
5769
  # document retrieval.
5791
5770
  # Corresponds to the JSON property `embeddingSpec`
@@ -5952,6 +5931,7 @@ module Google
5952
5931
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
5953
5932
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
5954
5933
  @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
5934
+ @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
5955
5935
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
5956
5936
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
5957
5937
  @filter = args[:filter] if args.key?(:filter)
@@ -6016,8 +5996,8 @@ module Google
6016
5996
  # An expression which specifies a boost condition. The syntax and supported
6017
5997
  # fields are the same as a filter expression. See SearchRequest.filter for
6018
5998
  # detail syntax and limitations. Examples: * To boost documents with document ID
6019
- # "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "
6020
- # doc_2")) AND (color: ANY("Red", "Blue"))
5999
+ # "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "
6000
+ # doc_2")) AND (color: ANY("Red", "Blue"))`
6021
6001
  # Corresponds to the JSON property `condition`
6022
6002
  # @return [String]
6023
6003
  attr_accessor :condition
@@ -6112,6 +6092,15 @@ module Google
6112
6092
  # @return [Fixnum]
6113
6093
  attr_accessor :num_previous_segments
6114
6094
 
6095
+ # Specifies whether to return the confidence score from the extractive segments
6096
+ # in each search result. This feature is available only for new or allowlisted
6097
+ # data stores. To allowlist your data store, please contact your Customer
6098
+ # Engineer. The default value is `false`.
6099
+ # Corresponds to the JSON property `returnExtractiveSegmentScore`
6100
+ # @return [Boolean]
6101
+ attr_accessor :return_extractive_segment_score
6102
+ alias_method :return_extractive_segment_score?, :return_extractive_segment_score
6103
+
6115
6104
  def initialize(**args)
6116
6105
  update!(**args)
6117
6106
  end
@@ -6122,6 +6111,7 @@ module Google
6122
6111
  @max_extractive_segment_count = args[:max_extractive_segment_count] if args.key?(:max_extractive_segment_count)
6123
6112
  @num_next_segments = args[:num_next_segments] if args.key?(:num_next_segments)
6124
6113
  @num_previous_segments = args[:num_previous_segments] if args.key?(:num_previous_segments)
6114
+ @return_extractive_segment_score = args[:return_extractive_segment_score] if args.key?(:return_extractive_segment_score)
6125
6115
  end
6126
6116
  end
6127
6117
 
@@ -6224,8 +6214,7 @@ module Google
6224
6214
 
6225
6215
  # The number of top results to generate the summary from. If the number of
6226
6216
  # results returned is less than `summaryResultCount`, the summary is generated
6227
- # from all of the results. At most five results can be used to generate a
6228
- # summary.
6217
+ # from all of the results. At most 10 results can be used to generate a summary.
6229
6218
  # Corresponds to the JSON property `summaryResultCount`
6230
6219
  # @return [Fixnum]
6231
6220
  attr_accessor :summary_result_count
@@ -6272,9 +6261,12 @@ module Google
6272
6261
 
6273
6262
  # The model version used to generate the summary. Supported values are: * `
6274
6263
  # stable`: string. Default value when no value is specified. Uses a generally
6275
- # available, fine-tuned version of the text-bison@001 model. * `preview`: string.
6276
- # (Public preview) Uses a fine-tuned version of the text-bison@002 model. This
6277
- # model works only for summaries in English.
6264
+ # available, fine-tuned model. For more information, see [Answer generation
6265
+ # model versions and lifecycle](https://cloud.google.com/generative-ai-app-
6266
+ # builder/docs/answer-generation-models). * `preview`: string. (Public preview)
6267
+ # Uses a preview model. For more information, see [Answer generation model
6268
+ # versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/
6269
+ # docs/answer-generation-models).
6278
6270
  # Corresponds to the JSON property `version`
6279
6271
  # @return [String]
6280
6272
  attr_accessor :version
@@ -6289,6 +6281,26 @@ module Google
6289
6281
  end
6290
6282
  end
6291
6283
 
6284
+ # A struct to define data stores to filter on in a search call.
6285
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec
6286
+ include Google::Apis::Core::Hashable
6287
+
6288
+ # Required. Full resource name of DataStore, such as `projects/`project`/
6289
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
6290
+ # Corresponds to the JSON property `dataStore`
6291
+ # @return [String]
6292
+ attr_accessor :data_store
6293
+
6294
+ def initialize(**args)
6295
+ update!(**args)
6296
+ end
6297
+
6298
+ # Update properties of this object
6299
+ def update!(**args)
6300
+ @data_store = args[:data_store] if args.key?(:data_store)
6301
+ end
6302
+ end
6303
+
6292
6304
  # The specification that uses customized query embedding vector to do semantic
6293
6305
  # document retrieval.
6294
6306
  class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
@@ -7153,7 +7165,7 @@ module Google
7153
7165
  attr_accessor :model_id
7154
7166
 
7155
7167
  # Immutable. Fully qualified name `projects/`project`/locations/`location`/
7156
- # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
7168
+ # collections/`collection_id`/engines/`engine_id`/servingConfigs/`
7157
7169
  # serving_config_id``
7158
7170
  # Corresponds to the JSON property `name`
7159
7171
  # @return [String]
@@ -7287,11 +7299,6 @@ module Google
7287
7299
  # @return [Fixnum]
7288
7300
  attr_accessor :content_freshness_cutoff_days
7289
7301
 
7290
- # Specifies the content watched minutes threshold for demotion.
7291
- # Corresponds to the JSON property `contentWatchedMinutesThreshold`
7292
- # @return [Float]
7293
- attr_accessor :content_watched_minutes_threshold
7294
-
7295
7302
  # Specifies the content watched percentage threshold for demotion. Threshold
7296
7303
  # value must be between [0, 1.0] inclusive.
7297
7304
  # Corresponds to the JSON property `contentWatchedPercentageThreshold`
@@ -7319,7 +7326,6 @@ module Google
7319
7326
  # Update properties of this object
7320
7327
  def update!(**args)
7321
7328
  @content_freshness_cutoff_days = args[:content_freshness_cutoff_days] if args.key?(:content_freshness_cutoff_days)
7322
- @content_watched_minutes_threshold = args[:content_watched_minutes_threshold] if args.key?(:content_watched_minutes_threshold)
7323
7329
  @content_watched_percentage_threshold = args[:content_watched_percentage_threshold] if args.key?(:content_watched_percentage_threshold)
7324
7330
  @content_watched_seconds_threshold = args[:content_watched_seconds_threshold] if args.key?(:content_watched_seconds_threshold)
7325
7331
  @demotion_event_type = args[:demotion_event_type] if args.key?(:demotion_event_type)
@@ -7606,15 +7612,15 @@ module Google
7606
7612
  include Google::Apis::Core::Hashable
7607
7613
 
7608
7614
  # The Cloud Storage corpus data which could be associated in train data. The
7609
- # data path format is gs:///. A newline delimited jsonl/ndjson file. For search-
7610
- # tuning model, each line should have the _id, title and text. Example: `"_id": "
7611
- # doc1", title: "relevant doc", "text": "relevant text"`
7615
+ # data path format is `gs:///`. A newline delimited jsonl/ndjson file. For
7616
+ # search-tuning model, each line should have the _id, title and text. Example: ``
7617
+ # "_id": "doc1", title: "relevant doc", "text": "relevant text"``
7612
7618
  # Corresponds to the JSON property `corpusDataPath`
7613
7619
  # @return [String]
7614
7620
  attr_accessor :corpus_data_path
7615
7621
 
7616
7622
  # The gcs query data which could be associated in train data. The data path
7617
- # format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning
7623
+ # format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning
7618
7624
  # model, each line should have the _id and text. Example: `"_id": "query1", "
7619
7625
  # text": "example query"`
7620
7626
  # Corresponds to the JSON property `queryDataPath`
@@ -7627,12 +7633,12 @@ module Google
7627
7633
  # @return [String]
7628
7634
  attr_accessor :test_data_path
7629
7635
 
7630
- # Cloud Storage training data path whose format should be gs:///. The file
7636
+ # Cloud Storage training data path whose format should be `gs:///`. The file
7631
7637
  # should be in tsv format. Each line should have the doc_id and query_id and
7632
7638
  # score (number). For search-tuning model, it should have the query-id corpus-id
7633
- # score as tsv file header. The score should be a number in [0, inf+). The
7634
- # larger the number is, the more relevant the pair is. Example: query-id\tcorpus-
7635
- # id\tscore query1\tdoc1\t1
7639
+ # score as tsv file header. The score should be a number in `[0, inf+)`. The
7640
+ # larger the number is, the more relevant the pair is. Example: * `query-id\
7641
+ # tcorpus-id\tscore` * `query1\tdoc1\t1`
7636
7642
  # Corresponds to the JSON property `trainDataPath`
7637
7643
  # @return [String]
7638
7644
  attr_accessor :train_data_path
@@ -8171,6 +8177,14 @@ module Google
8171
8177
  # @return [Array<String>]
8172
8178
  attr_accessor :allowlisted_domains
8173
8179
 
8180
+ # Output only. Collection components that lists all collections and child data
8181
+ # stores associated with the widget config, those data sources can be used for
8182
+ # filtering in widget service APIs, users can return results that from selected
8183
+ # data sources.
8184
+ # Corresponds to the JSON property `collectionComponents`
8185
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent>]
8186
+ attr_accessor :collection_components
8187
+
8174
8188
  # Output only. Unique obfuscated identifier of a WidgetConfig.
8175
8189
  # Corresponds to the JSON property `configId`
8176
8190
  # @return [String]
@@ -8191,6 +8205,11 @@ module Google
8191
8205
  # @return [String]
8192
8206
  attr_accessor :data_store_type
8193
8207
 
8208
+ # Configurable UI configurations per data store.
8209
+ # Corresponds to the JSON property `dataStoreUiConfigs`
8210
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig>]
8211
+ attr_accessor :data_store_ui_configs
8212
+
8194
8213
  # Required. The human readable widget config display name. Used in Discovery UI.
8195
8214
  # This field must be a UTF-8 encoded string with a length limit of 128
8196
8215
  # characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -8313,10 +8332,12 @@ module Google
8313
8332
  def update!(**args)
8314
8333
  @allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
8315
8334
  @allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
8335
+ @collection_components = args[:collection_components] if args.key?(:collection_components)
8316
8336
  @config_id = args[:config_id] if args.key?(:config_id)
8317
8337
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
8318
8338
  @create_time = args[:create_time] if args.key?(:create_time)
8319
8339
  @data_store_type = args[:data_store_type] if args.key?(:data_store_type)
8340
+ @data_store_ui_configs = args[:data_store_ui_configs] if args.key?(:data_store_ui_configs)
8320
8341
  @display_name = args[:display_name] if args.key?(:display_name)
8321
8342
  @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
8322
8343
  @enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
@@ -8338,6 +8359,132 @@ module Google
8338
8359
  end
8339
8360
  end
8340
8361
 
8362
+ # Read-only collection component that contains data store collections fields
8363
+ # that may be used for filtering
8364
+ class GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent
8365
+ include Google::Apis::Core::Hashable
8366
+
8367
+ # For the data store collection, list of the children data stores.
8368
+ # Corresponds to the JSON property `dataStoreComponents`
8369
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent>]
8370
+ attr_accessor :data_store_components
8371
+
8372
+ # The display name of the collection.
8373
+ # Corresponds to the JSON property `displayName`
8374
+ # @return [String]
8375
+ attr_accessor :display_name
8376
+
8377
+ # Output only. the identifier of the collection, used for widget service. For
8378
+ # now it refers to collection_id, in the future we will migrate the field to
8379
+ # encrypted collection name UUID.
8380
+ # Corresponds to the JSON property `id`
8381
+ # @return [String]
8382
+ attr_accessor :id
8383
+
8384
+ # The name of the collection. It should be collection resource name. Format: `
8385
+ # projects/`project_number`/locations/`location`/collections/`collection_id``.
8386
+ # For widget service usage, such look up widget config, returned name should be
8387
+ # skipped.
8388
+ # Corresponds to the JSON property `name`
8389
+ # @return [String]
8390
+ attr_accessor :name
8391
+
8392
+ def initialize(**args)
8393
+ update!(**args)
8394
+ end
8395
+
8396
+ # Update properties of this object
8397
+ def update!(**args)
8398
+ @data_store_components = args[:data_store_components] if args.key?(:data_store_components)
8399
+ @display_name = args[:display_name] if args.key?(:display_name)
8400
+ @id = args[:id] if args.key?(:id)
8401
+ @name = args[:name] if args.key?(:name)
8402
+ end
8403
+ end
8404
+
8405
+ # Read-only data store component that contains data stores fields that may be
8406
+ # used for filtering, it's the child of `CollectionComponent`.
8407
+ class GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent
8408
+ include Google::Apis::Core::Hashable
8409
+
8410
+ # The display name of the data store.
8411
+ # Corresponds to the JSON property `displayName`
8412
+ # @return [String]
8413
+ attr_accessor :display_name
8414
+
8415
+ # Output only. the identifier of the data store, used for widget service. For
8416
+ # now it refers to data_store_id, in the future we will migrate the field to
8417
+ # encrypted data store name UUID.
8418
+ # Corresponds to the JSON property `id`
8419
+ # @return [String]
8420
+ attr_accessor :id
8421
+
8422
+ # The name of the data store. It should be data store resource name Format: `
8423
+ # projects/`project_number`/locations/`location`/collections/`collection_id`/
8424
+ # dataStores/`data_store_id``. For widget service usage, such look up widget
8425
+ # config, returned name should be skipped.
8426
+ # Corresponds to the JSON property `name`
8427
+ # @return [String]
8428
+ attr_accessor :name
8429
+
8430
+ def initialize(**args)
8431
+ update!(**args)
8432
+ end
8433
+
8434
+ # Update properties of this object
8435
+ def update!(**args)
8436
+ @display_name = args[:display_name] if args.key?(:display_name)
8437
+ @id = args[:id] if args.key?(:id)
8438
+ @name = args[:name] if args.key?(:name)
8439
+ end
8440
+ end
8441
+
8442
+ # UI component configuration for data store.
8443
+ class GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig
8444
+ include Google::Apis::Core::Hashable
8445
+
8446
+ # Facet fields that store the mapping of fields to end user widget appearance.
8447
+ # Corresponds to the JSON property `facetField`
8448
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>]
8449
+ attr_accessor :facet_field
8450
+
8451
+ # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
8452
+ # url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
8453
+ # along with its device visibility. The 3 custom fields are optional and can be
8454
+ # added or removed. `title`, `thumbnail`, `url` are required UI components that
8455
+ # cannot be removed.
8456
+ # Corresponds to the JSON property `fieldsUiComponentsMap`
8457
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>]
8458
+ attr_accessor :fields_ui_components_map
8459
+
8460
+ # Output only. the identifier of the data store, used for widget service. For
8461
+ # now it refers to data_store_id, in the future we will migrate the field to
8462
+ # encrypted data store name UUID.
8463
+ # Corresponds to the JSON property `id`
8464
+ # @return [String]
8465
+ attr_accessor :id
8466
+
8467
+ # The name of the data store. It should be data store resource name Format: `
8468
+ # projects/`project_number`/locations/`location`/collections/`collection_id`/
8469
+ # dataStores/`data_store_id``. For widget service usage, such look up widget
8470
+ # config, returned name should be skipped.
8471
+ # Corresponds to the JSON property `name`
8472
+ # @return [String]
8473
+ attr_accessor :name
8474
+
8475
+ def initialize(**args)
8476
+ update!(**args)
8477
+ end
8478
+
8479
+ # Update properties of this object
8480
+ def update!(**args)
8481
+ @facet_field = args[:facet_field] if args.key?(:facet_field)
8482
+ @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
8483
+ @id = args[:id] if args.key?(:id)
8484
+ @name = args[:name] if args.key?(:name)
8485
+ end
8486
+ end
8487
+
8341
8488
  # Facet fields that store the mapping of fields to end user widget appearance.
8342
8489
  class GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField
8343
8490
  include Google::Apis::Core::Hashable
@@ -8868,19 +9015,6 @@ module Google
8868
9015
  end
8869
9016
  end
8870
9017
 
8871
- # The digital parsing configurations for documents.
8872
- class GoogleCloudDiscoveryengineV1betaDigitalParsingConfig
8873
- include Google::Apis::Core::Hashable
8874
-
8875
- def initialize(**args)
8876
- update!(**args)
8877
- end
8878
-
8879
- # Update properties of this object
8880
- def update!(**args)
8881
- end
8882
- end
8883
-
8884
9018
  # Metadata related to the progress of the SiteSearchEngineService.
8885
9019
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
8886
9020
  # longrunning.Operation.metadata field.
@@ -8967,12 +9101,12 @@ module Google
8967
9101
 
8968
9102
  # The digital parsing configurations for documents.
8969
9103
  # Corresponds to the JSON property `digitalParsingConfig`
8970
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDigitalParsingConfig]
9104
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
8971
9105
  attr_accessor :digital_parsing_config
8972
9106
 
8973
9107
  # The OCR parsing configurations for documents.
8974
9108
  # Corresponds to the JSON property `ocrParsingConfig`
8975
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaOcrParsingConfig]
9109
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig]
8976
9110
  attr_accessor :ocr_parsing_config
8977
9111
 
8978
9112
  def initialize(**args)
@@ -8986,6 +9120,47 @@ module Google
8986
9120
  end
8987
9121
  end
8988
9122
 
9123
+ # The digital parsing configurations for documents.
9124
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig
9125
+ include Google::Apis::Core::Hashable
9126
+
9127
+ def initialize(**args)
9128
+ update!(**args)
9129
+ end
9130
+
9131
+ # Update properties of this object
9132
+ def update!(**args)
9133
+ end
9134
+ end
9135
+
9136
+ # The OCR parsing configurations for documents.
9137
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
9138
+ include Google::Apis::Core::Hashable
9139
+
9140
+ # Apply additional enhanced OCR processing to a list of document elements.
9141
+ # Supported values: * `table`: advanced table parsing model.
9142
+ # Corresponds to the JSON property `enhancedDocumentElements`
9143
+ # @return [Array<String>]
9144
+ attr_accessor :enhanced_document_elements
9145
+
9146
+ # If true, will use native text instead of OCR text on pages containing native
9147
+ # text.
9148
+ # Corresponds to the JSON property `useNativeText`
9149
+ # @return [Boolean]
9150
+ attr_accessor :use_native_text
9151
+ alias_method :use_native_text?, :use_native_text
9152
+
9153
+ def initialize(**args)
9154
+ update!(**args)
9155
+ end
9156
+
9157
+ # Update properties of this object
9158
+ def update!(**args)
9159
+ @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
9160
+ @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
9161
+ end
9162
+ end
9163
+
8989
9164
  # Metadata related to the progress of the SiteSearchEngineService.
8990
9165
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
8991
9166
  # longrunning.Operation.metadata field.
@@ -9493,34 +9668,6 @@ module Google
9493
9668
  end
9494
9669
  end
9495
9670
 
9496
- # The OCR parsing configurations for documents.
9497
- class GoogleCloudDiscoveryengineV1betaOcrParsingConfig
9498
- include Google::Apis::Core::Hashable
9499
-
9500
- # Apply additional enhanced OCR processing to a list of document elements.
9501
- # Supported values: * `table`: advanced table parsing model.
9502
- # Corresponds to the JSON property `enhancedDocumentElements`
9503
- # @return [Array<String>]
9504
- attr_accessor :enhanced_document_elements
9505
-
9506
- # If true, will use native text instead of OCR text on pages containing native
9507
- # text.
9508
- # Corresponds to the JSON property `useNativeText`
9509
- # @return [Boolean]
9510
- attr_accessor :use_native_text
9511
- alias_method :use_native_text?, :use_native_text
9512
-
9513
- def initialize(**args)
9514
- update!(**args)
9515
- end
9516
-
9517
- # Update properties of this object
9518
- def update!(**args)
9519
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
9520
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
9521
- end
9522
- end
9523
-
9524
9671
  # Metadata related to the progress of the PurgeDocuments operation. This will be
9525
9672
  # returned by the google.longrunning.Operation.metadata field.
9526
9673
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -9823,6 +9970,68 @@ module Google
9823
9970
  end
9824
9971
  end
9825
9972
 
9973
+ # Metadata related to the progress of the TrainCustomModel operation. This is
9974
+ # returned by the google.longrunning.Operation.metadata field.
9975
+ class GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata
9976
+ include Google::Apis::Core::Hashable
9977
+
9978
+ # Operation create time.
9979
+ # Corresponds to the JSON property `createTime`
9980
+ # @return [String]
9981
+ attr_accessor :create_time
9982
+
9983
+ # Operation last update time. If the operation is done, this is also the finish
9984
+ # time.
9985
+ # Corresponds to the JSON property `updateTime`
9986
+ # @return [String]
9987
+ attr_accessor :update_time
9988
+
9989
+ def initialize(**args)
9990
+ update!(**args)
9991
+ end
9992
+
9993
+ # Update properties of this object
9994
+ def update!(**args)
9995
+ @create_time = args[:create_time] if args.key?(:create_time)
9996
+ @update_time = args[:update_time] if args.key?(:update_time)
9997
+ end
9998
+ end
9999
+
10000
+ # Response of the TrainCustomModelRequest. This message is returned by the
10001
+ # google.longrunning.Operations.response field.
10002
+ class GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse
10003
+ include Google::Apis::Core::Hashable
10004
+
10005
+ # Configuration of destination for Import related errors.
10006
+ # Corresponds to the JSON property `errorConfig`
10007
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaImportErrorConfig]
10008
+ attr_accessor :error_config
10009
+
10010
+ # A sample of errors encountered while processing the data.
10011
+ # Corresponds to the JSON property `errorSamples`
10012
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
10013
+ attr_accessor :error_samples
10014
+
10015
+ # The trained model status. Possible values are: * **bad-data**: The training
10016
+ # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
10017
+ # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
10018
+ # The model is ready for serving.
10019
+ # Corresponds to the JSON property `modelStatus`
10020
+ # @return [String]
10021
+ attr_accessor :model_status
10022
+
10023
+ def initialize(**args)
10024
+ update!(**args)
10025
+ end
10026
+
10027
+ # Update properties of this object
10028
+ def update!(**args)
10029
+ @error_config = args[:error_config] if args.key?(:error_config)
10030
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
10031
+ @model_status = args[:model_status] if args.key?(:model_status)
10032
+ end
10033
+ end
10034
+
9826
10035
  # Metadata for UpdateSchema LRO.
9827
10036
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
9828
10037
  include Google::Apis::Core::Hashable