google-apis-discoveryengine_v1alpha 0.36.0 → 0.38.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -459,6 +459,13 @@ module Google
459
459
  # @return [String]
460
460
  attr_accessor :display_name
461
461
 
462
+ # A singleton resource of DataStore. It's empty when DataStore is created, which
463
+ # defaults to digital parser. The first call to DataStoreService.
464
+ # UpdateDocumentProcessingConfig method will initialize the config.
465
+ # Corresponds to the JSON property `documentProcessingConfig`
466
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DocumentProcessingConfig]
467
+ attr_accessor :document_processing_config
468
+
462
469
  # Immutable. The industry vertical that the data store registers.
463
470
  # Corresponds to the JSON property `industryVertical`
464
471
  # @return [String]
@@ -480,6 +487,11 @@ module Google
480
487
  # @return [Array<String>]
481
488
  attr_accessor :solution_types
482
489
 
490
+ # Defines the structure and layout of a type of document data.
491
+ # Corresponds to the JSON property `startingSchema`
492
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1Schema]
493
+ attr_accessor :starting_schema
494
+
483
495
  def initialize(**args)
484
496
  update!(**args)
485
497
  end
@@ -490,9 +502,11 @@ module Google
490
502
  @create_time = args[:create_time] if args.key?(:create_time)
491
503
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
492
504
  @display_name = args[:display_name] if args.key?(:display_name)
505
+ @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
493
506
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
494
507
  @name = args[:name] if args.key?(:name)
495
508
  @solution_types = args[:solution_types] if args.key?(:solution_types)
509
+ @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
496
510
  end
497
511
  end
498
512
 
@@ -605,6 +619,19 @@ module Google
605
619
  end
606
620
  end
607
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
+
608
635
  # Metadata related to the progress of the SiteSearchEngineService.
609
636
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
610
637
  # longrunning.Operation.metadata field.
@@ -646,6 +673,70 @@ module Google
646
673
  end
647
674
  end
648
675
 
676
+ # A singleton resource of DataStore. It's empty when DataStore is created, which
677
+ # defaults to digital parser. The first call to DataStoreService.
678
+ # UpdateDocumentProcessingConfig method will initialize the config.
679
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfig
680
+ include Google::Apis::Core::Hashable
681
+
682
+ # Related configurations applied to a specific type of document parser.
683
+ # Corresponds to the JSON property `defaultParsingConfig`
684
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig]
685
+ attr_accessor :default_parsing_config
686
+
687
+ # The full resource name of the Document Processing Config. Format: `projects/*/
688
+ # locations/*/collections/*/dataStores/*/documentProcessingConfig`.
689
+ # Corresponds to the JSON property `name`
690
+ # @return [String]
691
+ attr_accessor :name
692
+
693
+ # Map from file type to override the default parsing configuration based on the
694
+ # file type. Supported keys: * `pdf`: Override parsing config for PDF files,
695
+ # either digital parsing, ocr parsing or layout parsing is supported. * `html`:
696
+ # Override parsing config for HTML files, only digital parsing and or layout
697
+ # parsing are supported. * `docx`: Override parsing config for DOCX files, only
698
+ # digital parsing and or layout parsing are supported.
699
+ # Corresponds to the JSON property `parsingConfigOverrides`
700
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig>]
701
+ attr_accessor :parsing_config_overrides
702
+
703
+ def initialize(**args)
704
+ update!(**args)
705
+ end
706
+
707
+ # Update properties of this object
708
+ def update!(**args)
709
+ @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
710
+ @name = args[:name] if args.key?(:name)
711
+ @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
712
+ end
713
+ end
714
+
715
+ # Related configurations applied to a specific type of document parser.
716
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig
717
+ include Google::Apis::Core::Hashable
718
+
719
+ # The digital parsing configurations for documents.
720
+ # Corresponds to the JSON property `digitalParsingConfig`
721
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1DigitalParsingConfig]
722
+ attr_accessor :digital_parsing_config
723
+
724
+ # The OCR parsing configurations for documents.
725
+ # Corresponds to the JSON property `ocrParsingConfig`
726
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1OcrParsingConfig]
727
+ attr_accessor :ocr_parsing_config
728
+
729
+ def initialize(**args)
730
+ update!(**args)
731
+ end
732
+
733
+ # Update properties of this object
734
+ def update!(**args)
735
+ @digital_parsing_config = args[:digital_parsing_config] if args.key?(:digital_parsing_config)
736
+ @ocr_parsing_config = args[:ocr_parsing_config] if args.key?(:ocr_parsing_config)
737
+ end
738
+ end
739
+
649
740
  # Metadata related to the progress of the SiteSearchEngineService.
