google-apis-discoveryengine_v1beta 0.38.0 → 0.39.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.
@@ -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::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DigitalParsingConfig]
708
+ # @return [Google::Apis::DiscoveryengineV1beta::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::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1OcrParsingConfig]
713
+ # @return [Google::Apis::DiscoveryengineV1beta::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
@@ -2016,19 +2016,6 @@ module Google
2016
2016
  end
2017
2017
  end
2018
2018
 
2019
- # The digital parsing configurations for documents.
2020
- class GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig
2021
- include Google::Apis::Core::Hashable
2022
-
2023
- def initialize(**args)
2024
- update!(**args)
2025
- end
2026
-
2027
- # Update properties of this object
2028
- def update!(**args)
2029
- end
2030
- end
2031
-
2032
2019
  # Metadata related to the progress of the SiteSearchEngineService.
2033
2020
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
2034
2021
  # longrunning.Operation.metadata field.
@@ -2092,11 +2079,6 @@ module Google
2092
2079
  # @return [String]
2093
2080
  attr_accessor :name
2094
2081
 
2095
- # The OCR options for parsing documents.
2096
- # Corresponds to the JSON property `ocrConfig`
2097
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaOcrConfig]
2098
- attr_accessor :ocr_config
2099
-
2100
2082
  # Map from file type to override the default parsing configuration based on the
2101
2083
  # file type. Supported keys: * `pdf`: Override parsing config for PDF files,
2102
2084
  # either digital parsing, ocr parsing or layout parsing is supported. * `html`:
@@ -2116,7 +2098,6 @@ module Google
2116
2098
  @chunking_config = args[:chunking_config] if args.key?(:chunking_config)
2117
2099
  @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
2118
2100
  @name = args[:name] if args.key?(:name)
2119
- @ocr_config = args[:ocr_config] if args.key?(:ocr_config)
2120
2101
  @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
2121
2102
  end
2122
2103
  end
@@ -2174,17 +2155,17 @@ module Google
2174
2155
 
2175
2156
  # The digital parsing configurations for documents.
2176
2157
  # Corresponds to the JSON property `digitalParsingConfig`
2177
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig]
2158
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
2178
2159
  attr_accessor :digital_parsing_config
2179
2160
 
2180
2161
  # The layout parsing configurations for documents.
2181
2162
  # Corresponds to the JSON property `layoutParsingConfig`
2182
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig]
2163
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig]
2183
2164
  attr_accessor :layout_parsing_config
2184
2165
 
2185
2166
  # The OCR parsing configurations for documents.
2186
2167
  # Corresponds to the JSON property `ocrParsingConfig`
2187
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaOcrParsingConfig]
2168
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig]
2188
2169
  attr_accessor :ocr_parsing_config
2189
2170
 
2190
2171
  def initialize(**args)
@@ -2199,6 +2180,60 @@ module Google
2199
2180
  end
2200
2181
  end
2201
2182
 
2183
+ # The digital parsing configurations for documents.
2184
+ class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig
2185
+ include Google::Apis::Core::Hashable
2186
+
2187
+ def initialize(**args)
2188
+ update!(**args)
2189
+ end
2190
+
2191
+ # Update properties of this object
2192
+ def update!(**args)
2193
+ end
2194
+ end
2195
+
2196
+ # The layout parsing configurations for documents.
2197
+ class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig
2198
+ include Google::Apis::Core::Hashable
2199
+
2200
+ def initialize(**args)
2201
+ update!(**args)
2202
+ end
2203
+
2204
+ # Update properties of this object
2205
+ def update!(**args)
2206
+ end
2207
+ end
2208
+
2209
+ # The OCR parsing configurations for documents.
2210
+ class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig
2211
+ include Google::Apis::Core::Hashable
2212
+
2213
+ # Apply additional enhanced OCR processing to a list of document elements.
2214
+ # Supported values: * `table`: advanced table parsing model.
2215
+ # Corresponds to the JSON property `enhancedDocumentElements`
2216
+ # @return [Array<String>]
2217
+ attr_accessor :enhanced_document_elements
2218
+
2219
+ # If true, will use native text instead of OCR text on pages containing native
2220
+ # text.
2221
+ # Corresponds to the JSON property `useNativeText`
2222
+ # @return [Boolean]
2223
+ attr_accessor :use_native_text
2224
+ alias_method :use_native_text?, :use_native_text
2225
+
2226
+ def initialize(**args)
2227
+ update!(**args)
2228
+ end
2229
+
2230
+ # Update properties of this object
2231
+ def update!(**args)
2232
+ @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
2233
+ @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
2234
+ end
2235
+ end
2236
+
2202
2237
  # Metadata related to the progress of the SiteSearchEngineService.
