google-apis-discoveryengine_v1beta 0.46.0 → 0.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -941,6 +941,11 @@ module Google
941
941
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfig
942
942
  include Google::Apis::Core::Hashable
943
943
 
944
+ # Configuration for chunking config.
945
+ # Corresponds to the JSON property `chunkingConfig`
946
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig]
947
+ attr_accessor :chunking_config
948
+
944
949
  # Related configurations applied to a specific type of document parser.
945
950
  # Corresponds to the JSON property `defaultParsingConfig`
946
951
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig]
@@ -968,12 +973,60 @@ module Google
968
973
 
969
974
  # Update properties of this object
970
975
  def update!(**args)
976
+ @chunking_config = args[:chunking_config] if args.key?(:chunking_config)
971
977
  @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
972
978
  @name = args[:name] if args.key?(:name)
973
979
  @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
974
980
  end
975
981
  end
976
982
 
983
+ # Configuration for chunking config.
984
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig
985
+ include Google::Apis::Core::Hashable
986
+
987
+ # Configuration for the layout based chunking.
988
+ # Corresponds to the JSON property `layoutBasedChunkingConfig`
989
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig]
990
+ attr_accessor :layout_based_chunking_config
991
+
992
+ def initialize(**args)
993
+ update!(**args)
994
+ end
995
+
996
+ # Update properties of this object
997
+ def update!(**args)
998
+ @layout_based_chunking_config = args[:layout_based_chunking_config] if args.key?(:layout_based_chunking_config)
999
+ end
1000
+ end
1001
+
1002
+ # Configuration for the layout based chunking.
1003
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
1004
+ include Google::Apis::Core::Hashable
1005
+
1006
+ # The token size limit for each chunk. Supported values: 100-500 (inclusive).
1007
+ # Default value: 500.
1008
+ # Corresponds to the JSON property `chunkSize`
1009
+ # @return [Fixnum]
1010
+ attr_accessor :chunk_size
1011
+
1012
+ # Whether to include appending different levels of headings to chunks from the
1013
+ # middle of the document to prevent context loss. Default value: False.
1014
+ # Corresponds to the JSON property `includeAncestorHeadings`
1015
+ # @return [Boolean]
1016
+ attr_accessor :include_ancestor_headings
1017
+ alias_method :include_ancestor_headings?, :include_ancestor_headings
1018
+
1019
+ def initialize(**args)
1020
+ update!(**args)
1021
+ end
1022
+
1023
+ # Update properties of this object
1024
+ def update!(**args)
1025
+ @chunk_size = args[:chunk_size] if args.key?(:chunk_size)
1026
+ @include_ancestor_headings = args[:include_ancestor_headings] if args.key?(:include_ancestor_headings)
1027
+ end
1028
+ end
1029
+
977
1030
  # Related configurations applied to a specific type of document parser.
978
1031
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig
979
1032
  include Google::Apis::Core::Hashable
@@ -983,6 +1036,11 @@ module Google
983
1036
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig]
984
1037
  attr_accessor :digital_parsing_config
985
1038
 
1039
+ # The layout parsing configurations for documents.
1040
+ # Corresponds to the JSON property `layoutParsingConfig`
1041
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig]
1042
+ attr_accessor :layout_parsing_config
1043
+
986
1044
  # The OCR parsing configurations for documents.
987
1045
  # Corresponds to the JSON property `ocrParsingConfig`
988
1046
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig]
@@ -995,6 +1053,7 @@ module Google
995
1053
  # Update properties of this object
996
1054
  def update!(**args)
997
1055
  @digital_parsing_config = args[:digital_parsing_config] if args.key?(:digital_parsing_config)
1056
+ @layout_parsing_config = args[:layout_parsing_config] if args.key?(:layout_parsing_config)
998
1057
  @ocr_parsing_config = args[:ocr_parsing_config] if args.key?(:ocr_parsing_config)
999
1058
  end
1000
1059
  end
@@ -1012,6 +1071,19 @@ module Google
1012
1071
  end
1013
1072
  end
1014
1073
 
1074
+ # The layout parsing configurations for documents.
1075
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig
1076
+ include Google::Apis::Core::Hashable
1077
+
1078
+ def initialize(**args)
1079
+ update!(**args)
1080
+ end
1081
+
1082
+ # Update properties of this object
1083
+ def update!(**args)
1084
+ end
1085
+ end
1086
+
1015
1087
  # The OCR parsing configurations for documents.