650
741
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
651
742
  # longrunning.Operation.metadata field.
@@ -1153,6 +1244,34 @@ module Google
1153
1244
  end
1154
1245
  end
1155
1246
 
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
+
1156
1275
  # Metadata related to the progress of the PurgeDocuments operation. This will be
1157
1276
  # returned by the google.longrunning.Operation.metadata field.
1158
1277
  class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
@@ -1168,6 +1287,11 @@ module Google
1168
1287
  # @return [Fixnum]
1169
1288
  attr_accessor :failure_count
1170
1289
 
1290
+ # Count of entries that were ignored as entries were not found.
1291
+ # Corresponds to the JSON property `ignoredCount`
1292
+ # @return [Fixnum]
1293
+ attr_accessor :ignored_count
1294
+
1171
1295
  # Count of entries that were deleted successfully.
1172
1296
  # Corresponds to the JSON property `successCount`
1173
1297
  # @return [Fixnum]
@@ -1187,6 +1311,7 @@ module Google
1187
1311
  def update!(**args)
1188
1312
  @create_time = args[:create_time] if args.key?(:create_time)
1189
1313
  @failure_count = args[:failure_count] if args.key?(:failure_count)
1314
+ @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
1190
1315
  @success_count = args[:success_count] if args.key?(:success_count)
1191
1316
  @update_time = args[:update_time] if args.key?(:update_time)
1192
1317
  end
@@ -1503,6 +1628,33 @@ module Google
1503
1628
  end
1504
1629
  end
1505
1630
 
1631
+ # Access Control Configuration.
1632
+ class GoogleCloudDiscoveryengineV1alphaAclConfig
1633
+ include Google::Apis::Core::Hashable
1634
+
1635
+ # Identity Provider Config.
1636
+ # Corresponds to the JSON property `idpConfig`
1637
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdpConfig]
1638
+ attr_accessor :idp_config
1639
+
1640
+ # Immutable. The full resource name of the acl configuration. Format: `projects/`
1641
+ # project`/locations/`location`/aclConfig`. This field must be a UTF-8 encoded
1642
+ # string with a length limit of 1024 characters.
1643
+ # Corresponds to the JSON property `name`
1644
+ # @return [String]
1645
+ attr_accessor :name
1646
+
1647
+ def initialize(**args)
1648
+ update!(**args)
1649
+ end
1650
+
1651
+ # Update properties of this object
1652
+ def update!(**args)
1653
+ @idp_config = args[:idp_config] if args.key?(:idp_config)
1654
+ @name = args[:name] if args.key?(:name)
1655
+ end
1656
+ end
1657
+
1506
1658
  # AdditionalParams message for WidgetService methods for security and privacy
1507
1659
  # enhancement.
1508
1660
  class GoogleCloudDiscoveryengineV1alphaAdditionalParams
@@ -1932,6 +2084,11 @@ module Google
1932
2084
  class GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
1933
2085
  include Google::Apis::Core::Hashable
1934
2086
 
2087
+ # Boost specification to boost certain documents.
2088
+ # Corresponds to the JSON property `boostSpec`
2089
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
2090
+ attr_accessor :boost_spec
2091
+
1935
2092
  # External conversation proto definition.
1936
2093
  # Corresponds to the JSON property `conversation`
1937
2094
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
@@ -2008,6 +2165,7 @@ module Google
2008
2165
 
2009
2166
  # Update properties of this object
2010
2167
  def update!(**args)
2168
+ @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
2011
2169
  @conversation = args[:conversation] if args.key?(:conversation)
2012
2170
  @filter = args[:filter] if args.key?(:filter)
2013
2171
  @name = args[:name] if args.key?(:name)
@@ -2249,6 +2407,17 @@ module Google
2249
2407
  class GoogleCloudDiscoveryengineV1alphaDataStore
2250
2408
  include Google::Apis::Core::Hashable
2251
2409
 