2203
2238
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
2204
2239
  # longrunning.Operation.metadata field.
@@ -2244,14 +2279,6 @@ module Google
2244
2279
  class GoogleCloudDiscoveryengineV1alphaEngine
2245
2280
  include Google::Apis::Core::Hashable
2246
2281
 
2247
- # Whether the search engine can associate with multiple data stores. If true,
2248
- # the generic search engine can associate with one or more data stores. This is
2249
- # an input-only field.
2250
- # Corresponds to the JSON property `allowMultipleDataStoresSearchEngine`
2251
- # @return [Boolean]
2252
- attr_accessor :allow_multiple_data_stores_search_engine
2253
- alias_method :allow_multiple_data_stores_search_engine?, :allow_multiple_data_stores_search_engine
2254
-
2255
2282
  # Configurations for a Chat Engine.
2256
2283
  # Corresponds to the JSON property `chatEngineConfig`
2257
2284
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
@@ -2342,7 +2369,6 @@ module Google
2342
2369
 
2343
2370
  # Update properties of this object
2344
2371
  def update!(**args)
2345
- @allow_multiple_data_stores_search_engine = args[:allow_multiple_data_stores_search_engine] if args.key?(:allow_multiple_data_stores_search_engine)
2346
2372
  @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
2347
2373
  @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
2348
2374
  @common_config = args[:common_config] if args.key?(:common_config)
@@ -3076,84 +3102,6 @@ module Google
3076
3102
  end
3077
3103
  end
3078
3104
 
3079
- # The layout parsing configurations for documents.
3080
- class GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig
3081
- include Google::Apis::Core::Hashable
3082
-
3083
- def initialize(**args)
3084
- update!(**args)
3085
- end
3086
-
3087
- # Update properties of this object
3088
- def update!(**args)
3089
- end
3090
- end
3091
-
3092
- # The OCR options for parsing documents.
3093
- class GoogleCloudDiscoveryengineV1alphaOcrConfig
3094
- include Google::Apis::Core::Hashable
3095
-
3096
- # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig
3097
- # options to apply. We will only perform OCR on the first 80 pages of the PDF
3098
- # files.
3099
- # Corresponds to the JSON property `enabled`
3100
- # @return [Boolean]
3101
- attr_accessor :enabled
3102
- alias_method :enabled?, :enabled
3103
-
3104
- # Apply additional enhanced OCR processing to a list of document elements.
3105
- # Supported values: * `table`: advanced table parsing model.
3106
- # Corresponds to the JSON property `enhancedDocumentElements`
3107
- # @return [Array<String>]
3108
- attr_accessor :enhanced_document_elements
3109
-
3110
- # If true, will use native text instead of OCR text on pages containing native
3111
- # text.
3112
- # Corresponds to the JSON property `useNativeText`
3113
- # @return [Boolean]
3114
- attr_accessor :use_native_text
3115
- alias_method :use_native_text?, :use_native_text
3116
-
3117
- def initialize(**args)
3118
- update!(**args)
3119
- end
3120
-
3121
- # Update properties of this object
3122
- def update!(**args)
3123
- @enabled = args[:enabled] if args.key?(:enabled)
3124
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
3125
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
3126
- end
3127
- end
3128
-
3129
- # The OCR parsing configurations for documents.
3130
- class GoogleCloudDiscoveryengineV1alphaOcrParsingConfig
3131
- include Google::Apis::Core::Hashable
3132
-
3133
- # Apply additional enhanced OCR processing to a list of document elements.
3134
- # Supported values: * `table`: advanced table parsing model.
3135
- # Corresponds to the JSON property `enhancedDocumentElements`
3136
- # @return [Array<String>]
3137
- attr_accessor :enhanced_document_elements
3138
-
3139
- # If true, will use native text instead of OCR text on pages containing native
3140
- # text.
3141
- # Corresponds to the JSON property `useNativeText`
3142
- # @return [Boolean]
3143
- attr_accessor :use_native_text
3144
- alias_method :use_native_text?, :use_native_text
3145
-
3146
- def initialize(**args)
3147
- update!(**args)
3148
- end
3149
-
3150
- # Update properties of this object
3151
- def update!(**args)
3152
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
3153
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
3154
- end
3155
- end
3156
-
3157
3105
  # Metadata related to the progress of the PurgeDocuments operation. This will be