1016
1088
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
1017
1089
  include Google::Apis::Core::Hashable
@@ -3133,6 +3205,11 @@ module Google
3133
3205
  # @return [String]
3134
3206
  attr_accessor :industry_vertical
3135
3207
 
3208
+ # Language info for DataStore.
3209
+ # Corresponds to the JSON property `languageInfo`
3210
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaLanguageInfo]
3211
+ attr_accessor :language_info
3212
+
3136
3213
  # Immutable. The full resource name of the data store. Format: `projects/`
3137
3214
  # project`/locations/`location`/collections/`collection_id`/dataStores/`
3138
3215
  # data_store_id``. This field must be a UTF-8 encoded string with a length limit
@@ -3168,6 +3245,7 @@ module Google
3168
3245
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
3169
3246
  @idp_config = args[:idp_config] if args.key?(:idp_config)
3170
3247
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
3248
+ @language_info = args[:language_info] if args.key?(:language_info)
3171
3249
  @name = args[:name] if args.key?(:name)
3172
3250
  @solution_types = args[:solution_types] if args.key?(:solution_types)
3173
3251
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
@@ -4396,6 +4474,47 @@ module Google
4396
4474
  end
4397
4475
  end
4398
4476
 
4477
+ # Language info for DataStore.
4478
+ class GoogleCloudDiscoveryengineV1alphaLanguageInfo
4479
+ include Google::Apis::Core::Hashable
4480
+
4481
+ # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`,
4482
+ # `zh-Hans-HK` -> `zh`, `en` -> `en`.
4483
+ # Corresponds to the JSON property `language`
4484
+ # @return [String]
4485
+ attr_accessor :language
4486
+
4487
+ # The language code for the DataStore.
4488
+ # Corresponds to the JSON property `languageCode`
4489
+ # @return [String]
4490
+ attr_accessor :language_code
4491
+
4492
+ # Output only. This is the normalized form of language_code. E.g.: language_code
4493
+ # of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `
4494
+ # en-GB`.
4495
+ # Corresponds to the JSON property `normalizedLanguageCode`
4496
+ # @return [String]
4497
+ attr_accessor :normalized_language_code
4498
+
4499
+ # Output only. Region part of normalized_language_code, if present. E.g.: `en-US`
4500
+ # -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
4501
+ # Corresponds to the JSON property `region`
4502
+ # @return [String]
4503
+ attr_accessor :region
4504
+
4505
+ def initialize(**args)
4506
+ update!(**args)
4507
+ end
4508
+
4509
+ # Update properties of this object
4510
+ def update!(**args)
4511
+ @language = args[:language] if args.key?(:language)
4512
+ @language_code = args[:language_code] if args.key?(:language_code)
4513
+ @normalized_language_code = args[:normalized_language_code] if args.key?(:normalized_language_code)
4514
+ @region = args[:region] if args.key?(:region)
4515
+ end
4516
+ end
4517
+
4399
4518
  # Response message for SearchTuningService.ListCustomModels method.
4400
4519
  class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
4401
4520
  include Google::Apis::Core::Hashable
@@ -5293,6 +5412,64 @@ module Google
5293
5412
  end
5294
5413
  end
5295
5414
 