2410
+ # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
2411
+ # the source data must have ACL. ACL will be ingested when data is ingested by
2412
+ # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
2413
+ # Document can't be accessed by calling DocumentService.GetDocument or
2414
+ # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
2415
+ # industry vertical with non-`PUBLIC_WEBSITE` content config.
2416
+ # Corresponds to the JSON property `aclEnabled`
2417
+ # @return [Boolean]
2418
+ attr_accessor :acl_enabled
2419
+ alias_method :acl_enabled?, :acl_enabled
2420
+
2252
2421
  # Immutable. The content config of the data store. If this field is unset, the
2253
2422
  # server behavior defaults to ContentConfig.NO_CONTENT.
2254
2423
  # Corresponds to the JSON property `contentConfig`
@@ -2272,6 +2441,18 @@ module Google
2272
2441
  # @return [String]
2273
2442
  attr_accessor :display_name
2274
2443
 
2444
+ # A singleton resource of DataStore. It's empty when DataStore is created, which
2445
+ # defaults to digital parser. The first call to DataStoreService.
2446
+ # UpdateDocumentProcessingConfig method will initialize the config.
2447
+ # Corresponds to the JSON property `documentProcessingConfig`
2448
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
2449
+ attr_accessor :document_processing_config
2450
+
2451
+ # Identity Provider Config.
2452
+ # Corresponds to the JSON property `idpConfig`
2453
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdpConfig]
2454
+ attr_accessor :idp_config
2455
+
2275
2456
  # Immutable. The industry vertical that the data store registers.
2276
2457
  # Corresponds to the JSON property `industryVertical`
2277
2458
  # @return [String]
@@ -2293,19 +2474,28 @@ module Google
2293
2474
  # @return [Array<String>]
2294
2475
  attr_accessor :solution_types
2295
2476
 
2477
+ # Defines the structure and layout of a type of document data.
2478
+ # Corresponds to the JSON property `startingSchema`
2479
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema]
2480
+ attr_accessor :starting_schema
2481
+
2296
2482
  def initialize(**args)
2297
2483
  update!(**args)
2298
2484
  end
2299
2485
 
2300
2486
  # Update properties of this object
2301
2487
  def update!(**args)
2488
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
2302
2489
  @content_config = args[:content_config] if args.key?(:content_config)
2303
2490
  @create_time = args[:create_time] if args.key?(:create_time)
2304
2491
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
2305
2492
  @display_name = args[:display_name] if args.key?(:display_name)
2493
+ @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
2494
+ @idp_config = args[:idp_config] if args.key?(:idp_config)
2306
2495
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
2307
2496
  @name = args[:name] if args.key?(:name)
2308
2497
  @solution_types = args[:solution_types] if args.key?(:solution_types)
2498
+ @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
2309
2499
  end
2310
2500
  end
2311
2501
 
@@ -2490,6 +2680,11 @@ module Google
2490
2680
  class GoogleCloudDiscoveryengineV1alphaDocument
2491
2681
  include Google::Apis::Core::Hashable
2492
2682
 
2683
+ # ACL Information of the Document.
2684
+ # Corresponds to the JSON property `aclInfo`
2685
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentAclInfo]
2686
+ attr_accessor :acl_info
2687
+
2493
2688
  # Unstructured data linked to this document.
2494
2689
  # Corresponds to the JSON property `content`
2495
2690
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentContent]
@@ -2508,6 +2703,13 @@ module Google
2508
2703
  # @return [String]
2509
2704
  attr_accessor :id
2510
2705
 
2706
+ # Output only. The last time the document was indexed. If this field is set, the
2707
+ # document could be returned in search results. This field is OUTPUT_ONLY. If
2708
+ # this field is not populated, it means the document has never been indexed.
2709
+ # Corresponds to the JSON property `indexTime`
2710
+ # @return [String]
2711
+ attr_accessor :index_time
2712
+
2511
2713
  # The JSON string representation of the document. It should conform to the
2512
2714
  # registered Schema or an `INVALID_ARGUMENT` error is thrown.
2513
2715
  # Corresponds to the JSON property `jsonData`
@@ -2546,9 +2748,11 @@ module Google
2546
2748
 
2547
2749
  # Update properties of this object
2548
2750
  def update!(**args)
2751
+ @acl_info = args[:acl_info] if args.key?(:acl_info)
2549
2752
  @content = args[:content] if args.key?(:content)
2550
2753
  @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
2551
2754
  @id = args[:id] if args.key?(:id)
2755
+ @index_time = args[:index_time] if args.key?(:index_time)
2552
2756
  @json_data = args[:json_data] if args.key?(:json_data)
