google-apis-discoveryengine_v1alpha 0.38.0 → 0.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +562 -209
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +266 -104
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +177 -15
- metadata +3 -3
@@ -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::
|
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::
|
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
|
@@ -1823,6 +1823,81 @@ module Google
|
|
1823
1823
|
end
|
1824
1824
|
end
|
1825
1825
|
|
1826
|
+
# Chunk captures all raw metadata information of items to be recommended or
|
1827
|
+
# searched in the chunk mode.
|
1828
|
+
class GoogleCloudDiscoveryengineV1alphaChunk
|
1829
|
+
include Google::Apis::Core::Hashable
|
1830
|
+
|
1831
|
+
# Content is a string from a document (parsed content).
|
1832
|
+
# Corresponds to the JSON property `content`
|
1833
|
+
# @return [String]
|
1834
|
+
attr_accessor :content
|
1835
|
+
|
1836
|
+
# Output only. This field is OUTPUT_ONLY. It contains derived data that are not
|
1837
|
+
# in the original input document.
|
1838
|
+
# Corresponds to the JSON property `derivedStructData`
|
1839
|
+
# @return [Hash<String,Object>]
|
1840
|
+
attr_accessor :derived_struct_data
|
1841
|
+
|
1842
|
+
# Document metadata contains the information of the document of the current
|
1843
|
+
# chunk.
|
1844
|
+
# Corresponds to the JSON property `documentMetadata`
|
1845
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata]
|
1846
|
+
attr_accessor :document_metadata
|
1847
|
+
|
1848
|
+
# Unique chunk id of the current chunk.
|
1849
|
+
# Corresponds to the JSON property `id`
|
1850
|
+
# @return [String]
|
1851
|
+
attr_accessor :id
|
1852
|
+
|
1853
|
+
# The full resource name of the chunk. Format: `projects/`project`/locations/`
|
1854
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch`/
|
1855
|
+
# documents/`document_id`/chunks/`chunk_id``. This field must be a UTF-8 encoded
|
1856
|
+
# string with a length limit of 1024 characters.
|
1857
|
+
# Corresponds to the JSON property `name`
|
1858
|
+
# @return [String]
|
1859
|
+
attr_accessor :name
|
1860
|
+
|
1861
|
+
def initialize(**args)
|
1862
|
+
update!(**args)
|
1863
|
+
end
|
1864
|
+
|
1865
|
+
# Update properties of this object
|
1866
|
+
def update!(**args)
|
1867
|
+
@content = args[:content] if args.key?(:content)
|
1868
|
+
@derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
|
1869
|
+
@document_metadata = args[:document_metadata] if args.key?(:document_metadata)
|
1870
|
+
@id = args[:id] if args.key?(:id)
|
1871
|
+
@name = args[:name] if args.key?(:name)
|
1872
|
+
end
|
1873
|
+
end
|
1874
|
+
|
1875
|
+
# Document metadata contains the information of the document of the current
|
1876
|
+
# chunk.
|
1877
|
+
class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
|
1878
|
+
include Google::Apis::Core::Hashable
|
1879
|
+
|
1880
|
+
# Title of the document.
|
1881
|
+
# Corresponds to the JSON property `title`
|
1882
|
+
# @return [String]
|
1883
|
+
attr_accessor :title
|
1884
|
+
|
1885
|
+
# Uri of the document.
|
1886
|
+
# Corresponds to the JSON property `uri`
|
1887
|
+
# @return [String]
|
1888
|
+
attr_accessor :uri
|
1889
|
+
|
1890
|
+
def initialize(**args)
|
1891
|
+
update!(**args)
|
1892
|
+
end
|
1893
|
+
|
1894
|
+
# Update properties of this object
|
1895
|
+
def update!(**args)
|
1896
|
+
@title = args[:title] if args.key?(:title)
|
1897
|
+
@uri = args[:uri] if args.key?(:uri)
|
1898
|
+
end
|
1899
|
+
end
|
1900
|
+
|
1826
1901
|
# Request message for CompletionService.CompleteQuery method.
|
1827
1902
|
class GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest
|
1828
1903
|
include Google::Apis::Core::Hashable
|
@@ -2608,19 +2683,6 @@ module Google
|
|
2608
2683
|
end
|
2609
2684
|
end
|
2610
2685
|
|
2611
|
-
# The digital parsing configurations for documents.
|
2612
|
-
class GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig
|
2613
|
-
include Google::Apis::Core::Hashable
|
2614
|
-
|
2615
|
-
def initialize(**args)
|
2616
|
-
update!(**args)
|
2617
|
-
end
|
2618
|
-
|
2619
|
-
# Update properties of this object
|
2620
|
-
def update!(**args)
|
2621
|
-
end
|
2622
|
-
end
|
2623
|
-
|
2624
2686
|
# Metadata related to the progress of the SiteSearchEngineService.
|
2625
2687
|
# DisableAdvancedSiteSearch operation. This will be returned by the google.
|
2626
2688
|
# longrunning.Operation.metadata field.
|
@@ -2765,7 +2827,7 @@ module Google
|
|
2765
2827
|
class GoogleCloudDiscoveryengineV1alphaDocumentAclInfo
|
2766
2828
|
include Google::Apis::Core::Hashable
|
2767
2829
|
|
2768
|
-
#
|
2830
|
+
# Readers of the document.
|
2769
2831
|
# Corresponds to the JSON property `readers`
|
2770
2832
|
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction>]
|
2771
2833
|
attr_accessor :readers
|
@@ -2906,6 +2968,11 @@ module Google
|
|
2906
2968
|
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
|
2907
2969
|
include Google::Apis::Core::Hashable
|
2908
2970
|
|
2971
|
+
# Configuration for chunking config.
|
2972
|
+
# Corresponds to the JSON property `chunkingConfig`
|
2973
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig]
|
2974
|
+
attr_accessor :chunking_config
|
2975
|
+
|
2909
2976
|
# Related configurations applied to a specific type of document parser.
|
2910
2977
|
# Corresponds to the JSON property `defaultParsingConfig`
|
2911
2978
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig]
|
@@ -2917,11 +2984,6 @@ module Google
|
|
2917
2984
|
# @return [String]
|
2918
2985
|
attr_accessor :name
|
2919
2986
|
|
2920
|
-
# The OCR options for parsing documents.
|
2921
|
-
# Corresponds to the JSON property `ocrConfig`
|
2922
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaOcrConfig]
|
2923
|
-
attr_accessor :ocr_config
|
2924
|
-
|
2925
2987
|
# Map from file type to override the default parsing configuration based on the
|
2926
2988
|
# file type. Supported keys: * `pdf`: Override parsing config for PDF files,
|
2927
2989
|
# either digital parsing, ocr parsing or layout parsing is supported. * `html`:
|
@@ -2938,30 +3000,77 @@ module Google
|
|
2938
3000
|
|
2939
3001
|
# Update properties of this object
|
2940
3002
|
def update!(**args)
|
3003
|
+
@chunking_config = args[:chunking_config] if args.key?(:chunking_config)
|
2941
3004
|
@default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
|
2942
3005
|
@name = args[:name] if args.key?(:name)
|
2943
|
-
@ocr_config = args[:ocr_config] if args.key?(:ocr_config)
|
2944
3006
|
@parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
|
2945
3007
|
end
|
2946
3008
|
end
|
2947
3009
|
|
3010
|
+
# Configuration for chunking config.
|
3011
|
+
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig
|
3012
|
+
include Google::Apis::Core::Hashable
|
3013
|
+
|
3014
|
+
# Configuration for the layout based chunking.
|
3015
|
+
# Corresponds to the JSON property `layoutBasedChunkingConfig`
|
3016
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig]
|
3017
|
+
attr_accessor :layout_based_chunking_config
|
3018
|
+
|
3019
|
+
def initialize(**args)
|
3020
|
+
update!(**args)
|
3021
|
+
end
|
3022
|
+
|
3023
|
+
# Update properties of this object
|
3024
|
+
def update!(**args)
|
3025
|
+
@layout_based_chunking_config = args[:layout_based_chunking_config] if args.key?(:layout_based_chunking_config)
|
3026
|
+
end
|
3027
|
+
end
|
3028
|
+
|
3029
|
+
# Configuration for the layout based chunking.
|
3030
|
+
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
|
3031
|
+
include Google::Apis::Core::Hashable
|
3032
|
+
|
3033
|
+
# The token size limit for each chunk. Supported values: 100-500 (inclusive).
|
3034
|
+
# Default value: 500.
|
3035
|
+
# Corresponds to the JSON property `chunkSize`
|
3036
|
+
# @return [Fixnum]
|
3037
|
+
attr_accessor :chunk_size
|
3038
|
+
|
3039
|
+
# Whether to include appending different levels of headings to chunks from the
|
3040
|
+
# middle of the document to prevent context loss. Default value: False.
|
3041
|
+
# Corresponds to the JSON property `includeAncestorHeadings`
|
3042
|
+
# @return [Boolean]
|
3043
|
+
attr_accessor :include_ancestor_headings
|
3044
|
+
alias_method :include_ancestor_headings?, :include_ancestor_headings
|
3045
|
+
|
3046
|
+
def initialize(**args)
|
3047
|
+
update!(**args)
|
3048
|
+
end
|
3049
|
+
|
3050
|
+
# Update properties of this object
|
3051
|
+
def update!(**args)
|
3052
|
+
@chunk_size = args[:chunk_size] if args.key?(:chunk_size)
|
3053
|
+
@include_ancestor_headings = args[:include_ancestor_headings] if args.key?(:include_ancestor_headings)
|
3054
|
+
end
|
3055
|
+
end
|
3056
|
+
|
2948
3057
|
# Related configurations applied to a specific type of document parser.
|
2949
3058
|
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig
|
2950
3059
|
include Google::Apis::Core::Hashable
|
2951
3060
|
|
2952
3061
|
# The digital parsing configurations for documents.
|
2953
3062
|
# Corresponds to the JSON property `digitalParsingConfig`
|
2954
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
3063
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
|
2955
3064
|
attr_accessor :digital_parsing_config
|
2956
3065
|
|
2957
3066
|
# The layout parsing configurations for documents.
|
2958
3067
|
# Corresponds to the JSON property `layoutParsingConfig`
|
2959
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
3068
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig]
|
2960
3069
|
attr_accessor :layout_parsing_config
|
2961
3070
|
|
2962
3071
|
# The OCR parsing configurations for documents.
|
2963
3072
|
# Corresponds to the JSON property `ocrParsingConfig`
|
2964
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
3073
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig]
|
2965
3074
|
attr_accessor :ocr_parsing_config
|
2966
3075
|
|
2967
3076
|
def initialize(**args)
|
@@ -2976,6 +3085,60 @@ module Google
|
|
2976
3085
|
end
|
2977
3086
|
end
|
2978
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
|
+
|
2979
3142
|
# Double list.
|
2980
3143
|
class GoogleCloudDiscoveryengineV1alphaDoubleList
|
2981
3144
|
include Google::Apis::Core::Hashable
|
@@ -3072,14 +3235,6 @@ module Google
|
|
3072
3235
|
class GoogleCloudDiscoveryengineV1alphaEngine
|
3073
3236
|
include Google::Apis::Core::Hashable
|
3074
3237
|
|
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
|
-
|
3083
3238
|
# Configurations for a Chat Engine.
|
3084
3239
|
# Corresponds to the JSON property `chatEngineConfig`
|
3085
3240
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
|
@@ -3170,7 +3325,6 @@ module Google
|
|
3170
3325
|
|
3171
3326
|
# Update properties of this object
|
3172
3327
|
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)
|
3174
3328
|
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
3175
3329
|
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
3176
3330
|
@common_config = args[:common_config] if args.key?(:common_config)
|
@@ -4354,16 +4508,29 @@ module Google
|
|
4354
4508
|
end
|
4355
4509
|
end
|
4356
4510
|
|
4357
|
-
#
|
4358
|
-
class
|
4511
|
+
# Response message for ChunkService.ListChunks method.
|
4512
|
+
class GoogleCloudDiscoveryengineV1alphaListChunksResponse
|
4359
4513
|
include Google::Apis::Core::Hashable
|
4360
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
|
+
|
4361
4526
|
def initialize(**args)
|
4362
4527
|
update!(**args)
|
4363
4528
|
end
|
4364
4529
|
|
4365
4530
|
# Update properties of this object
|
4366
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)
|
4367
4534
|
end
|
4368
4535
|
end
|
4369
4536
|
|
@@ -4616,73 +4783,8 @@ module Google
|
|
4616
4783
|
|
4617
4784
|
# Update properties of this object
|
4618
4785
|
def update!(**args)
|
4619
|
-
@media_progress_duration = args[:media_progress_duration] if args.key?(:media_progress_duration)
|
4620
|
-
@media_progress_percentage = args[:media_progress_percentage] if args.key?(:media_progress_percentage)
|
4621
|
-
end
|
4622
|
-
end
|
4623
|
-
|
4624
|
-
# The OCR options for parsing documents.
|
4625
|
-
class GoogleCloudDiscoveryengineV1alphaOcrConfig
|
4626
|
-
include Google::Apis::Core::Hashable
|
4627
|
-
|
4628
|
-
# Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig
|
4629
|
-
# options to apply. We will only perform OCR on the first 80 pages of the PDF
|
4630
|
-
# files.
|
4631
|
-
# Corresponds to the JSON property `enabled`
|
4632
|
-
# @return [Boolean]
|
4633
|
-
attr_accessor :enabled
|
4634
|
-
alias_method :enabled?, :enabled
|
4635
|
-
|
4636
|
-
# Apply additional enhanced OCR processing to a list of document elements.
|
4637
|
-
# Supported values: * `table`: advanced table parsing model.
|
4638
|
-
# Corresponds to the JSON property `enhancedDocumentElements`
|
4639
|
-
# @return [Array<String>]
|
4640
|
-
attr_accessor :enhanced_document_elements
|
4641
|
-
|
4642
|
-
# If true, will use native text instead of OCR text on pages containing native
|
4643
|
-
# text.
|
4644
|
-
# Corresponds to the JSON property `useNativeText`
|
4645
|
-
# @return [Boolean]
|
4646
|
-
attr_accessor :use_native_text
|
4647
|
-
alias_method :use_native_text?, :use_native_text
|
4648
|
-
|
4649
|
-
def initialize(**args)
|
4650
|
-
update!(**args)
|
4651
|
-
end
|
4652
|
-
|
4653
|
-
# Update properties of this object
|
4654
|
-
def update!(**args)
|
4655
|
-
@enabled = args[:enabled] if args.key?(:enabled)
|
4656
|
-
@enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
|
4657
|
-
@use_native_text = args[:use_native_text] if args.key?(:use_native_text)
|
4658
|
-
end
|
4659
|
-
end
|
4660
|
-
|
4661
|
-
# The OCR parsing configurations for documents.
|
4662
|
-
class GoogleCloudDiscoveryengineV1alphaOcrParsingConfig
|
4663
|
-
include Google::Apis::Core::Hashable
|
4664
|
-
|
4665
|
-
# Apply additional enhanced OCR processing to a list of document elements.
|
4666
|
-
# Supported values: * `table`: advanced table parsing model.
|
4667
|
-
# Corresponds to the JSON property `enhancedDocumentElements`
|
4668
|
-
# @return [Array<String>]
|
4669
|
-
attr_accessor :enhanced_document_elements
|
4670
|
-
|
4671
|
-
# If true, will use native text instead of OCR text on pages containing native
|
4672
|
-
# text.
|
4673
|
-
# Corresponds to the JSON property `useNativeText`
|
4674
|
-
# @return [Boolean]
|
4675
|
-
attr_accessor :use_native_text
|
4676
|
-
alias_method :use_native_text?, :use_native_text
|
4677
|
-
|
4678
|
-
def initialize(**args)
|
4679
|
-
update!(**args)
|
4680
|
-
end
|
4681
|
-
|
4682
|
-
# Update properties of this object
|
4683
|
-
def update!(**args)
|
4684
|
-
@enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
|
4685
|
-
@use_native_text = args[:use_native_text] if args.key?(:use_native_text)
|
4786
|
+
@media_progress_duration = args[:media_progress_duration] if args.key?(:media_progress_duration)
|
4787
|
+
@media_progress_percentage = args[:media_progress_percentage] if args.key?(:media_progress_percentage)
|
4686
4788
|
end
|
4687
4789
|
end
|
4688
4790
|
|
@@ -5658,6 +5760,11 @@ module Google
|
|
5658
5760
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
|
5659
5761
|
attr_accessor :custom_fine_tuning_spec
|
5660
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
|
+
|
5661
5768
|
# The specification that uses customized query embedding vector to do semantic
|
5662
5769
|
# document retrieval.
|
5663
5770
|
# Corresponds to the JSON property `embeddingSpec`
|
@@ -5824,6 +5931,7 @@ module Google
|
|
5824
5931
|
@canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
|
5825
5932
|
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
5826
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)
|
5827
5935
|
@embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
|
5828
5936
|
@facet_specs = args[:facet_specs] if args.key?(:facet_specs)
|
5829
5937
|
@filter = args[:filter] if args.key?(:filter)
|
@@ -5888,8 +5996,8 @@ module Google
|
|
5888
5996
|
# An expression which specifies a boost condition. The syntax and supported
|
5889
5997
|
# fields are the same as a filter expression. See SearchRequest.filter for
|
5890
5998
|
# detail syntax and limitations. Examples: * To boost documents with document ID
|
5891
|
-
# "doc_1" or "doc_2", and color "Red" or "Blue":
|
5892
|
-
# 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"))`
|
5893
6001
|
# Corresponds to the JSON property `condition`
|
5894
6002
|
# @return [String]
|
5895
6003
|
attr_accessor :condition
|
@@ -5914,6 +6022,14 @@ module Google
|
|
5914
6022
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec]
|
5915
6023
|
attr_accessor :extractive_content_spec
|
5916
6024
|
|
6025
|
+
# Specifies the search result mode. If unspecified, the search result mode is
|
6026
|
+
# based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
|
6027
|
+
# DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
|
6028
|
+
# * Otherwise, it defaults to `DOCUMENTS`.
|
6029
|
+
# Corresponds to the JSON property `searchResultMode`
|
6030
|
+
# @return [String]
|
6031
|
+
attr_accessor :search_result_mode
|
6032
|
+
|
5917
6033
|
# A specification for configuring snippets in a search response.
|
5918
6034
|
# Corresponds to the JSON property `snippetSpec`
|
5919
6035
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec]
|
@@ -5931,6 +6047,7 @@ module Google
|
|
5931
6047
|
# Update properties of this object
|
5932
6048
|
def update!(**args)
|
5933
6049
|
@extractive_content_spec = args[:extractive_content_spec] if args.key?(:extractive_content_spec)
|
6050
|
+
@search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
|
5934
6051
|
@snippet_spec = args[:snippet_spec] if args.key?(:snippet_spec)
|
5935
6052
|
@summary_spec = args[:summary_spec] if args.key?(:summary_spec)
|
5936
6053
|
end
|
@@ -5975,6 +6092,15 @@ module Google
|
|
5975
6092
|
# @return [Fixnum]
|
5976
6093
|
attr_accessor :num_previous_segments
|
5977
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
|
+
|
5978
6104
|
def initialize(**args)
|
5979
6105
|
update!(**args)
|
5980
6106
|
end
|
@@ -5985,6 +6111,7 @@ module Google
|
|
5985
6111
|
@max_extractive_segment_count = args[:max_extractive_segment_count] if args.key?(:max_extractive_segment_count)
|
5986
6112
|
@num_next_segments = args[:num_next_segments] if args.key?(:num_next_segments)
|
5987
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)
|
5988
6115
|
end
|
5989
6116
|
end
|
5990
6117
|
|
@@ -6087,8 +6214,7 @@ module Google
|
|
6087
6214
|
|
6088
6215
|
# The number of top results to generate the summary from. If the number of
|
6089
6216
|
# results returned is less than `summaryResultCount`, the summary is generated
|
6090
|
-
# from all of the results. At most
|
6091
|
-
# summary.
|
6217
|
+
# from all of the results. At most 10 results can be used to generate a summary.
|
6092
6218
|
# Corresponds to the JSON property `summaryResultCount`
|
6093
6219
|
# @return [Fixnum]
|
6094
6220
|
attr_accessor :summary_result_count
|
@@ -6135,9 +6261,12 @@ module Google
|
|
6135
6261
|
|
6136
6262
|
# The model version used to generate the summary. Supported values are: * `
|
6137
6263
|
# stable`: string. Default value when no value is specified. Uses a generally
|
6138
|
-
# available, fine-tuned
|
6139
|
-
#
|
6140
|
-
#
|
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).
|
6141
6270
|
# Corresponds to the JSON property `version`
|
6142
6271
|
# @return [String]
|
6143
6272
|
attr_accessor :version
|
@@ -6152,6 +6281,26 @@ module Google
|
|
6152
6281
|
end
|
6153
6282
|
end
|
6154
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
|
+
|
6155
6304
|
# The specification that uses customized query embedding vector to do semantic
|
6156
6305
|
# document retrieval.
|
6157
6306
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
|
@@ -6681,6 +6830,12 @@ module Google
|
|
6681
6830
|
class GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult
|
6682
6831
|
include Google::Apis::Core::Hashable
|
6683
6832
|
|
6833
|
+
# Chunk captures all raw metadata information of items to be recommended or
|
6834
|
+
# searched in the chunk mode.
|
6835
|
+
# Corresponds to the JSON property `chunk`
|
6836
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk]
|
6837
|
+
attr_accessor :chunk
|
6838
|
+
|
6684
6839
|
# Document captures all raw metadata information of items to be recommended or
|
6685
6840
|
# searched.
|
6686
6841
|
# Corresponds to the JSON property `document`
|
@@ -6703,6 +6858,7 @@ module Google
|
|
6703
6858
|
|
6704
6859
|
# Update properties of this object
|
6705
6860
|
def update!(**args)
|
6861
|
+
@chunk = args[:chunk] if args.key?(:chunk)
|
6706
6862
|
@document = args[:document] if args.key?(:document)
|
6707
6863
|
@id = args[:id] if args.key?(:id)
|
6708
6864
|
@model_scores = args[:model_scores] if args.key?(:model_scores)
|
@@ -7009,7 +7165,7 @@ module Google
|
|
7009
7165
|
attr_accessor :model_id
|
7010
7166
|
|
7011
7167
|
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
7012
|
-
# collections/`collection_id`/
|
7168
|
+
# collections/`collection_id`/engines/`engine_id`/servingConfigs/`
|
7013
7169
|
# serving_config_id``
|
7014
7170
|
# Corresponds to the JSON property `name`
|
7015
7171
|
# @return [String]
|
@@ -7143,11 +7299,6 @@ module Google
|
|
7143
7299
|
# @return [Fixnum]
|
7144
7300
|
attr_accessor :content_freshness_cutoff_days
|
7145
7301
|
|
7146
|
-
# Specifies the content watched minutes threshold for demotion.
|
7147
|
-
# Corresponds to the JSON property `contentWatchedMinutesThreshold`
|
7148
|
-
# @return [Float]
|
7149
|
-
attr_accessor :content_watched_minutes_threshold
|
7150
|
-
|
7151
7302
|
# Specifies the content watched percentage threshold for demotion. Threshold
|
7152
7303
|
# value must be between [0, 1.0] inclusive.
|
7153
7304
|
# Corresponds to the JSON property `contentWatchedPercentageThreshold`
|
@@ -7175,7 +7326,6 @@ module Google
|
|
7175
7326
|
# Update properties of this object
|
7176
7327
|
def update!(**args)
|
7177
7328
|
@content_freshness_cutoff_days = args[:content_freshness_cutoff_days] if args.key?(:content_freshness_cutoff_days)
|
7178
|
-
@content_watched_minutes_threshold = args[:content_watched_minutes_threshold] if args.key?(:content_watched_minutes_threshold)
|
7179
7329
|
@content_watched_percentage_threshold = args[:content_watched_percentage_threshold] if args.key?(:content_watched_percentage_threshold)
|
7180
7330
|
@content_watched_seconds_threshold = args[:content_watched_seconds_threshold] if args.key?(:content_watched_seconds_threshold)
|
7181
7331
|
@demotion_event_type = args[:demotion_event_type] if args.key?(:demotion_event_type)
|
@@ -7462,15 +7612,15 @@ module Google
|
|
7462
7612
|
include Google::Apis::Core::Hashable
|
7463
7613
|
|
7464
7614
|
# The Cloud Storage corpus data which could be associated in train data. The
|
7465
|
-
# data path format is gs
|
7466
|
-
# tuning model, each line should have the _id, title and text. Example:
|
7467
|
-
# 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"``
|
7468
7618
|
# Corresponds to the JSON property `corpusDataPath`
|
7469
7619
|
# @return [String]
|
7470
7620
|
attr_accessor :corpus_data_path
|
7471
7621
|
|
7472
7622
|
# The gcs query data which could be associated in train data. The data path
|
7473
|
-
# format is gs
|
7623
|
+
# format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning
|
7474
7624
|
# model, each line should have the _id and text. Example: `"_id": "query1", "
|
7475
7625
|
# text": "example query"`
|
7476
7626
|
# Corresponds to the JSON property `queryDataPath`
|
@@ -7483,12 +7633,12 @@ module Google
|
|
7483
7633
|
# @return [String]
|
7484
7634
|
attr_accessor :test_data_path
|
7485
7635
|
|
7486
|
-
# Cloud Storage training data path whose format should be gs
|
7636
|
+
# Cloud Storage training data path whose format should be `gs:///`. The file
|
7487
7637
|
# should be in tsv format. Each line should have the doc_id and query_id and
|
7488
7638
|
# score (number). For search-tuning model, it should have the query-id corpus-id
|
7489
|
-
# score as tsv file header. The score should be a number in [0, inf+)
|
7490
|
-
# larger the number is, the more relevant the pair is. Example: query-id\
|
7491
|
-
# 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`
|
7492
7642
|
# Corresponds to the JSON property `trainDataPath`
|
7493
7643
|
# @return [String]
|
7494
7644
|
attr_accessor :train_data_path
|
@@ -8027,6 +8177,14 @@ module Google
|
|
8027
8177
|
# @return [Array<String>]
|
8028
8178
|
attr_accessor :allowlisted_domains
|
8029
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
|
+
|
8030
8188
|
# Output only. Unique obfuscated identifier of a WidgetConfig.
|
8031
8189
|
# Corresponds to the JSON property `configId`
|
8032
8190
|
# @return [String]
|
@@ -8047,6 +8205,11 @@ module Google
|
|
8047
8205
|
# @return [String]
|
8048
8206
|
attr_accessor :data_store_type
|
8049
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
|
+
|
8050
8213
|
# Required. The human readable widget config display name. Used in Discovery UI.
|
8051
8214
|
# This field must be a UTF-8 encoded string with a length limit of 128
|
8052
8215
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
@@ -8169,10 +8332,12 @@ module Google
|
|
8169
8332
|
def update!(**args)
|
8170
8333
|
@allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
|
8171
8334
|
@allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
|
8335
|
+
@collection_components = args[:collection_components] if args.key?(:collection_components)
|
8172
8336
|
@config_id = args[:config_id] if args.key?(:config_id)
|
8173
8337
|
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
8174
8338
|
@create_time = args[:create_time] if args.key?(:create_time)
|
8175
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)
|
8176
8341
|
@display_name = args[:display_name] if args.key?(:display_name)
|
8177
8342
|
@enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
|
8178
8343
|
@enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
|
@@ -8194,6 +8359,132 @@ module Google
|
|
8194
8359
|
end
|
8195
8360
|
end
|
8196
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
|
+
|
8197
8488
|
# Facet fields that store the mapping of fields to end user widget appearance.
|
8198
8489
|
class GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField
|
8199
8490
|
include Google::Apis::Core::Hashable
|
@@ -8724,19 +9015,6 @@ module Google
|
|
8724
9015
|
end
|
8725
9016
|
end
|
8726
9017
|
|
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
|
-
|
8740
9018
|
# Metadata related to the progress of the SiteSearchEngineService.
|
8741
9019
|
# DisableAdvancedSiteSearch operation. This will be returned by the google.
|
8742
9020
|
# longrunning.Operation.metadata field.
|
@@ -8823,12 +9101,12 @@ module Google
|
|
8823
9101
|
|
8824
9102
|
# The digital parsing configurations for documents.
|
8825
9103
|
# Corresponds to the JSON property `digitalParsingConfig`
|
8826
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
9104
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
|
8827
9105
|
attr_accessor :digital_parsing_config
|
8828
9106
|
|
8829
9107
|
# The OCR parsing configurations for documents.
|
8830
9108
|
# Corresponds to the JSON property `ocrParsingConfig`
|
8831
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
9109
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig]
|
8832
9110
|
attr_accessor :ocr_parsing_config
|
8833
9111
|
|
8834
9112
|
def initialize(**args)
|
@@ -8842,6 +9120,47 @@ module Google
|
|
8842
9120
|
end
|
8843
9121
|
end
|
8844
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
|
+
|
8845
9164
|
# Metadata related to the progress of the SiteSearchEngineService.
|
8846
9165
|
# EnableAdvancedSiteSearch operation. This will be returned by the google.
|
8847
9166
|
# longrunning.Operation.metadata field.
|
@@ -9349,34 +9668,6 @@ module Google
|
|
9349
9668
|
end
|
9350
9669
|
end
|
9351
9670
|
|
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
|
-
|
9380
9671
|
# Metadata related to the progress of the PurgeDocuments operation. This will be
|
9381
9672
|
# returned by the google.longrunning.Operation.metadata field.
|
9382
9673
|
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
|
@@ -9679,6 +9970,68 @@ module Google
|
|
9679
9970
|
end
|
9680
9971
|
end
|
9681
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
|
+
|
9682
10035
|
# Metadata for UpdateSchema LRO.
|
9683
10036
|
class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
|
9684
10037
|
include Google::Apis::Core::Hashable
|