5415
+ # AlloyDB source import data from.
5416
+ class GoogleCloudDiscoveryengineV1betaAlloyDbSource
5417
+ include Google::Apis::Core::Hashable
5418
+
5419
+ # Required. The AlloyDB cluster to copy the data from with a length limit of 256
5420
+ # characters.
5421
+ # Corresponds to the JSON property `clusterId`
5422
+ # @return [String]
5423
+ attr_accessor :cluster_id
5424
+
5425
+ # Required. The AlloyDB database to copy the data from with a length limit of
5426
+ # 256 characters.
5427
+ # Corresponds to the JSON property `databaseId`
5428
+ # @return [String]
5429
+ attr_accessor :database_id
5430
+
5431
+ # Intermediate Cloud Storage directory used for the import with a length limit
5432
+ # of 2,000 characters. Can be specified if one wants to have the AlloyDB export
5433
+ # to a specific Cloud Storage directory. Ensure that the AlloyDB service account
5434
+ # has the necessary Cloud Storage Admin permissions to access the specified
5435
+ # Cloud Storage directory.
5436
+ # Corresponds to the JSON property `gcsStagingDir`
5437
+ # @return [String]
5438
+ attr_accessor :gcs_staging_dir
5439
+
5440
+ # Required. The AlloyDB location to copy the data from with a length limit of
5441
+ # 256 characters.
5442
+ # Corresponds to the JSON property `locationId`
5443
+ # @return [String]
5444
+ attr_accessor :location_id
5445
+
5446
+ # The project ID that the AlloyDB source is in with a length limit of 128
5447
+ # characters. If not specified, inherits the project ID from the parent request.
5448
+ # Corresponds to the JSON property `projectId`
5449
+ # @return [String]
5450
+ attr_accessor :project_id
5451
+
5452
+ # Required. The AlloyDB table to copy the data from with a length limit of 256
5453
+ # characters.
5454
+ # Corresponds to the JSON property `tableId`
5455
+ # @return [String]
5456
+ attr_accessor :table_id
5457
+
5458
+ def initialize(**args)
5459
+ update!(**args)
5460
+ end
5461
+
5462
+ # Update properties of this object
5463
+ def update!(**args)
5464
+ @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
5465
+ @database_id = args[:database_id] if args.key?(:database_id)
5466
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
5467
+ @location_id = args[:location_id] if args.key?(:location_id)
5468
+ @project_id = args[:project_id] if args.key?(:project_id)
5469
+ @table_id = args[:table_id] if args.key?(:table_id)
5470
+ end
5471
+ end
5472
+
5296
5473
  # Defines an answer.
5297
5474
  class GoogleCloudDiscoveryengineV1betaAnswer
5298
5475
  include Google::Apis::Core::Hashable
@@ -5476,6 +5653,21 @@ module Google
5476
5653
  # @return [String]
5477
5654
  attr_accessor :session
5478
5655
 
5656
+ # The user labels applied to a resource must meet the following requirements: *
5657
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
5658
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
5659
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
5660
+ # have a maximum length of 63 characters. * Keys and values can contain only
5661
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
5662
+ # must use UTF-8 encoding, and international characters are allowed. * The key
5663
+ # portion of a label must be unique. However, you can use the same key with
5664
+ # multiple resources. * Keys must start with a lowercase letter or international
5665
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
5666
+ # manager/docs/creating-managing-labels#requirements) for more details.
5667
+ # Corresponds to the JSON property `userLabels`
5668
+ # @return [Hash<String,String>]
5669
+ attr_accessor :user_labels
5670
+
5479
5671
  # A unique identifier for tracking visitors. For example, this could be
5480
5672
  # implemented with an HTTP cookie, which should be able to uniquely identify a
5481
5673
  # visitor on a single device. This unique identifier should not change if the
@@ -5501,6 +5693,7 @@ module Google
5501
5693
  @safety_spec = args[:safety_spec] if args.key?(:safety_spec)
5502
5694
  @search_spec = args[:search_spec] if args.key?(:search_spec)
5503
5695
  @session = args[:session] if args.key?(:session)
5696
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
5504
5697
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
5505
5698
  end
5506
5699
  end
@@ -5802,6 +5995,15 @@ module Google
5802
5995
  # @return [String]
5803
5996
  attr_accessor :order_by
5804
5997
 
5998
+ # Specifies the search result mode. If unspecified, the search result mode is
5999
+ # based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
6000
+ # DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
6001
+ # * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](
6002
+ # https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
6003
+ # Corresponds to the JSON property `searchResultMode`
6004
+ # @return [String]
6005
+ attr_accessor :search_result_mode
6006
+
5805
6007
  def initialize(**args)
5806
6008
  update!(**args)
5807
6009
  end
@@ -5813,6 +6015,7 @@ module Google
5813
6015
  @filter = args[:filter] if args.key?(:filter)
5814
6016
  @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
5815
6017
  @order_by = args[:order_by] if args.key?(:order_by)
6018
+ @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
5816
6019
  end
5817
6020
  end
5818
6021
 
@@ -6928,6 +7131,164 @@ module Google
6928
7131
  end
6929
7132
  end
6930
7133
 