2553
2757
  @name = args[:name] if args.key?(:name)
2554
2758
  @parent_document_id = args[:parent_document_id] if args.key?(:parent_document_id)
@@ -2557,6 +2761,52 @@ module Google
2557
2761
  end
2558
2762
  end
2559
2763
 
2764
+ # ACL Information of the Document.
2765
+ class GoogleCloudDiscoveryengineV1alphaDocumentAclInfo
2766
+ include Google::Apis::Core::Hashable
2767
+
2768
+ #
2769
+ # Corresponds to the JSON property `readers`
2770
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction>]
2771
+ attr_accessor :readers
2772
+
2773
+ def initialize(**args)
2774
+ update!(**args)
2775
+ end
2776
+
2777
+ # Update properties of this object
2778
+ def update!(**args)
2779
+ @readers = args[:readers] if args.key?(:readers)
2780
+ end
2781
+ end
2782
+
2783
+ # AclRestriction to model complex inheritance restrictions. Example: Modeling a "
2784
+ # Both Permit" inheritance, where to access a child document, user needs to have
2785
+ # access to parent document. Document Hierarchy - Space_S --> Page_P. Readers:
2786
+ # Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL
2787
+ # Restriction - ` "acl_info": ` "readers": [ ` "principals": [ ` "group_id": "
2788
+ # group_1" `, ` "user_id": "user_1" ` ] ` ] ` ` Page_P ACL Restriction. ` "
2789
+ # acl_info": ` "readers": [ ` "principals": [ ` "group_id": "group_2" `, ` "
2790
+ # group_id": "group_3" `, ` "user_id": "user_2" ` ], `, ` "principals": [ ` "
2791
+ # group_id": "group_1" `, ` "user_id": "user_1" ` ], ` ] ` `
2792
+ class GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction
2793
+ include Google::Apis::Core::Hashable
2794
+
2795
+ # List of principals.
2796
+ # Corresponds to the JSON property `principals`
2797
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPrincipal>]
2798
+ attr_accessor :principals
2799
+
2800
+ def initialize(**args)
2801
+ update!(**args)
2802
+ end
2803
+
2804
+ # Update properties of this object
2805
+ def update!(**args)
2806
+ @principals = args[:principals] if args.key?(:principals)
2807
+ end
2808
+ end
2809
+
2560
2810
  # Unstructured data linked to this document.
2561
2811
  class GoogleCloudDiscoveryengineV1alphaDocumentContent
2562
2812
  include Google::Apis::Core::Hashable
@@ -2676,7 +2926,8 @@ module Google
2676
2926
  # file type. Supported keys: * `pdf`: Override parsing config for PDF files,
2677
2927
  # either digital parsing, ocr parsing or layout parsing is supported. * `html`:
2678
2928
  # Override parsing config for HTML files, only digital parsing and or layout
2679
- # parsing are supported.
2929
+ # parsing are supported. * `docx`: Override parsing config for DOCX files, only
2930
+ # digital parsing and or layout parsing are supported.
2680
2931
  # Corresponds to the JSON property `parsingConfigOverrides`
2681
2932
  # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig>]
2682
2933
  attr_accessor :parsing_config_overrides
@@ -2821,6 +3072,14 @@ module Google
2821
3072
  class GoogleCloudDiscoveryengineV1alphaEngine
2822
3073
  include Google::Apis::Core::Hashable
2823
3074
 
3075
+ # Whether the search engine can associate with multiple data stores. If true,
3076
+ # the generic search engine can associate with one or more data stores. This is
3077
+ # an input-only field.
3078
+ # Corresponds to the JSON property `allowMultipleDataStoresSearchEngine`
3079
+ # @return [Boolean]
3080
+ attr_accessor :allow_multiple_data_stores_search_engine
3081
+ alias_method :allow_multiple_data_stores_search_engine?, :allow_multiple_data_stores_search_engine
3082
+
2824
3083
  # Configurations for a Chat Engine.
2825
3084
  # Corresponds to the JSON property `chatEngineConfig`
2826
3085
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
@@ -2911,6 +3170,7 @@ module Google
2911
3170
 
2912
3171
  # Update properties of this object
2913
3172
  def update!(**args)
3173
+ @allow_multiple_data_stores_search_engine = args[:allow_multiple_data_stores_search_engine] if args.key?(:allow_multiple_data_stores_search_engine)
2914
3174
  @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