3158
3106
  # returned by the google.longrunning.Operation.metadata field.
3159
3107
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -4628,19 +4576,6 @@ module Google
4628
4576
  end
4629
4577
  end
4630
4578
 
4631
- # The digital parsing configurations for documents.
4632
- class GoogleCloudDiscoveryengineV1betaDigitalParsingConfig
4633
- include Google::Apis::Core::Hashable
4634
-
4635
- def initialize(**args)
4636
- update!(**args)
4637
- end
4638
-
4639
- # Update properties of this object
4640
- def update!(**args)
4641
- end
4642
- end
4643
-
4644
4579
  # Metadata related to the progress of the SiteSearchEngineService.
4645
4580
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
4646
4581
  # longrunning.Operation.metadata field.
@@ -4913,12 +4848,12 @@ module Google
4913
4848
 
4914
4849
  # The digital parsing configurations for documents.
4915
4850
  # Corresponds to the JSON property `digitalParsingConfig`
4916
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDigitalParsingConfig]
4851
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
4917
4852
  attr_accessor :digital_parsing_config
4918
4853
 
4919
4854
  # The OCR parsing configurations for documents.
4920
4855
  # Corresponds to the JSON property `ocrParsingConfig`
4921
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaOcrParsingConfig]
4856
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig]
4922
4857
  attr_accessor :ocr_parsing_config
4923
4858
 
4924
4859
  def initialize(**args)
@@ -4932,6 +4867,47 @@ module Google
4932
4867
  end
4933
4868
  end
4934
4869
 
4870
+ # The digital parsing configurations for documents.
4871
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig
4872
+ include Google::Apis::Core::Hashable
4873
+
4874
+ def initialize(**args)
4875
+ update!(**args)
4876
+ end
4877
+
4878
+ # Update properties of this object
4879
+ def update!(**args)
4880
+ end
4881
+ end
4882
+
4883
+ # The OCR parsing configurations for documents.
4884
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
4885
+ include Google::Apis::Core::Hashable
4886
+
4887
+ # Apply additional enhanced OCR processing to a list of document elements.
4888
+ # Supported values: * `table`: advanced table parsing model.
4889
+ # Corresponds to the JSON property `enhancedDocumentElements`
4890
+ # @return [Array<String>]
4891
+ attr_accessor :enhanced_document_elements
4892
+
4893
+ # If true, will use native text instead of OCR text on pages containing native
4894
+ # text.
4895
+ # Corresponds to the JSON property `useNativeText`
4896
+ # @return [Boolean]
4897
+ attr_accessor :use_native_text
4898
+ alias_method :use_native_text?, :use_native_text
4899
+
4900
+ def initialize(**args)
4901
+ update!(**args)
4902
+ end
4903
+
4904
+ # Update properties of this object
4905
+ def update!(**args)
4906
+ @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
4907
+ @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
4908
+ end
4909
+ end
4910
+
4935
4911
  # Double list.
4936
4912
  class GoogleCloudDiscoveryengineV1betaDoubleList
4937
4913
  include Google::Apis::Core::Hashable
@@ -6014,34 +5990,6 @@ module Google
6014
5990
  end
6015
5991
  end
6016
5992
 
6017
- # The OCR parsing configurations for documents.
6018
- class GoogleCloudDiscoveryengineV1betaOcrParsingConfig
6019
- include Google::Apis::Core::Hashable
6020
-
6021
- # Apply additional enhanced OCR processing to a list of document elements.
6022
- # Supported values: * `table`: advanced table parsing model.
6023
- # Corresponds to the JSON property `enhancedDocumentElements`
6024
- # @return [Array<String>]
6025
- attr_accessor :enhanced_document_elements
6026
-
6027
- # If true, will use native text instead of OCR text on pages containing native
6028
- # text.
6029
- # Corresponds to the JSON property `useNativeText`
6030
- # @return [Boolean]
6031
- attr_accessor :use_native_text
6032
- alias_method :use_native_text?, :use_native_text
6033
-
6034
- def initialize(**args)
6035
- update!(**args)
6036
- end
6037
-
6038
- # Update properties of this object
6039
- def update!(**args)
6040
- @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
6041
- @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
6042
- end
6043
- end
6044
-
6045
5993
  # Detailed page information.
6046
5994
  class GoogleCloudDiscoveryengineV1betaPageInfo
6047
5995
  include Google::Apis::Core::Hashable