7134
+ # Chunk captures all raw metadata information of items to be recommended or
7135
+ # searched in the chunk mode.
7136
+ class GoogleCloudDiscoveryengineV1betaChunk
7137
+ include Google::Apis::Core::Hashable
7138
+
7139
+ # Metadata of the current chunk. This field is only populated on SearchService.
7140
+ # Search API.
7141
+ # Corresponds to the JSON property `chunkMetadata`
7142
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkChunkMetadata]
7143
+ attr_accessor :chunk_metadata
7144
+
7145
+ # Content is a string from a document (parsed content).
7146
+ # Corresponds to the JSON property `content`
7147
+ # @return [String]
7148
+ attr_accessor :content
7149
+
7150
+ # Output only. This field is OUTPUT_ONLY. It contains derived data that are not
7151
+ # in the original input document.
7152
+ # Corresponds to the JSON property `derivedStructData`
7153
+ # @return [Hash<String,Object>]
7154
+ attr_accessor :derived_struct_data
7155
+
7156
+ # Document metadata contains the information of the document of the current
7157
+ # chunk.
7158
+ # Corresponds to the JSON property `documentMetadata`
7159
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata]
7160
+ attr_accessor :document_metadata
7161
+
7162
+ # Unique chunk ID of the current chunk.
7163
+ # Corresponds to the JSON property `id`
7164
+ # @return [String]
7165
+ attr_accessor :id
7166
+
7167
+ # The full resource name of the chunk. Format: `projects/`project`/locations/`
7168
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch`/
7169
+ # documents/`document_id`/chunks/`chunk_id``. This field must be a UTF-8 encoded
7170
+ # string with a length limit of 1024 characters.
7171
+ # Corresponds to the JSON property `name`
7172
+ # @return [String]
7173
+ attr_accessor :name
7174
+
7175
+ # Page span of the chunk.
7176
+ # Corresponds to the JSON property `pageSpan`
7177
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkPageSpan]
7178
+ attr_accessor :page_span
7179
+
7180
+ # Output only. Represents the relevance score based on similarity. Higher score
7181
+ # indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only
7182
+ # populated on SearchService.SearchResponse.
7183
+ # Corresponds to the JSON property `relevanceScore`
7184
+ # @return [Float]
7185
+ attr_accessor :relevance_score
7186
+
7187
+ def initialize(**args)
7188
+ update!(**args)
7189
+ end
7190
+
7191
+ # Update properties of this object
7192
+ def update!(**args)
7193
+ @chunk_metadata = args[:chunk_metadata] if args.key?(:chunk_metadata)
7194
+ @content = args[:content] if args.key?(:content)
7195
+ @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
7196
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
7197
+ @id = args[:id] if args.key?(:id)
7198
+ @name = args[:name] if args.key?(:name)
7199
+ @page_span = args[:page_span] if args.key?(:page_span)
7200
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
7201
+ end
7202
+ end
7203
+
7204
+ # Metadata of the current chunk. This field is only populated on SearchService.
7205
+ # Search API.
7206
+ class GoogleCloudDiscoveryengineV1betaChunkChunkMetadata
7207
+ include Google::Apis::Core::Hashable
7208
+
7209
+ # The next chunks of the current chunk. The number is controlled by
7210
+ # SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only
7211
+ # populated on SearchService.Search API.
7212
+ # Corresponds to the JSON property `nextChunks`
7213
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk>]
7214
+ attr_accessor :next_chunks
7215
+
7216
+ # The previous chunks of the current chunk. The number is controlled by
7217
+ # SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is
7218
+ # only populated on SearchService.Search API.
7219
+ # Corresponds to the JSON property `previousChunks`
7220
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk>]
7221
+ attr_accessor :previous_chunks
7222
+
7223
+ def initialize(**args)
7224
+ update!(**args)
7225
+ end
7226
+
7227
+ # Update properties of this object
7228
+ def update!(**args)
7229
+ @next_chunks = args[:next_chunks] if args.key?(:next_chunks)
7230
+ @previous_chunks = args[:previous_chunks] if args.key?(:previous_chunks)
7231
+ end
7232
+ end
7233
+
7234
+ # Document metadata contains the information of the document of the current
7235
+ # chunk.
7236
+ class GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata
7237
+ include Google::Apis::Core::Hashable
7238
+
7239
+ # Data representation. The structured JSON data for the document. It should
7240
+ # conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
7241
+ # Corresponds to the JSON property `structData`
7242
+ # @return [Hash<String,Object>]
7243
+ attr_accessor :struct_data
7244
+
7245
+ # Title of the document.
7246
+ # Corresponds to the JSON property `title`
7247
+ # @return [String]
7248
+ attr_accessor :title
7249
+
7250
+ # Uri of the document.
7251
+ # Corresponds to the JSON property `uri`
7252
+ # @return [String]
7253
+ attr_accessor :uri
7254
+
7255
+ def initialize(**args)
7256
+ update!(**args)
7257
+ end
7258
+
7259
+ # Update properties of this object
7260
+ def update!(**args)
7261
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
7262
+ @title = args[:title] if args.key?(:title)
7263
+ @uri = args[:uri] if args.key?(:uri)
7264
+ end
7265
+ end
7266
+
7267
+ # Page span of the chunk.
7268
+ class GoogleCloudDiscoveryengineV1betaChunkPageSpan
7269
+ include Google::Apis::Core::Hashable
7270
+
7271
+ # The end page of the chunk.
7272
+ # Corresponds to the JSON property `pageEnd`
7273
+ # @return [Fixnum]
7274
+ attr_accessor :page_end
7275
+
7276
+ # The start page of the chunk.
7277
+ # Corresponds to the JSON property `pageStart`
7278
+ # @return [Fixnum]
7279
+ attr_accessor :page_start
7280
+
7281
+ def initialize(**args)
7282
+ update!(**args)
7283
+ end
7284
+
7285
+ # Update properties of this object
7286
+ def update!(**args)
7287
+ @page_end = args[:page_end] if args.key?(:page_end)
7288
+ @page_start = args[:page_start] if args.key?(:page_start)
7289
+ end
7290
+ end
7291
+
6931
7292
  # Cloud SQL source import data from.