2915
3175
  @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
2916
3176
  @common_config = args[:common_config] if args.key?(:common_config)
@@ -3592,6 +3852,50 @@ module Google
3592
3852
  end
3593
3853
  end
3594
3854
 
3855
+ # Identity Provider Config.
3856
+ class GoogleCloudDiscoveryengineV1alphaIdpConfig
3857
+ include Google::Apis::Core::Hashable
3858
+
3859
+ # Third party IDP Config.
3860
+ # Corresponds to the JSON property `externalIdpConfig`
3861
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig]
3862
+ attr_accessor :external_idp_config
3863
+
3864
+ # Identity provider type configured.
3865
+ # Corresponds to the JSON property `idpType`
3866
+ # @return [String]
3867
+ attr_accessor :idp_type
3868
+
3869
+ def initialize(**args)
3870
+ update!(**args)
3871
+ end
3872
+
3873
+ # Update properties of this object
3874
+ def update!(**args)
3875
+ @external_idp_config = args[:external_idp_config] if args.key?(:external_idp_config)
3876
+ @idp_type = args[:idp_type] if args.key?(:idp_type)
3877
+ end
3878
+ end
3879
+
3880
+ # Third party IDP Config.
3881
+ class GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig
3882
+ include Google::Apis::Core::Hashable
3883
+
3884
+ # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
3885
+ # Corresponds to the JSON property `workforcePoolName`
3886
+ # @return [String]
3887
+ attr_accessor :workforce_pool_name
3888
+
3889
+ def initialize(**args)
3890
+ update!(**args)
3891
+ end
3892
+
3893
+ # Update properties of this object
3894
+ def update!(**args)
3895
+ @workforce_pool_name = args[:workforce_pool_name] if args.key?(:workforce_pool_name)
3896
+ end
3897
+ end
3898
+
3595
3899
  # Metadata related to the progress of the ImportDocuments operation. This is
3596
3900
  # returned by the google.longrunning.Operation.metadata field.
3597
3901
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -4489,6 +4793,37 @@ module Google
4489
4793
  end
4490
4794
  end
4491
4795
 
4796
+ # Principal identifier of a user or a group.
4797
+ class GoogleCloudDiscoveryengineV1alphaPrincipal
4798
+ include Google::Apis::Core::Hashable
4799
+
4800
+ # Group identifier. For Google Workspace user account, group_id should be the
4801
+ # google workspace group email. For non-google identity provider user account,
4802
+ # group_id is the mapped group identifier configured during the workforcepool
4803
+ # config.
4804
+ # Corresponds to the JSON property `groupId`
4805
+ # @return [String]
4806
+ attr_accessor :group_id
4807
+
4808
+ # User identifier. For Google Workspace user account, user_id should be the
4809
+ # google workspace user email. For non-google identity provider user account,
4810
+ # user_id is the mapped user identifier configured during the workforcepool
4811
+ # config.
4812
+ # Corresponds to the JSON property `userId`
4813
+ # @return [String]
4814
+ attr_accessor :user_id
4815
+
4816
+ def initialize(**args)
4817
+ update!(**args)
4818
+ end
4819
+
4820
+ # Update properties of this object
4821
+ def update!(**args)
4822
+ @group_id = args[:group_id] if args.key?(:group_id)
4823
+ @user_id = args[:user_id] if args.key?(:user_id)
4824
+ end
4825
+ end
4826
+
4492
4827
  # Metadata related to the progress of the PurgeDocuments operation. This will be
4493
4828
  # returned by the google.longrunning.Operation.metadata field.
4494
4829
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -4504,6 +4839,11 @@ module Google
4504
4839
  # @return [Fixnum]
4505
4840
  attr_accessor :failure_count
4506
4841
 
4842
+ # Count of entries that were ignored as entries were not found.
4843
+ # Corresponds to the JSON property `ignoredCount`
4844
+ # @return [Fixnum]
4845
+ attr_accessor :ignored_count
4846
+
4507
4847
  # Count of entries that were deleted successfully.
4508
4848
  # Corresponds to the JSON property `successCount`
4509
4849
  # @return [Fixnum]
@@ -4523,6 +4863,7 @@ module Google
4523
4863
  def update!(**args)
4524
4864
  @create_time = args[:create_time] if args.key?(:create_time)