@@ -6676,6 +6624,11 @@ module Google
6676
6624
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
6677
6625
  attr_accessor :content_search_spec
6678
6626
 
6627
+ # A list of data store specs to apply on a search call.
6628
+ # Corresponds to the JSON property `dataStoreSpecs`
6629
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
6630
+ attr_accessor :data_store_specs
6631
+
6679
6632
  # The specification that uses customized query embedding vector to do semantic
6680
6633
  # document retrieval.
6681
6634
  # Corresponds to the JSON property `embeddingSpec`
@@ -6831,6 +6784,7 @@ module Google
6831
6784
  @branch = args[:branch] if args.key?(:branch)
6832
6785
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
6833
6786
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
6787
+ @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
6834
6788
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
6835
6789
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
6836
6790
  @filter = args[:filter] if args.key?(:filter)
@@ -6894,8 +6848,8 @@ module Google
6894
6848
  # An expression which specifies a boost condition. The syntax and supported
6895
6849
  # fields are the same as a filter expression. See SearchRequest.filter for
6896
6850
  # detail syntax and limitations. Examples: * To boost documents with document ID
6897
- # "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "
6898
- # doc_2")) AND (color: ANY("Red", "Blue"))
6851
+ # "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "
6852
+ # doc_2")) AND (color: ANY("Red", "Blue"))`
6899
6853
  # Corresponds to the JSON property `condition`
6900
6854
  # @return [String]
6901
6855
  attr_accessor :condition
@@ -6981,6 +6935,15 @@ module Google
6981
6935
  # @return [Fixnum]
6982
6936
  attr_accessor :num_previous_segments
6983
6937
 
6938
+ # Specifies whether to return the confidence score from the extractive segments
6939
+ # in each search result. This feature is available only for new or allowlisted
6940
+ # data stores. To allowlist your data store, please contact your Customer
6941
+ # Engineer. The default value is `false`.
6942
+ # Corresponds to the JSON property `returnExtractiveSegmentScore`
6943
+ # @return [Boolean]
6944
+ attr_accessor :return_extractive_segment_score
6945
+ alias_method :return_extractive_segment_score?, :return_extractive_segment_score
6946
+
6984
6947
  def initialize(**args)
6985
6948
  update!(**args)
6986
6949
  end
@@ -6991,6 +6954,7 @@ module Google
6991
6954
  @max_extractive_segment_count = args[:max_extractive_segment_count] if args.key?(:max_extractive_segment_count)
6992
6955
  @num_next_segments = args[:num_next_segments] if args.key?(:num_next_segments)
6993
6956
  @num_previous_segments = args[:num_previous_segments] if args.key?(:num_previous_segments)
6957
+ @return_extractive_segment_score = args[:return_extractive_segment_score] if args.key?(:return_extractive_segment_score)
6994
6958
  end
6995
6959
  end
6996
6960
 
@@ -7093,8 +7057,7 @@ module Google
7093
7057
 
7094
7058
  # The number of top results to generate the summary from. If the number of
7095
7059
  # results returned is less than `summaryResultCount`, the summary is generated
7096
- # from all of the results. At most five results can be used to generate a
7097
- # summary.
7060
+ # from all of the results. At most 10 results can be used to generate a summary.
7098
7061
  # Corresponds to the JSON property `summaryResultCount`
7099
7062
  # @return [Fixnum]
7100
7063
  attr_accessor :summary_result_count
@@ -7141,9 +7104,12 @@ module Google
7141
7104
 
7142
7105
  # The model version used to generate the summary. Supported values are: * `
7143
7106
  # stable`: string. Default value when no value is specified. Uses a generally
7144
- # available, fine-tuned version of the text-bison@001 model. * `preview`: string.
7145
- # (Public preview) Uses a fine-tuned version of the text-bison@002 model. This
7146
- # model works only for summaries in English.
7107
+ # available, fine-tuned model. For more information, see [Answer generation
7108
+ # model versions and lifecycle](https://cloud.google.com/generative-ai-app-
7109
+ # builder/docs/answer-generation-models). * `preview`: string. (Public preview)
7110
+ # Uses a preview model. For more information, see [Answer generation model
7111
+ # versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/
7112
+ # docs/answer-generation-models).
7147
7113
  # Corresponds to the JSON property `version`
7148
7114
  # @return [String]
7149
7115
  attr_accessor :version
@@ -7158,6 +7124,26 @@ module Google
7158
7124
  end
7159
7125
  end
7160
7126
 