6932
7293
  class GoogleCloudDiscoveryengineV1betaCloudSqlSource
6933
7294
  include Google::Apis::Core::Hashable
@@ -7837,6 +8198,11 @@ module Google
7837
8198
  # @return [String]
7838
8199
  attr_accessor :industry_vertical
7839
8200
 
8201
+ # Language info for DataStore.
8202
+ # Corresponds to the JSON property `languageInfo`
8203
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaLanguageInfo]
8204
+ attr_accessor :language_info
8205
+
7840
8206
  # Immutable. The full resource name of the data store. Format: `projects/`
7841
8207
  # project`/locations/`location`/collections/`collection_id`/dataStores/`
7842
8208
  # data_store_id``. This field must be a UTF-8 encoded string with a length limit
@@ -7870,6 +8236,7 @@ module Google
7870
8236
  @display_name = args[:display_name] if args.key?(:display_name)
7871
8237
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
7872
8238
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
8239
+ @language_info = args[:language_info] if args.key?(:language_info)
7873
8240
  @name = args[:name] if args.key?(:name)
7874
8241
  @solution_types = args[:solution_types] if args.key?(:solution_types)
7875
8242
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
@@ -8218,6 +8585,11 @@ module Google
8218
8585
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig
8219
8586
  include Google::Apis::Core::Hashable
8220
8587
 
8588
+ # Configuration for chunking config.
8589
+ # Corresponds to the JSON property `chunkingConfig`
8590
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig]
8591
+ attr_accessor :chunking_config
8592
+
8221
8593
  # Related configurations applied to a specific type of document parser.
8222
8594
  # Corresponds to the JSON property `defaultParsingConfig`
8223
8595
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig]
@@ -8245,12 +8617,60 @@ module Google
8245
8617
 
8246
8618
  # Update properties of this object
8247
8619
  def update!(**args)
8620
+ @chunking_config = args[:chunking_config] if args.key?(:chunking_config)
8248
8621
  @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
8249
8622
  @name = args[:name] if args.key?(:name)
8250
8623
  @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
8251
8624
  end
8252
8625
  end
8253
8626
 