4525
4865
  @failure_count = args[:failure_count] if args.key?(:failure_count)
4866
+ @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
4526
4867
  @success_count = args[:success_count] if args.key?(:success_count)
4527
4868
  @update_time = args[:update_time] if args.key?(:update_time)
4528
4869
  end
@@ -4532,6 +4873,11 @@ module Google
4532
4873
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
4533
4874
  include Google::Apis::Core::Hashable
4534
4875
 
4876
+ # Configuration of destination for Purge related errors.
4877
+ # Corresponds to the JSON property `errorConfig`
4878
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig]
4879
+ attr_accessor :error_config
4880
+
4535
4881
  # Required. Filter matching documents to purge. Only currently supported value
4536
4882
  # is `*` (all items).
4537
4883
  # Corresponds to the JSON property `filter`
@@ -4545,14 +4891,21 @@ module Google
4545
4891
  attr_accessor :force
4546
4892
  alias_method :force?, :force
4547
4893
 
4894
+ # Cloud Storage location for input content.
4895
+ # Corresponds to the JSON property `gcsSource`
4896
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource]
4897
+ attr_accessor :gcs_source
4898
+
4548
4899
  def initialize(**args)
4549
4900
  update!(**args)
4550
4901
  end
4551
4902
 
4552
4903
  # Update properties of this object
4553
4904
  def update!(**args)
4905
+ @error_config = args[:error_config] if args.key?(:error_config)
4554
4906
  @filter = args[:filter] if args.key?(:filter)
4555
4907
  @force = args[:force] if args.key?(:force)
4908
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
4556
4909
  end
4557
4910
  end
4558
4911
 
@@ -4585,6 +4938,27 @@ module Google
4585
4938
  end
4586
4939
  end
4587
4940
 
4941
+ # Configuration of destination for Purge related errors.
4942
+ class GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig
4943
+ include Google::Apis::Core::Hashable
4944
+
4945
+ # Cloud Storage prefix for purge errors. This must be an empty, existing Cloud
4946
+ # Storage directory. Purge errors are written to sharded files in this directory,
4947
+ # one per line, as a JSON-encoded `google.rpc.Status` message.
4948
+ # Corresponds to the JSON property `gcsPrefix`
4949
+ # @return [String]
4950
+ attr_accessor :gcs_prefix
4951
+
4952
+ def initialize(**args)
4953
+ update!(**args)
4954
+ end
4955
+
4956
+ # Update properties of this object
4957
+ def update!(**args)
4958
+ @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
4959
+ end
4960
+ end
4961
+
4588
4962
  # Metadata related to the progress of the PurgeSuggestionDenyListEntries
4589
4963
  # operation. This is returned by the google.longrunning.Operation.metadata field.
4590
4964
  class GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata
@@ -5279,6 +5653,11 @@ module Google
5279
5653
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
5280
5654
  attr_accessor :content_search_spec
5281
5655
 
5656
+ # Defines custom fine tuning spec.
5657
+ # Corresponds to the JSON property `customFineTuningSpec`
5658
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
5659
+ attr_accessor :custom_fine_tuning_spec
5660
+
5282
5661
  # The specification that uses customized query embedding vector to do semantic
5283
5662
  # document retrieval.
5284
5663
  # Corresponds to the JSON property `embeddingSpec`
@@ -5444,6 +5823,7 @@ module Google
5444
5823
  @branch = args[:branch] if args.key?(:branch)
5445
5824
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
5446
5825
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
5826
+ @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
5447
5827
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
5448
5828
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
5449
5829
  @filter = args[:filter] if args.key?(:filter)
@@ -5508,8 +5888,8 @@ module Google
5508
5888
  # An expression which specifies a boost condition. The syntax and supported
5509
5889
  # fields are the same as a filter expression. See SearchRequest.filter for
5510
5890
  # detail syntax and limitations. Examples: * To boost documents with document ID
5511
- # "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2"))
5512
- # AND (color: ANY("Red","Blue"))
5891
+ # "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "
5892
+ # doc_2")) AND (color: ANY("Red", "Blue"))
5513
5893
  # Corresponds to the JSON property `condition`
5514
5894
  # @return [String]
5515
5895
  attr_accessor :condition
@@ -7717,6 +8097,12 @@ module Google
7717
8097
  attr_accessor :enable_summarization
7718
8098
  alias_method :enable_summarization?, :enable_summarization