7127
+ # A struct to define data stores to filter on in a search call.
7128
+ class GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec
7129
+ include Google::Apis::Core::Hashable
7130
+
7131
+ # Required. Full resource name of DataStore, such as `projects/`project`/
7132
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
7133
+ # Corresponds to the JSON property `dataStore`
7134
+ # @return [String]
7135
+ attr_accessor :data_store
7136
+
7137
+ def initialize(**args)
7138
+ update!(**args)
7139
+ end
7140
+
7141
+ # Update properties of this object
7142
+ def update!(**args)
7143
+ @data_store = args[:data_store] if args.key?(:data_store)
7144
+ end
7145
+ end
7146
+
7161
7147
  # The specification that uses customized query embedding vector to do semantic
7162
7148
  # document retrieval.
7163
7149
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
@@ -8005,7 +7991,7 @@ module Google
8005
7991
  attr_accessor :model_id
8006
7992
 
8007
7993
  # Immutable. Fully qualified name `projects/`project`/locations/`location`/
8008
- # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
7994
+ # collections/`collection_id`/engines/`engine_id`/servingConfigs/`
8009
7995
  # serving_config_id``
8010
7996
  # Corresponds to the JSON property `name`
8011
7997
  # @return [String]
@@ -8137,11 +8123,6 @@ module Google
8137
8123
  # @return [Fixnum]
8138
8124
  attr_accessor :content_freshness_cutoff_days
8139
8125
 
8140
- # Specifies the content watched minutes threshold for demotion.
8141
- # Corresponds to the JSON property `contentWatchedMinutesThreshold`
8142
- # @return [Float]
8143
- attr_accessor :content_watched_minutes_threshold
8144
-
8145
8126
  # Specifies the content watched percentage threshold for demotion. Threshold
8146
8127
  # value must be between [0, 1.0] inclusive.
8147
8128
  # Corresponds to the JSON property `contentWatchedPercentageThreshold`
@@ -8169,7 +8150,6 @@ module Google
8169
8150
  # Update properties of this object
8170
8151
  def update!(**args)
8171
8152
  @content_freshness_cutoff_days = args[:content_freshness_cutoff_days] if args.key?(:content_freshness_cutoff_days)
8172
- @content_watched_minutes_threshold = args[:content_watched_minutes_threshold] if args.key?(:content_watched_minutes_threshold)
8173
8153
  @content_watched_percentage_threshold = args[:content_watched_percentage_threshold] if args.key?(:content_watched_percentage_threshold)
8174
8154
  @content_watched_seconds_threshold = args[:content_watched_seconds_threshold] if args.key?(:content_watched_seconds_threshold)
8175
8155
  @demotion_event_type = args[:demotion_event_type] if args.key?(:demotion_event_type)
@@ -8392,6 +8372,149 @@ module Google
8392
8372
  end
8393
8373
  end
8394
8374
 