8627
+ # Configuration for chunking config.
8628
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig
8629
+ include Google::Apis::Core::Hashable
8630
+
8631
+ # Configuration for the layout based chunking.
8632
+ # Corresponds to the JSON property `layoutBasedChunkingConfig`
8633
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig]
8634
+ attr_accessor :layout_based_chunking_config
8635
+
8636
+ def initialize(**args)
8637
+ update!(**args)
8638
+ end
8639
+
8640
+ # Update properties of this object
8641
+ def update!(**args)
8642
+ @layout_based_chunking_config = args[:layout_based_chunking_config] if args.key?(:layout_based_chunking_config)
8643
+ end
8644
+ end
8645
+
8646
+ # Configuration for the layout based chunking.
8647
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
8648
+ include Google::Apis::Core::Hashable
8649
+
8650
+ # The token size limit for each chunk. Supported values: 100-500 (inclusive).
8651
+ # Default value: 500.
8652
+ # Corresponds to the JSON property `chunkSize`
8653
+ # @return [Fixnum]
8654
+ attr_accessor :chunk_size
8655
+
8656
+ # Whether to include appending different levels of headings to chunks from the
8657
+ # middle of the document to prevent context loss. Default value: False.
8658
+ # Corresponds to the JSON property `includeAncestorHeadings`
8659
+ # @return [Boolean]
8660
+ attr_accessor :include_ancestor_headings
8661
+ alias_method :include_ancestor_headings?, :include_ancestor_headings
8662
+
8663
+ def initialize(**args)
8664
+ update!(**args)
8665
+ end
8666
+
8667
+ # Update properties of this object
8668
+ def update!(**args)
8669
+ @chunk_size = args[:chunk_size] if args.key?(:chunk_size)
8670
+ @include_ancestor_headings = args[:include_ancestor_headings] if args.key?(:include_ancestor_headings)
8671
+ end
8672
+ end
8673
+
8254
8674
  # Related configurations applied to a specific type of document parser.
8255
8675
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig
8256
8676
  include Google::Apis::Core::Hashable
@@ -8260,6 +8680,11 @@ module Google
8260
8680
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
8261
8681
  attr_accessor :digital_parsing_config
8262
8682
 
8683
+ # The layout parsing configurations for documents.
8684
+ # Corresponds to the JSON property `layoutParsingConfig`
8685
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig]
8686
+ attr_accessor :layout_parsing_config
8687
+
8263
8688
  # The OCR parsing configurations for documents.
8264
8689
  # Corresponds to the JSON property `ocrParsingConfig`
8265
8690
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig]
@@ -8272,6 +8697,7 @@ module Google
8272
8697
  # Update properties of this object
8273
8698
  def update!(**args)
8274
8699
  @digital_parsing_config = args[:digital_parsing_config] if args.key?(:digital_parsing_config)
8700
+ @layout_parsing_config = args[:layout_parsing_config] if args.key?(:layout_parsing_config)
8275
8701
  @ocr_parsing_config = args[:ocr_parsing_config] if args.key?(:ocr_parsing_config)
8276
8702
  end
8277
8703
  end
@@ -8289,6 +8715,19 @@ module Google
8289
8715
  end
8290
8716
  end
8291
8717
 
8718
+ # The layout parsing configurations for documents.
8719
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig
8720
+ include Google::Apis::Core::Hashable
8721
+
8722
+ def initialize(**args)
8723
+ update!(**args)
8724
+ end
8725
+
8726
+ # Update properties of this object
8727
+ def update!(**args)
8728
+ end
8729
+ end
8730
+
8292
8731
  # The OCR parsing configurations for documents.
8293
8732
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
8294
8733
  include Google::Apis::Core::Hashable
@@ -8912,6 +9351,11 @@ module Google
8912
9351
  class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
8913
9352
  include Google::Apis::Core::Hashable
8914
9353
 
9354
+ # AlloyDB source import data from.
9355
+ # Corresponds to the JSON property `alloyDbSource`
9356
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAlloyDbSource]
9357
+ attr_accessor :alloy_db_source
9358
+
8915
9359
  # Whether to automatically generate IDs for the documents if absent. If set to `
8916
9360
  # true`, Document.ids are automatically generated based on the hash of the
8917
9361
  # payload, where IDs may not be consistent during multiple imports. In which
@@ -9009,6 +9453,7 @@ module Google
9009
9453
 
9010
9454
  # Update properties of this object
9011
9455
  def update!(**args)
9456
+ @alloy_db_source = args[:alloy_db_source] if args.key?(:alloy_db_source)
9012
9457
  @auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids)
9013
9458
  @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
9014
9459
  @bigtable_source = args[:bigtable_source] if args.key?(:bigtable_source)
@@ -9367,6 +9812,47 @@ module Google
9367
9812
  end
9368
9813
  end
9369
9814
 