7719
8099
 
8100
+ # Whether to enable standalone web app.
8101
+ # Corresponds to the JSON property `enableWebApp`
8102
+ # @return [Boolean]
8103
+ attr_accessor :enable_web_app
8104
+ alias_method :enable_web_app?, :enable_web_app
8105
+
7720
8106
  # The configuration and appearance of facets in the end user view.
7721
8107
  # Corresponds to the JSON property `facetField`
7722
8108
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>]
@@ -7795,6 +8181,7 @@ module Google
7795
8181
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
7796
8182
  @enable_snippet_result_summary = args[:enable_snippet_result_summary] if args.key?(:enable_snippet_result_summary)
7797
8183
  @enable_summarization = args[:enable_summarization] if args.key?(:enable_summarization)
8184
+ @enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
7798
8185
  @facet_field = args[:facet_field] if args.key?(:facet_field)
7799
8186
  @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
7800
8187
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
@@ -8177,6 +8564,13 @@ module Google
8177
8564
  # @return [String]
8178
8565
  attr_accessor :display_name
8179
8566
 
8567
+ # A singleton resource of DataStore. It's empty when DataStore is created, which
8568
+ # defaults to digital parser. The first call to DataStoreService.
8569
+ # UpdateDocumentProcessingConfig method will initialize the config.
8570
+ # Corresponds to the JSON property `documentProcessingConfig`
8571
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig]
8572
+ attr_accessor :document_processing_config
8573
+
8180
8574
  # Immutable. The industry vertical that the data store registers.
8181
8575
  # Corresponds to the JSON property `industryVertical`
8182
8576
  # @return [String]
@@ -8198,6 +8592,11 @@ module Google
8198
8592
  # @return [Array<String>]
8199
8593
  attr_accessor :solution_types
8200
8594
 
8595
+ # Defines the structure and layout of a type of document data.
8596
+ # Corresponds to the JSON property `startingSchema`
8597
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSchema]
8598
+ attr_accessor :starting_schema
8599
+
8201
8600
  def initialize(**args)
8202
8601
  update!(**args)
8203
8602
  end
@@ -8208,9 +8607,11 @@ module Google
8208
8607
  @create_time = args[:create_time] if args.key?(:create_time)
8209
8608
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
8210
8609
  @display_name = args[:display_name] if args.key?(:display_name)
8610
+ @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
8211
8611
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
8212
8612
  @name = args[:name] if args.key?(:name)
8213
8613
  @solution_types = args[:solution_types] if args.key?(:solution_types)
8614
+ @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
8214
8615
  end
8215
8616
  end
8216
8617
 
@@ -8323,6 +8724,19 @@ module Google
8323
8724
  end
8324
8725
  end
8325
8726
 
8727
+ # The digital parsing configurations for documents.
8728
+ class GoogleCloudDiscoveryengineV1betaDigitalParsingConfig
8729
+ include Google::Apis::Core::Hashable
8730
+
8731
+ def initialize(**args)
8732
+ update!(**args)
8733
+ end
8734
+
8735
+ # Update properties of this object
8736
+ def update!(**args)
8737
+ end
8738
+ end
8739
+
8326
8740
  # Metadata related to the progress of the SiteSearchEngineService.
8327
8741
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
8328
8742
  # longrunning.Operation.metadata field.
@@ -8364,6 +8778,70 @@ module Google
8364
8778
  end
8365
8779
  end
8366
8780
 