8375
+ # Metadata related to the progress of the TrainCustomModel operation. This is
8376
+ # returned by the google.longrunning.Operation.metadata field.
8377
+ class GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata
8378
+ include Google::Apis::Core::Hashable
8379
+
8380
+ # Operation create time.
8381
+ # Corresponds to the JSON property `createTime`
8382
+ # @return [String]
8383
+ attr_accessor :create_time
8384
+
8385
+ # Operation last update time. If the operation is done, this is also the finish
8386
+ # time.
8387
+ # Corresponds to the JSON property `updateTime`
8388
+ # @return [String]
8389
+ attr_accessor :update_time
8390
+
8391
+ def initialize(**args)
8392
+ update!(**args)
8393
+ end
8394
+
8395
+ # Update properties of this object
8396
+ def update!(**args)
8397
+ @create_time = args[:create_time] if args.key?(:create_time)
8398
+ @update_time = args[:update_time] if args.key?(:update_time)
8399
+ end
8400
+ end
8401
+
8402
+ # Request message for SearchTuningService.TrainCustomModel method.
8403
+ class GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
8404
+ include Google::Apis::Core::Hashable
8405
+
8406
+ # Configuration of destination for Import related errors.
8407
+ # Corresponds to the JSON property `errorConfig`
8408
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig]
8409
+ attr_accessor :error_config
8410
+
8411
+ # Cloud Storage training data input.
8412
+ # Corresponds to the JSON property `gcsTrainingInput`
8413
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput]
8414
+ attr_accessor :gcs_training_input
8415
+
8416
+ # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
8417
+ # the search system based on data provided.
8418
+ # Corresponds to the JSON property `modelType`
8419
+ # @return [String]
8420
+ attr_accessor :model_type
8421
+
8422
+ def initialize(**args)
8423
+ update!(**args)
8424
+ end
8425
+
8426
+ # Update properties of this object
8427
+ def update!(**args)
8428
+ @error_config = args[:error_config] if args.key?(:error_config)
8429
+ @gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
8430
+ @model_type = args[:model_type] if args.key?(:model_type)
8431
+ end
8432
+ end
8433
+
8434
+ # Cloud Storage training data input.
8435
+ class GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput
8436
+ include Google::Apis::Core::Hashable
8437
+
8438
+ # The Cloud Storage corpus data which could be associated in train data. The
8439
+ # data path format is `gs:///`. A newline delimited jsonl/ndjson file. For
8440
+ # search-tuning model, each line should have the _id, title and text. Example: ``
8441
+ # "_id": "doc1", title: "relevant doc", "text": "relevant text"``
8442
+ # Corresponds to the JSON property `corpusDataPath`
8443
+ # @return [String]
8444
+ attr_accessor :corpus_data_path
8445
+
8446
+ # The gcs query data which could be associated in train data. The data path
8447
+ # format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning
8448
+ # model, each line should have the _id and text. Example: `"_id": "query1", "
8449
+ # text": "example query"`
8450
+ # Corresponds to the JSON property `queryDataPath`
8451
+ # @return [String]
8452
+ attr_accessor :query_data_path
8453
+
8454
+ # Cloud Storage test data. Same format as train_data_path. If not provided, a
8455
+ # random 80/20 train/test split will be performed on train_data_path.
8456
+ # Corresponds to the JSON property `testDataPath`
8457
+ # @return [String]
8458
+ attr_accessor :test_data_path
8459
+
8460
+ # Cloud Storage training data path whose format should be `gs:///`. The file
8461
+ # should be in tsv format. Each line should have the doc_id and query_id and
8462
+ # score (number). For search-tuning model, it should have the query-id corpus-id
8463
+ # score as tsv file header. The score should be a number in `[0, inf+)`. The
8464
+ # larger the number is, the more relevant the pair is. Example: * `query-id\
8465
+ # tcorpus-id\tscore` * `query1\tdoc1\t1`
8466
+ # Corresponds to the JSON property `trainDataPath`
8467
+ # @return [String]
8468
+ attr_accessor :train_data_path
8469
+
8470
+ def initialize(**args)
8471
+ update!(**args)
8472
+ end
8473
+
8474
+ # Update properties of this object
8475
+ def update!(**args)
8476
+ @corpus_data_path = args[:corpus_data_path] if args.key?(:corpus_data_path)
8477
+ @query_data_path = args[:query_data_path] if args.key?(:query_data_path)
8478
+ @test_data_path = args[:test_data_path] if args.key?(:test_data_path)
8479
+ @train_data_path = args[:train_data_path] if args.key?(:train_data_path)
8480
+ end
8481
+ end
8482
+
8483
+ # Response of the TrainCustomModelRequest. This message is returned by the
8484
+ # google.longrunning.Operations.response field.
8485
+ class GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse
8486
+ include Google::Apis::Core::Hashable
8487
+
8488
+ # Configuration of destination for Import related errors.
8489
+ # Corresponds to the JSON property `errorConfig`
8490
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig]
8491
+ attr_accessor :error_config
8492
+
8493
+ # A sample of errors encountered while processing the data.
8494
+ # Corresponds to the JSON property `errorSamples`
8495
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
8496
+ attr_accessor :error_samples
8497
+
8498
+ # The trained model status. Possible values are: * **bad-data**: The training
8499
+ # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
8500
+ # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
8501
+ # The model is ready for serving.
8502
+ # Corresponds to the JSON property `modelStatus`
8503
+ # @return [String]
8504
+ attr_accessor :model_status
8505
+
8506
+ def initialize(**args)
8507
+ update!(**args)
8508
+ end
8509
+
8510
+ # Update properties of this object
8511
+ def update!(**args)
8512
+ @error_config = args[:error_config] if args.key?(:error_config)
8513
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
8514
+ @model_status = args[:model_status] if args.key?(:model_status)
8515
+ end
8516
+ end
8517
+
8395
8518
  # A transaction represents the entire purchase transaction.
8396
8519
  class GoogleCloudDiscoveryengineV1betaTransactionInfo
8397
8520
  include Google::Apis::Core::Hashable