9815
+ # Language info for DataStore.
9816
+ class GoogleCloudDiscoveryengineV1betaLanguageInfo
9817
+ include Google::Apis::Core::Hashable
9818
+
9819
+ # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`,
9820
+ # `zh-Hans-HK` -> `zh`, `en` -> `en`.
9821
+ # Corresponds to the JSON property `language`
9822
+ # @return [String]
9823
+ attr_accessor :language
9824
+
9825
+ # The language code for the DataStore.
9826
+ # Corresponds to the JSON property `languageCode`
9827
+ # @return [String]
9828
+ attr_accessor :language_code
9829
+
9830
+ # Output only. This is the normalized form of language_code. E.g.: language_code
9831
+ # of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `
9832
+ # en-GB`.
9833
+ # Corresponds to the JSON property `normalizedLanguageCode`
9834
+ # @return [String]
9835
+ attr_accessor :normalized_language_code
9836
+
9837
+ # Output only. Region part of normalized_language_code, if present. E.g.: `en-US`
9838
+ # -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
9839
+ # Corresponds to the JSON property `region`
9840
+ # @return [String]
9841
+ attr_accessor :region
9842
+
9843
+ def initialize(**args)
9844
+ update!(**args)
9845
+ end
9846
+
9847
+ # Update properties of this object
9848
+ def update!(**args)
9849
+ @language = args[:language] if args.key?(:language)
9850
+ @language_code = args[:language_code] if args.key?(:language_code)
9851
+ @normalized_language_code = args[:normalized_language_code] if args.key?(:normalized_language_code)
9852
+ @region = args[:region] if args.key?(:region)
9853
+ end
9854
+ end
9855
+
9370
9856
  # Response for ListControls method.
9371
9857
  class GoogleCloudDiscoveryengineV1betaListControlsResponse
9372
9858
  include Google::Apis::Core::Hashable
@@ -10630,6 +11116,14 @@ module Google
10630
11116
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery]
10631
11117
  attr_accessor :image_query
10632
11118
 
11119
+ # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
11120
+ # see [Standard fields](https://cloud.google.com/apis/design/standard_fields).
11121
+ # This field helps to better interpret the query. If a value isn't specified,
11122
+ # the query language code is automatically detected, which may not be accurate.
11123
+ # Corresponds to the JSON property `languageCode`
11124
+ # @return [String]
11125
+ attr_accessor :language_code
11126
+
10633
11127
  # A 0-indexed integer that specifies the current offset (that is, starting
10634
11128
  # result location, amongst the Documents deemed by the API as relevant) in
10635
11129
  # search results. This field is only considered if page_token is unset. If this
@@ -10701,6 +11195,14 @@ module Google
10701
11195
  # @return [String]
10702
11196
  attr_accessor :ranking_expression
10703
11197
 
11198
+ # The Unicode country/region code (CLDR) of a location, such as "US" and "419".
11199
+ # For more information, see [Standard fields](https://cloud.google.com/apis/
11200
+ # design/standard_fields). If set, then results will be boosted based on the
11201
+ # region_code provided.
11202
+ # Corresponds to the JSON property `regionCode`
11203
+ # @return [String]
11204
+ attr_accessor :region_code
11205
+
10704
11206
  # Whether to turn on safe search. This is only supported for website search.
10705
11207
  # Corresponds to the JSON property `safeSearch`
10706
11208
  # @return [Boolean]
@@ -10759,6 +11261,7 @@ module Google
10759
11261
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
10760
11262
  @filter = args[:filter] if args.key?(:filter)
10761
11263
  @image_query = args[:image_query] if args.key?(:image_query)
11264
+ @language_code = args[:language_code] if args.key?(:language_code)
10762
11265
  @offset = args[:offset] if args.key?(:offset)
10763
11266
  @order_by = args[:order_by] if args.key?(:order_by)
10764
11267
  @page_size = args[:page_size] if args.key?(:page_size)
@@ -10767,6 +11270,7 @@ module Google
10767
11270
  @query = args[:query] if args.key?(:query)
10768
11271
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
10769
11272
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
11273
+ @region_code = args[:region_code] if args.key?(:region_code)
10770
11274
  @safe_search = args[:safe_search] if args.key?(:safe_search)
10771
11275
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
10772
11276
  @user_info = args[:user_info] if args.key?(:user_info)