8781
+ # A singleton resource of DataStore. It's empty when DataStore is created, which
8782
+ # defaults to digital parser. The first call to DataStoreService.
8783
+ # UpdateDocumentProcessingConfig method will initialize the config.
8784
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig
8785
+ include Google::Apis::Core::Hashable
8786
+
8787
+ # Related configurations applied to a specific type of document parser.
8788
+ # Corresponds to the JSON property `defaultParsingConfig`
8789
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig]
8790
+ attr_accessor :default_parsing_config
8791
+
8792
+ # The full resource name of the Document Processing Config. Format: `projects/*/
8793
+ # locations/*/collections/*/dataStores/*/documentProcessingConfig`.
8794
+ # Corresponds to the JSON property `name`
8795
+ # @return [String]
8796
+ attr_accessor :name
8797
+
8798
+ # Map from file type to override the default parsing configuration based on the
8799
+ # file type. Supported keys: * `pdf`: Override parsing config for PDF files,
8800
+ # either digital parsing, ocr parsing or layout parsing is supported. * `html`:
8801
+ # Override parsing config for HTML files, only digital parsing and or layout
8802
+ # parsing are supported. * `docx`: Override parsing config for DOCX files, only
8803
+ # digital parsing and or layout parsing are supported.
8804
+ # Corresponds to the JSON property `parsingConfigOverrides`
8805
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig>]
8806
+ attr_accessor :parsing_config_overrides
8807
+
8808
+ def initialize(**args)
8809
+ update!(**args)
8810
+ end
8811
+
8812
+ # Update properties of this object
8813
+ def update!(**args)
8814
+ @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
8815
+ @name = args[:name] if args.key?(:name)
8816
+ @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
8817
+ end
8818
+ end
8819
+
8820
+ # Related configurations applied to a specific type of document parser.
8821
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig
8822
+ include Google::Apis::Core::Hashable
8823
+
8824
+ # The digital parsing configurations for documents.
8825
+ # Corresponds to the JSON property `digitalParsingConfig`
8826
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDigitalParsingConfig]
8827
+ attr_accessor :digital_parsing_config
8828
+
8829
+ # The OCR parsing configurations for documents.
8830
+ # Corresponds to the JSON property `ocrParsingConfig`
8831
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaOcrParsingConfig]
8832
+ attr_accessor :ocr_parsing_config
8833
+
8834
+ def initialize(**args)
8835
+ update!(**args)
8836
+ end
8837
+
8838
+ # Update properties of this object
8839
+ def update!(**args)
8840
+ @digital_parsing_config = args[:digital_parsing_config] if args.key?(:digital_parsing_config)
8841
+ @ocr_parsing_config = args[:ocr_parsing_config] if args.key?(:ocr_parsing_config)
8842
+ end
8843
+ end
8844
+
8367
8845
  # Metadata related to the progress of the SiteSearchEngineService.
8368
8846
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
8369
8847
  # longrunning.Operation.metadata field.
@@ -8871,6 +9349,34 @@ module Google
8871
9349
  end
8872
9350
  end
8873
9351
 
9352
+ # The OCR parsing configurations for documents.
9353
+ class GoogleCloudDiscoveryengineV1betaOcrParsingConfig
9354
+ include Google::Apis::Core::Hashable
9355
+
9356
+ # Apply additional enhanced OCR processing to a list of document elements.
9357
+ # Supported values: * `table`: advanced table parsing model.
9358
+ # Corresponds to the JSON property `enhancedDocumentElements`
9359
+ # @return [Array<String>]
9360
+ attr_accessor :enhanced_document_elements
9361
+
9362
+ # If true, will use native text instead of OCR text on pages containing native
9363
+ # text.
9364
+ # Corresponds to the JSON property `useNativeText`
9365
+ # @return [Boolean]
9366
+ attr_accessor :use_native_text
9367
+ alias_method :use_native_text?, :use_native_text
9368
+
9369
+ def initialize(**args)
9370
+ update!(**args)
9371
+ end
9372
+
9373
+ # Update properties of this object
9374
+ def update!(**args)
9375
+ @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
9376
+ @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
9377
+ end
9378
+ end
9379
+
8874
9380
  # Metadata related to the progress of the PurgeDocuments operation. This will be
8875
9381
  # returned by the google.longrunning.Operation.metadata field.
8876
9382
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -8886,6 +9392,11 @@ module Google
8886
9392
  # @return [Fixnum]
8887
9393
  attr_accessor :failure_count
8888
9394
 
9395
+ # Count of entries that were ignored as entries were not found.
9396
+ # Corresponds to the JSON property `ignoredCount`
9397
+ # @return [Fixnum]
9398
+ attr_accessor :ignored_count
9399
+
8889
9400
  # Count of entries that were deleted successfully.
8890
9401
  # Corresponds to the JSON property `successCount`
8891
9402
  # @return [Fixnum]
@@ -8905,6 +9416,7 @@ module Google
8905
9416
  def update!(**args)
8906
9417
  @create_time = args[:create_time] if args.key?(:create_time)
8907
9418
  @failure_count = args[:failure_count] if args.key?(:failure_count)
9419
+ @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
8908
9420
  @success_count = args[:success_count] if args.key?(:success_count)
8909
9421
  @update_time = args[:update_time] if args.key?(:update_time)
8910
9422
  end