@@ -10927,11 +11431,26 @@ module Google
10927
11431
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec
10928
11432
  include Google::Apis::Core::Hashable
10929
11433
 
11434
+ # Specifies the chunk spec to be returned from the search response. Only
11435
+ # available if the SearchRequest.ContentSearchSpec.search_result_mode is set to
11436
+ # CHUNKS
11437
+ # Corresponds to the JSON property `chunkSpec`
11438
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec]
11439
+ attr_accessor :chunk_spec
11440
+
10930
11441
  # A specification for configuring the extractive content in a search response.
10931
11442
  # Corresponds to the JSON property `extractiveContentSpec`
10932
11443
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec]
10933
11444
  attr_accessor :extractive_content_spec
10934
11445
 
11446
+ # Specifies the search result mode. If unspecified, the search result mode is
11447
+ # based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
11448
+ # DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
11449
+ # * Otherwise, it defaults to `DOCUMENTS`.
11450
+ # Corresponds to the JSON property `searchResultMode`
11451
+ # @return [String]
11452
+ attr_accessor :search_result_mode
11453
+
10935
11454
  # A specification for configuring snippets in a search response.
10936
11455
  # Corresponds to the JSON property `snippetSpec`
10937
11456
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec]
@@ -10948,12 +11467,43 @@ module Google
10948
11467
 
10949
11468
  # Update properties of this object
10950
11469
  def update!(**args)
11470
+ @chunk_spec = args[:chunk_spec] if args.key?(:chunk_spec)
10951
11471
  @extractive_content_spec = args[:extractive_content_spec] if args.key?(:extractive_content_spec)
11472
+ @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
10952
11473
  @snippet_spec = args[:snippet_spec] if args.key?(:snippet_spec)
10953
11474
  @summary_spec = args[:summary_spec] if args.key?(:summary_spec)
10954
11475
  end
10955
11476
  end
10956
11477
 
11478
+ # Specifies the chunk spec to be returned from the search response. Only
11479
+ # available if the SearchRequest.ContentSearchSpec.search_result_mode is set to
11480
+ # CHUNKS
11481
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec
11482
+ include Google::Apis::Core::Hashable
11483
+
11484
+ # The number of next chunks to be returned of the current chunk. The maximum
11485
+ # allowed value is 3. If not specified, no next chunks will be returned.
11486
+ # Corresponds to the JSON property `numNextChunks`
11487
+ # @return [Fixnum]
11488
+ attr_accessor :num_next_chunks
11489
+
11490
+ # The number of previous chunks to be returned of the current chunk. The maximum
11491
+ # allowed value is 3. If not specified, no previous chunks will be returned.
11492
+ # Corresponds to the JSON property `numPreviousChunks`
11493
+ # @return [Fixnum]
11494
+ attr_accessor :num_previous_chunks
11495
+
11496
+ def initialize(**args)
11497
+ update!(**args)
11498
+ end
11499
+
11500
+ # Update properties of this object
11501
+ def update!(**args)
11502
+ @num_next_chunks = args[:num_next_chunks] if args.key?(:num_next_chunks)
11503
+ @num_previous_chunks = args[:num_previous_chunks] if args.key?(:num_previous_chunks)
11504
+ end
11505
+ end
11506
+
10957
11507
  # A specification for configuring the extractive content in a search response.
10958
11508
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec
10959
11509
  include Google::Apis::Core::Hashable
@@ -11746,6 +12296,12 @@ module Google
11746
12296
  class GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult
11747
12297
  include Google::Apis::Core::Hashable
11748
12298
 
12299
+ # Chunk captures all raw metadata information of items to be recommended or
12300
+ # searched in the chunk mode.
12301
+ # Corresponds to the JSON property `chunk`
12302
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk]
12303
+ attr_accessor :chunk
12304
+
11749
12305
  # Document captures all raw metadata information of items to be recommended or
11750
12306
  # searched.
11751
12307
  # Corresponds to the JSON property `document`
@@ -11768,6 +12324,7 @@ module Google
11768
12324
 
11769
12325
  # Update properties of this object
11770
12326
  def update!(**args)
12327
+ @chunk = args[:chunk] if args.key?(:chunk)
11771
12328
  @document = args[:document] if args.key?(:document)
11772
12329
  @id = args[:id] if args.key?(:id)
11773
12330
  @model_scores = args[:model_scores] if args.key?(:model_scores)