google-apis-discoveryengine_v1beta 0.46.0 → 0.47.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 10ec2f3868af26986328dd7780e9440966edaad27a0b9ae1979635558b93e690
4
- data.tar.gz: 65ca84281abed4cb2e1ecafbe4aa3da0c33d4acb1395afb721a9ee5de2fd5bc1
3
+ metadata.gz: 529b8368b5559daf69ddc673fe286e58c67adc8d9080218fff1ac4d75dbd96a4
4
+ data.tar.gz: ef7902939c372b9107f16395e98c995a80220cad9aa97c92c0a2a726f3cfaff1
5
5
  SHA512:
6
- metadata.gz: de3e332261085696dd584fff36d4550a8730327d0ede40215e281b60c85f4b026a808a4e36c32badfb9cc3ab98aa190f8d237fc332118ef5404500a996f2fd83
7
- data.tar.gz: ed26d991e3c5e8567980a317e10d6bea7afddd8ddfe2041f4e8e7487eb3b4b2e2fc9d14b1e953f13cc393511b675caf8f22b7f5b314172b2b4805d4393075bd6
6
+ metadata.gz: b694aeee6e219d01f8d5c744826915bab49734f75fecb646f1fb1ea4831943060ffd22c7e92d4d6b612d416816de8604275813791418f1944274417944d2fe65
7
+ data.tar.gz: bdca999495c90834f00ce7a3d1a18bb87ba17607a446ab663a2b7b9f0b30abdc1ccfe865794d04afff5a18b062dfa87b0ee7b2e813f756020d0d98a075229d90
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-discoveryengine_v1beta
2
2
 
3
+ ### v0.47.0 (2024-06-09)
4
+
5
+ * Regenerated from discovery document revision 20240607
6
+
3
7
  ### v0.46.0 (2024-06-02)
4
8
 
5
9
  * Regenerated from discovery document revision 20240526
@@ -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
@@ -5293,6 +5365,64 @@ module Google
5293
5365
  end
5294
5366
  end
5295
5367
 
5368
+ # AlloyDB source import data from.
5369
+ class GoogleCloudDiscoveryengineV1betaAlloyDbSource
5370
+ include Google::Apis::Core::Hashable
5371
+
5372
+ # Required. The AlloyDB cluster to copy the data from with a length limit of 256
5373
+ # characters.
5374
+ # Corresponds to the JSON property `clusterId`
5375
+ # @return [String]
5376
+ attr_accessor :cluster_id
5377
+
5378
+ # Required. The AlloyDB database to copy the data from with a length limit of
5379
+ # 256 characters.
5380
+ # Corresponds to the JSON property `databaseId`
5381
+ # @return [String]
5382
+ attr_accessor :database_id
5383
+
5384
+ # Intermediate Cloud Storage directory used for the import with a length limit
5385
+ # of 2,000 characters. Can be specified if one wants to have the AlloyDB export
5386
+ # to a specific Cloud Storage directory. Ensure that the AlloyDB service account
5387
+ # has the necessary Cloud Storage Admin permissions to access the specified
5388
+ # Cloud Storage directory.
5389
+ # Corresponds to the JSON property `gcsStagingDir`
5390
+ # @return [String]
5391
+ attr_accessor :gcs_staging_dir
5392
+
5393
+ # Required. The AlloyDB location to copy the data from with a length limit of
5394
+ # 256 characters.
5395
+ # Corresponds to the JSON property `locationId`
5396
+ # @return [String]
5397
+ attr_accessor :location_id
5398
+
5399
+ # The project ID that the AlloyDB source is in with a length limit of 128
5400
+ # characters. If not specified, inherits the project ID from the parent request.
5401
+ # Corresponds to the JSON property `projectId`
5402
+ # @return [String]
5403
+ attr_accessor :project_id
5404
+
5405
+ # Required. The AlloyDB table to copy the data from with a length limit of 256
5406
+ # characters.
5407
+ # Corresponds to the JSON property `tableId`
5408
+ # @return [String]
5409
+ attr_accessor :table_id
5410
+
5411
+ def initialize(**args)
5412
+ update!(**args)
5413
+ end
5414
+
5415
+ # Update properties of this object
5416
+ def update!(**args)
5417
+ @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
5418
+ @database_id = args[:database_id] if args.key?(:database_id)
5419
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
5420
+ @location_id = args[:location_id] if args.key?(:location_id)
5421
+ @project_id = args[:project_id] if args.key?(:project_id)
5422
+ @table_id = args[:table_id] if args.key?(:table_id)
5423
+ end
5424
+ end
5425
+
5296
5426
  # Defines an answer.
5297
5427
  class GoogleCloudDiscoveryengineV1betaAnswer
5298
5428
  include Google::Apis::Core::Hashable
@@ -5476,6 +5606,21 @@ module Google
5476
5606
  # @return [String]
5477
5607
  attr_accessor :session
5478
5608
 
5609
+ # The user labels applied to a resource must meet the following requirements: *
5610
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
5611
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
5612
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
5613
+ # have a maximum length of 63 characters. * Keys and values can contain only
5614
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
5615
+ # must use UTF-8 encoding, and international characters are allowed. * The key
5616
+ # portion of a label must be unique. However, you can use the same key with
5617
+ # multiple resources. * Keys must start with a lowercase letter or international
5618
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
5619
+ # manager/docs/creating-managing-labels#requirements) for more details.
5620
+ # Corresponds to the JSON property `userLabels`
5621
+ # @return [Hash<String,String>]
5622
+ attr_accessor :user_labels
5623
+
5479
5624
  # A unique identifier for tracking visitors. For example, this could be
5480
5625
  # implemented with an HTTP cookie, which should be able to uniquely identify a
5481
5626
  # visitor on a single device. This unique identifier should not change if the
@@ -5501,6 +5646,7 @@ module Google
5501
5646
  @safety_spec = args[:safety_spec] if args.key?(:safety_spec)
5502
5647
  @search_spec = args[:search_spec] if args.key?(:search_spec)
5503
5648
  @session = args[:session] if args.key?(:session)
5649
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
5504
5650
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
5505
5651
  end
5506
5652
  end
@@ -5802,6 +5948,15 @@ module Google
5802
5948
  # @return [String]
5803
5949
  attr_accessor :order_by
5804
5950
 
5951
+ # Specifies the search result mode. If unspecified, the search result mode is
5952
+ # based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
5953
+ # DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
5954
+ # * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](
5955
+ # https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
5956
+ # Corresponds to the JSON property `searchResultMode`
5957
+ # @return [String]
5958
+ attr_accessor :search_result_mode
5959
+
5805
5960
  def initialize(**args)
5806
5961
  update!(**args)
5807
5962
  end
@@ -5813,6 +5968,7 @@ module Google
5813
5968
  @filter = args[:filter] if args.key?(:filter)
5814
5969
  @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
5815
5970
  @order_by = args[:order_by] if args.key?(:order_by)
5971
+ @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
5816
5972
  end
5817
5973
  end
5818
5974
 
@@ -6928,6 +7084,164 @@ module Google
6928
7084
  end
6929
7085
  end
6930
7086
 
7087
+ # Chunk captures all raw metadata information of items to be recommended or
7088
+ # searched in the chunk mode.
7089
+ class GoogleCloudDiscoveryengineV1betaChunk
7090
+ include Google::Apis::Core::Hashable
7091
+
7092
+ # Metadata of the current chunk. This field is only populated on SearchService.
7093
+ # Search API.
7094
+ # Corresponds to the JSON property `chunkMetadata`
7095
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkChunkMetadata]
7096
+ attr_accessor :chunk_metadata
7097
+
7098
+ # Content is a string from a document (parsed content).
7099
+ # Corresponds to the JSON property `content`
7100
+ # @return [String]
7101
+ attr_accessor :content
7102
+
7103
+ # Output only. This field is OUTPUT_ONLY. It contains derived data that are not
7104
+ # in the original input document.
7105
+ # Corresponds to the JSON property `derivedStructData`
7106
+ # @return [Hash<String,Object>]
7107
+ attr_accessor :derived_struct_data
7108
+
7109
+ # Document metadata contains the information of the document of the current
7110
+ # chunk.
7111
+ # Corresponds to the JSON property `documentMetadata`
7112
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata]
7113
+ attr_accessor :document_metadata
7114
+
7115
+ # Unique chunk ID of the current chunk.
7116
+ # Corresponds to the JSON property `id`
7117
+ # @return [String]
7118
+ attr_accessor :id
7119
+
7120
+ # The full resource name of the chunk. Format: `projects/`project`/locations/`
7121
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch`/
7122
+ # documents/`document_id`/chunks/`chunk_id``. This field must be a UTF-8 encoded
7123
+ # string with a length limit of 1024 characters.
7124
+ # Corresponds to the JSON property `name`
7125
+ # @return [String]
7126
+ attr_accessor :name
7127
+
7128
+ # Page span of the chunk.
7129
+ # Corresponds to the JSON property `pageSpan`
7130
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkPageSpan]
7131
+ attr_accessor :page_span
7132
+
7133
+ # Output only. Represents the relevance score based on similarity. Higher score
7134
+ # indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only
7135
+ # populated on SearchService.SearchResponse.
7136
+ # Corresponds to the JSON property `relevanceScore`
7137
+ # @return [Float]
7138
+ attr_accessor :relevance_score
7139
+
7140
+ def initialize(**args)
7141
+ update!(**args)
7142
+ end
7143
+
7144
+ # Update properties of this object
7145
+ def update!(**args)
7146
+ @chunk_metadata = args[:chunk_metadata] if args.key?(:chunk_metadata)
7147
+ @content = args[:content] if args.key?(:content)
7148
+ @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
7149
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
7150
+ @id = args[:id] if args.key?(:id)
7151
+ @name = args[:name] if args.key?(:name)
7152
+ @page_span = args[:page_span] if args.key?(:page_span)
7153
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
7154
+ end
7155
+ end
7156
+
7157
+ # Metadata of the current chunk. This field is only populated on SearchService.
7158
+ # Search API.
7159
+ class GoogleCloudDiscoveryengineV1betaChunkChunkMetadata
7160
+ include Google::Apis::Core::Hashable
7161
+
7162
+ # The next chunks of the current chunk. The number is controlled by
7163
+ # SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only
7164
+ # populated on SearchService.Search API.
7165
+ # Corresponds to the JSON property `nextChunks`
7166
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk>]
7167
+ attr_accessor :next_chunks
7168
+
7169
+ # The previous chunks of the current chunk. The number is controlled by
7170
+ # SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is
7171
+ # only populated on SearchService.Search API.
7172
+ # Corresponds to the JSON property `previousChunks`
7173
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk>]
7174
+ attr_accessor :previous_chunks
7175
+
7176
+ def initialize(**args)
7177
+ update!(**args)
7178
+ end
7179
+
7180
+ # Update properties of this object
7181
+ def update!(**args)
7182
+ @next_chunks = args[:next_chunks] if args.key?(:next_chunks)
7183
+ @previous_chunks = args[:previous_chunks] if args.key?(:previous_chunks)
7184
+ end
7185
+ end
7186
+
7187
+ # Document metadata contains the information of the document of the current
7188
+ # chunk.
7189
+ class GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata
7190
+ include Google::Apis::Core::Hashable
7191
+
7192
+ # Data representation. The structured JSON data for the document. It should
7193
+ # conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
7194
+ # Corresponds to the JSON property `structData`
7195
+ # @return [Hash<String,Object>]
7196
+ attr_accessor :struct_data
7197
+
7198
+ # Title of the document.
7199
+ # Corresponds to the JSON property `title`
7200
+ # @return [String]
7201
+ attr_accessor :title
7202
+
7203
+ # Uri of the document.
7204
+ # Corresponds to the JSON property `uri`
7205
+ # @return [String]
7206
+ attr_accessor :uri
7207
+
7208
+ def initialize(**args)
7209
+ update!(**args)
7210
+ end
7211
+
7212
+ # Update properties of this object
7213
+ def update!(**args)
7214
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
7215
+ @title = args[:title] if args.key?(:title)
7216
+ @uri = args[:uri] if args.key?(:uri)
7217
+ end
7218
+ end
7219
+
7220
+ # Page span of the chunk.
7221
+ class GoogleCloudDiscoveryengineV1betaChunkPageSpan
7222
+ include Google::Apis::Core::Hashable
7223
+
7224
+ # The end page of the chunk.
7225
+ # Corresponds to the JSON property `pageEnd`
7226
+ # @return [Fixnum]
7227
+ attr_accessor :page_end
7228
+
7229
+ # The start page of the chunk.
7230
+ # Corresponds to the JSON property `pageStart`
7231
+ # @return [Fixnum]
7232
+ attr_accessor :page_start
7233
+
7234
+ def initialize(**args)
7235
+ update!(**args)
7236
+ end
7237
+
7238
+ # Update properties of this object
7239
+ def update!(**args)
7240
+ @page_end = args[:page_end] if args.key?(:page_end)
7241
+ @page_start = args[:page_start] if args.key?(:page_start)
7242
+ end
7243
+ end
7244
+
6931
7245
  # Cloud SQL source import data from.
6932
7246
  class GoogleCloudDiscoveryengineV1betaCloudSqlSource
6933
7247
  include Google::Apis::Core::Hashable
@@ -8218,6 +8532,11 @@ module Google
8218
8532
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig
8219
8533
  include Google::Apis::Core::Hashable
8220
8534
 
8535
+ # Configuration for chunking config.
8536
+ # Corresponds to the JSON property `chunkingConfig`
8537
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig]
8538
+ attr_accessor :chunking_config
8539
+
8221
8540
  # Related configurations applied to a specific type of document parser.
8222
8541
  # Corresponds to the JSON property `defaultParsingConfig`
8223
8542
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig]
@@ -8245,12 +8564,60 @@ module Google
8245
8564
 
8246
8565
  # Update properties of this object
8247
8566
  def update!(**args)
8567
+ @chunking_config = args[:chunking_config] if args.key?(:chunking_config)
8248
8568
  @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
8249
8569
  @name = args[:name] if args.key?(:name)
8250
8570
  @parsing_config_overrides = args[:parsing_config_overrides] if args.key?(:parsing_config_overrides)
8251
8571
  end
8252
8572
  end
8253
8573
 
8574
+ # Configuration for chunking config.
8575
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig
8576
+ include Google::Apis::Core::Hashable
8577
+
8578
+ # Configuration for the layout based chunking.
8579
+ # Corresponds to the JSON property `layoutBasedChunkingConfig`
8580
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig]
8581
+ attr_accessor :layout_based_chunking_config
8582
+
8583
+ def initialize(**args)
8584
+ update!(**args)
8585
+ end
8586
+
8587
+ # Update properties of this object
8588
+ def update!(**args)
8589
+ @layout_based_chunking_config = args[:layout_based_chunking_config] if args.key?(:layout_based_chunking_config)
8590
+ end
8591
+ end
8592
+
8593
+ # Configuration for the layout based chunking.
8594
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
8595
+ include Google::Apis::Core::Hashable
8596
+
8597
+ # The token size limit for each chunk. Supported values: 100-500 (inclusive).
8598
+ # Default value: 500.
8599
+ # Corresponds to the JSON property `chunkSize`
8600
+ # @return [Fixnum]
8601
+ attr_accessor :chunk_size
8602
+
8603
+ # Whether to include appending different levels of headings to chunks from the
8604
+ # middle of the document to prevent context loss. Default value: False.
8605
+ # Corresponds to the JSON property `includeAncestorHeadings`
8606
+ # @return [Boolean]
8607
+ attr_accessor :include_ancestor_headings
8608
+ alias_method :include_ancestor_headings?, :include_ancestor_headings
8609
+
8610
+ def initialize(**args)
8611
+ update!(**args)
8612
+ end
8613
+
8614
+ # Update properties of this object
8615
+ def update!(**args)
8616
+ @chunk_size = args[:chunk_size] if args.key?(:chunk_size)
8617
+ @include_ancestor_headings = args[:include_ancestor_headings] if args.key?(:include_ancestor_headings)
8618
+ end
8619
+ end
8620
+
8254
8621
  # Related configurations applied to a specific type of document parser.
8255
8622
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig
8256
8623
  include Google::Apis::Core::Hashable
@@ -8260,6 +8627,11 @@ module Google
8260
8627
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig]
8261
8628
  attr_accessor :digital_parsing_config
8262
8629
 
8630
+ # The layout parsing configurations for documents.
8631
+ # Corresponds to the JSON property `layoutParsingConfig`
8632
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig]
8633
+ attr_accessor :layout_parsing_config
8634
+
8263
8635
  # The OCR parsing configurations for documents.
8264
8636
  # Corresponds to the JSON property `ocrParsingConfig`
8265
8637
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig]
@@ -8272,6 +8644,7 @@ module Google
8272
8644
  # Update properties of this object
8273
8645
  def update!(**args)
8274
8646
  @digital_parsing_config = args[:digital_parsing_config] if args.key?(:digital_parsing_config)
8647
+ @layout_parsing_config = args[:layout_parsing_config] if args.key?(:layout_parsing_config)
8275
8648
  @ocr_parsing_config = args[:ocr_parsing_config] if args.key?(:ocr_parsing_config)
8276
8649
  end
8277
8650
  end
@@ -8289,6 +8662,19 @@ module Google
8289
8662
  end
8290
8663
  end
8291
8664
 
8665
+ # The layout parsing configurations for documents.
8666
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig
8667
+ include Google::Apis::Core::Hashable
8668
+
8669
+ def initialize(**args)
8670
+ update!(**args)
8671
+ end
8672
+
8673
+ # Update properties of this object
8674
+ def update!(**args)
8675
+ end
8676
+ end
8677
+
8292
8678
  # The OCR parsing configurations for documents.
8293
8679
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
8294
8680
  include Google::Apis::Core::Hashable
@@ -8912,6 +9298,11 @@ module Google
8912
9298
  class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
8913
9299
  include Google::Apis::Core::Hashable
8914
9300
 
9301
+ # AlloyDB source import data from.
9302
+ # Corresponds to the JSON property `alloyDbSource`
9303
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAlloyDbSource]
9304
+ attr_accessor :alloy_db_source
9305
+
8915
9306
  # Whether to automatically generate IDs for the documents if absent. If set to `
8916
9307
  # true`, Document.ids are automatically generated based on the hash of the
8917
9308
  # payload, where IDs may not be consistent during multiple imports. In which
@@ -9009,6 +9400,7 @@ module Google
9009
9400
 
9010
9401
  # Update properties of this object
9011
9402
  def update!(**args)
9403
+ @alloy_db_source = args[:alloy_db_source] if args.key?(:alloy_db_source)
9012
9404
  @auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids)
9013
9405
  @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
9014
9406
  @bigtable_source = args[:bigtable_source] if args.key?(:bigtable_source)
@@ -10927,11 +11319,26 @@ module Google
10927
11319
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec
10928
11320
  include Google::Apis::Core::Hashable
10929
11321
 
11322
+ # Specifies the chunk spec to be returned from the search response. Only
11323
+ # available if the SearchRequest.ContentSearchSpec.search_result_mode is set to
11324
+ # CHUNKS
11325
+ # Corresponds to the JSON property `chunkSpec`
11326
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec]
11327
+ attr_accessor :chunk_spec
11328
+
10930
11329
  # A specification for configuring the extractive content in a search response.
10931
11330
  # Corresponds to the JSON property `extractiveContentSpec`
10932
11331
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec]
10933
11332
  attr_accessor :extractive_content_spec
10934
11333
 
11334
+ # Specifies the search result mode. If unspecified, the search result mode is
11335
+ # based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
11336
+ # DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
11337
+ # * Otherwise, it defaults to `DOCUMENTS`.
11338
+ # Corresponds to the JSON property `searchResultMode`
11339
+ # @return [String]
11340
+ attr_accessor :search_result_mode
11341
+
10935
11342
  # A specification for configuring snippets in a search response.
10936
11343
  # Corresponds to the JSON property `snippetSpec`
10937
11344
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec]
@@ -10948,12 +11355,43 @@ module Google
10948
11355
 
10949
11356
  # Update properties of this object
10950
11357
  def update!(**args)
11358
+ @chunk_spec = args[:chunk_spec] if args.key?(:chunk_spec)
10951
11359
  @extractive_content_spec = args[:extractive_content_spec] if args.key?(:extractive_content_spec)
11360
+ @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
10952
11361
  @snippet_spec = args[:snippet_spec] if args.key?(:snippet_spec)
10953
11362
  @summary_spec = args[:summary_spec] if args.key?(:summary_spec)
10954
11363
  end
10955
11364
  end
10956
11365
 
11366
+ # Specifies the chunk spec to be returned from the search response. Only
11367
+ # available if the SearchRequest.ContentSearchSpec.search_result_mode is set to
11368
+ # CHUNKS
11369
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec
11370
+ include Google::Apis::Core::Hashable
11371
+
11372
+ # The number of next chunks to be returned of the current chunk. The maximum
11373
+ # allowed value is 3. If not specified, no next chunks will be returned.
11374
+ # Corresponds to the JSON property `numNextChunks`
11375
+ # @return [Fixnum]
11376
+ attr_accessor :num_next_chunks
11377
+
11378
+ # The number of previous chunks to be returned of the current chunk. The maximum
11379
+ # allowed value is 3. If not specified, no previous chunks will be returned.
11380
+ # Corresponds to the JSON property `numPreviousChunks`
11381
+ # @return [Fixnum]
11382
+ attr_accessor :num_previous_chunks
11383
+
11384
+ def initialize(**args)
11385
+ update!(**args)
11386
+ end
11387
+
11388
+ # Update properties of this object
11389
+ def update!(**args)
11390
+ @num_next_chunks = args[:num_next_chunks] if args.key?(:num_next_chunks)
11391
+ @num_previous_chunks = args[:num_previous_chunks] if args.key?(:num_previous_chunks)
11392
+ end
11393
+ end
11394
+
10957
11395
  # A specification for configuring the extractive content in a search response.
10958
11396
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec
10959
11397
  include Google::Apis::Core::Hashable
@@ -11746,6 +12184,12 @@ module Google
11746
12184
  class GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult
11747
12185
  include Google::Apis::Core::Hashable
11748
12186
 
12187
+ # Chunk captures all raw metadata information of items to be recommended or
12188
+ # searched in the chunk mode.
12189
+ # Corresponds to the JSON property `chunk`
12190
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk]
12191
+ attr_accessor :chunk
12192
+
11749
12193
  # Document captures all raw metadata information of items to be recommended or
11750
12194
  # searched.
11751
12195
  # Corresponds to the JSON property `document`
@@ -11768,6 +12212,7 @@ module Google
11768
12212
 
11769
12213
  # Update properties of this object
11770
12214
  def update!(**args)
12215
+ @chunk = args[:chunk] if args.key?(:chunk)
11771
12216
  @document = args[:document] if args.key?(:document)
11772
12217
  @id = args[:id] if args.key?(:id)
11773
12218
  @model_scores = args[:model_scores] if args.key?(:model_scores)
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1beta
18
18
  # Version of the google-apis-discoveryengine_v1beta gem
19
- GEM_VERSION = "0.46.0"
19
+ GEM_VERSION = "0.47.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240526"
25
+ REVISION = "20240607"
26
26
  end
27
27
  end
28
28
  end
@@ -196,6 +196,18 @@ module Google
196
196
  include Google::Apis::Core::JsonObjectSupport
197
197
  end
198
198
 
199
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig
200
+ class Representation < Google::Apis::Core::JsonRepresentation; end
201
+
202
+ include Google::Apis::Core::JsonObjectSupport
203
+ end
204
+
205
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
206
+ class Representation < Google::Apis::Core::JsonRepresentation; end
207
+
208
+ include Google::Apis::Core::JsonObjectSupport
209
+ end
210
+
199
211
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig
200
212
  class Representation < Google::Apis::Core::JsonRepresentation; end
201
213
 
@@ -208,6 +220,12 @@ module Google
208
220
  include Google::Apis::Core::JsonObjectSupport
209
221
  end
210
222
 
223
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig
224
+ class Representation < Google::Apis::Core::JsonRepresentation; end
225
+
226
+ include Google::Apis::Core::JsonObjectSupport
227
+ end
228
+
211
229
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
212
230
  class Representation < Google::Apis::Core::JsonRepresentation; end
213
231
 
@@ -982,6 +1000,12 @@ module Google
982
1000
  include Google::Apis::Core::JsonObjectSupport
983
1001
  end
984
1002
 
1003
+ class GoogleCloudDiscoveryengineV1betaAlloyDbSource
1004
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1005
+
1006
+ include Google::Apis::Core::JsonObjectSupport
1007
+ end
1008
+
985
1009
  class GoogleCloudDiscoveryengineV1betaAnswer
986
1010
  class Representation < Google::Apis::Core::JsonRepresentation; end
987
1011
 
@@ -1276,6 +1300,30 @@ module Google
1276
1300
  include Google::Apis::Core::JsonObjectSupport
1277
1301
  end
1278
1302
 
1303
+ class GoogleCloudDiscoveryengineV1betaChunk
1304
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1305
+
1306
+ include Google::Apis::Core::JsonObjectSupport
1307
+ end
1308
+
1309
+ class GoogleCloudDiscoveryengineV1betaChunkChunkMetadata
1310
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1311
+
1312
+ include Google::Apis::Core::JsonObjectSupport
1313
+ end
1314
+
1315
+ class GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata
1316
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1317
+
1318
+ include Google::Apis::Core::JsonObjectSupport
1319
+ end
1320
+
1321
+ class GoogleCloudDiscoveryengineV1betaChunkPageSpan
1322
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1323
+
1324
+ include Google::Apis::Core::JsonObjectSupport
1325
+ end
1326
+
1279
1327
  class GoogleCloudDiscoveryengineV1betaCloudSqlSource
1280
1328
  class Representation < Google::Apis::Core::JsonRepresentation; end
1281
1329
 
@@ -1492,6 +1540,18 @@ module Google
1492
1540
  include Google::Apis::Core::JsonObjectSupport
1493
1541
  end
1494
1542
 
1543
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig
1544
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1545
+
1546
+ include Google::Apis::Core::JsonObjectSupport
1547
+ end
1548
+
1549
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
1550
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1551
+
1552
+ include Google::Apis::Core::JsonObjectSupport
1553
+ end
1554
+
1495
1555
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig
1496
1556
  class Representation < Google::Apis::Core::JsonRepresentation; end
1497
1557
 
@@ -1504,6 +1564,12 @@ module Google
1504
1564
  include Google::Apis::Core::JsonObjectSupport
1505
1565
  end
1506
1566
 
1567
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig
1568
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1569
+
1570
+ include Google::Apis::Core::JsonObjectSupport
1571
+ end
1572
+
1507
1573
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
1508
1574
  class Representation < Google::Apis::Core::JsonRepresentation; end
1509
1575
 
@@ -1954,6 +2020,12 @@ module Google
1954
2020
  include Google::Apis::Core::JsonObjectSupport
1955
2021
  end
1956
2022
 
2023
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec
2024
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2025
+
2026
+ include Google::Apis::Core::JsonObjectSupport
2027
+ end
2028
+
1957
2029
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec
1958
2030
  class Representation < Google::Apis::Core::JsonRepresentation; end
1959
2031
 
@@ -2574,6 +2646,8 @@ module Google
2574
2646
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfig
2575
2647
  # @private
2576
2648
  class Representation < Google::Apis::Core::JsonRepresentation
2649
+ property :chunking_config, as: 'chunkingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig::Representation
2650
+
2577
2651
  property :default_parsing_config, as: 'defaultParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig::Representation
2578
2652
 
2579
2653
  property :name, as: 'name'
@@ -2582,11 +2656,29 @@ module Google
2582
2656
  end
2583
2657
  end
2584
2658
 
2659
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig
2660
+ # @private
2661
+ class Representation < Google::Apis::Core::JsonRepresentation
2662
+ property :layout_based_chunking_config, as: 'layoutBasedChunkingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig::Representation
2663
+
2664
+ end
2665
+ end
2666
+
2667
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
2668
+ # @private
2669
+ class Representation < Google::Apis::Core::JsonRepresentation
2670
+ property :chunk_size, as: 'chunkSize'
2671
+ property :include_ancestor_headings, as: 'includeAncestorHeadings'
2672
+ end
2673
+ end
2674
+
2585
2675
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig
2586
2676
  # @private
2587
2677
  class Representation < Google::Apis::Core::JsonRepresentation
2588
2678
  property :digital_parsing_config, as: 'digitalParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig::Representation
2589
2679
 
2680
+ property :layout_parsing_config, as: 'layoutParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig::Representation
2681
+
2590
2682
  property :ocr_parsing_config, as: 'ocrParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig::Representation
2591
2683
 
2592
2684
  end
@@ -2598,6 +2690,12 @@ module Google
2598
2690
  end
2599
2691
  end
2600
2692
 
2693
+ class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig
2694
+ # @private
2695
+ class Representation < Google::Apis::Core::JsonRepresentation
2696
+ end
2697
+ end
2698
+
2601
2699
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
2602
2700
  # @private
2603
2701
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3819,6 +3917,18 @@ module Google
3819
3917
  end
3820
3918
  end
3821
3919
 
3920
+ class GoogleCloudDiscoveryengineV1betaAlloyDbSource
3921
+ # @private
3922
+ class Representation < Google::Apis::Core::JsonRepresentation
3923
+ property :cluster_id, as: 'clusterId'
3924
+ property :database_id, as: 'databaseId'
3925
+ property :gcs_staging_dir, as: 'gcsStagingDir'
3926
+ property :location_id, as: 'locationId'
3927
+ property :project_id, as: 'projectId'
3928
+ property :table_id, as: 'tableId'
3929
+ end
3930
+ end
3931
+
3822
3932
  class GoogleCloudDiscoveryengineV1betaAnswer
3823
3933
  # @private
3824
3934
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3874,6 +3984,7 @@ module Google
3874
3984
  property :search_spec, as: 'searchSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec::Representation
3875
3985
 
3876
3986
  property :session, as: 'session'
3987
+ hash :user_labels, as: 'userLabels'
3877
3988
  property :user_pseudo_id, as: 'userPseudoId'
3878
3989
  end
3879
3990
  end
@@ -3966,6 +4077,7 @@ module Google
3966
4077
  property :filter, as: 'filter'
3967
4078
  property :max_return_results, as: 'maxReturnResults'
3968
4079
  property :order_by, as: 'orderBy'
4080
+ property :search_result_mode, as: 'searchResultMode'
3969
4081
  end
3970
4082
  end
3971
4083
 
@@ -4304,6 +4416,50 @@ module Google
4304
4416
  end
4305
4417
  end
4306
4418
 
4419
+ class GoogleCloudDiscoveryengineV1betaChunk
4420
+ # @private
4421
+ class Representation < Google::Apis::Core::JsonRepresentation
4422
+ property :chunk_metadata, as: 'chunkMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkChunkMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkChunkMetadata::Representation
4423
+
4424
+ property :content, as: 'content'
4425
+ hash :derived_struct_data, as: 'derivedStructData'
4426
+ property :document_metadata, as: 'documentMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata::Representation
4427
+
4428
+ property :id, as: 'id'
4429
+ property :name, as: 'name'
4430
+ property :page_span, as: 'pageSpan', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkPageSpan, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkPageSpan::Representation
4431
+
4432
+ property :relevance_score, as: 'relevanceScore'
4433
+ end
4434
+ end
4435
+
4436
+ class GoogleCloudDiscoveryengineV1betaChunkChunkMetadata
4437
+ # @private
4438
+ class Representation < Google::Apis::Core::JsonRepresentation
4439
+ collection :next_chunks, as: 'nextChunks', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk::Representation
4440
+
4441
+ collection :previous_chunks, as: 'previousChunks', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk::Representation
4442
+
4443
+ end
4444
+ end
4445
+
4446
+ class GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata
4447
+ # @private
4448
+ class Representation < Google::Apis::Core::JsonRepresentation
4449
+ hash :struct_data, as: 'structData'
4450
+ property :title, as: 'title'
4451
+ property :uri, as: 'uri'
4452
+ end
4453
+ end
4454
+
4455
+ class GoogleCloudDiscoveryengineV1betaChunkPageSpan
4456
+ # @private
4457
+ class Representation < Google::Apis::Core::JsonRepresentation
4458
+ property :page_end, as: 'pageEnd'
4459
+ property :page_start, as: 'pageStart'
4460
+ end
4461
+ end
4462
+
4307
4463
  class GoogleCloudDiscoveryengineV1betaCloudSqlSource
4308
4464
  # @private
4309
4465
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4651,6 +4807,8 @@ module Google
4651
4807
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig
4652
4808
  # @private
4653
4809
  class Representation < Google::Apis::Core::JsonRepresentation
4810
+ property :chunking_config, as: 'chunkingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig::Representation
4811
+
4654
4812
  property :default_parsing_config, as: 'defaultParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig::Representation
4655
4813
 
4656
4814
  property :name, as: 'name'
@@ -4659,11 +4817,29 @@ module Google
4659
4817
  end
4660
4818
  end
4661
4819
 
4820
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig
4821
+ # @private
4822
+ class Representation < Google::Apis::Core::JsonRepresentation
4823
+ property :layout_based_chunking_config, as: 'layoutBasedChunkingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig::Representation
4824
+
4825
+ end
4826
+ end
4827
+
4828
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
4829
+ # @private
4830
+ class Representation < Google::Apis::Core::JsonRepresentation
4831
+ property :chunk_size, as: 'chunkSize'
4832
+ property :include_ancestor_headings, as: 'includeAncestorHeadings'
4833
+ end
4834
+ end
4835
+
4662
4836
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig
4663
4837
  # @private
4664
4838
  class Representation < Google::Apis::Core::JsonRepresentation
4665
4839
  property :digital_parsing_config, as: 'digitalParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig::Representation
4666
4840
 
4841
+ property :layout_parsing_config, as: 'layoutParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig::Representation
4842
+
4667
4843
  property :ocr_parsing_config, as: 'ocrParsingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig::Representation
4668
4844
 
4669
4845
  end
@@ -4675,6 +4851,12 @@ module Google
4675
4851
  end
4676
4852
  end
4677
4853
 
4854
+ class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig
4855
+ # @private
4856
+ class Representation < Google::Apis::Core::JsonRepresentation
4857
+ end
4858
+ end
4859
+
4678
4860
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
4679
4861
  # @private
4680
4862
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4847,6 +5029,8 @@ module Google
4847
5029
  class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
4848
5030
  # @private
4849
5031
  class Representation < Google::Apis::Core::JsonRepresentation
5032
+ property :alloy_db_source, as: 'alloyDbSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAlloyDbSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAlloyDbSource::Representation
5033
+
4850
5034
  property :auto_generate_ids, as: 'autoGenerateIds'
4851
5035
  property :bigquery_source, as: 'bigquerySource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource::Representation
4852
5036
 
@@ -5399,8 +5583,11 @@ module Google
5399
5583
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec
5400
5584
  # @private
5401
5585
  class Representation < Google::Apis::Core::JsonRepresentation
5586
+ property :chunk_spec, as: 'chunkSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec::Representation
5587
+
5402
5588
  property :extractive_content_spec, as: 'extractiveContentSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec::Representation
5403
5589
 
5590
+ property :search_result_mode, as: 'searchResultMode'
5404
5591
  property :snippet_spec, as: 'snippetSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec::Representation
5405
5592
 
5406
5593
  property :summary_spec, as: 'summarySpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec::Representation
@@ -5408,6 +5595,14 @@ module Google
5408
5595
  end
5409
5596
  end
5410
5597
 
5598
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec
5599
+ # @private
5600
+ class Representation < Google::Apis::Core::JsonRepresentation
5601
+ property :num_next_chunks, as: 'numNextChunks'
5602
+ property :num_previous_chunks, as: 'numPreviousChunks'
5603
+ end
5604
+ end
5605
+
5411
5606
  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec
5412
5607
  # @private
5413
5608
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5608,6 +5803,8 @@ module Google
5608
5803
  class GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult
5609
5804
  # @private
5610
5805
  class Representation < Google::Apis::Core::JsonRepresentation
5806
+ property :chunk, as: 'chunk', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk::Representation
5807
+
5611
5808
  property :document, as: 'document', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
5612
5809
 
5613
5810
  property :id, as: 'id'
@@ -893,7 +893,8 @@ module Google
893
893
  # @param [String] parent
894
894
  # Required. Full resource name of parent data store. Format: `projects/`
895
895
  # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
896
- # `data_store_id``
896
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
897
+ # collections/`collection_id`/engines/`engine_id``.
897
898
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
898
899
  # @param [String] control_id
899
900
  # Required. The ID to use for the Control, which will become the final component
@@ -998,6 +999,8 @@ module Google
998
999
  # @param [String] parent
999
1000
  # Required. The data store resource name. Format: `projects/`project_number`/
1000
1001
  # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
1002
+ # or `projects/`project_number`/locations/`location_id`/collections/`
1003
+ # collection_id`/engines/`engine_id``.
1001
1004
  # @param [String] filter
1002
1005
  # Optional. A filter to apply on the list results. Supported features: * List
1003
1006
  # all the products under the parent branch if filter is unset. Currently this
@@ -3230,7 +3233,8 @@ module Google
3230
3233
  # @param [String] parent
3231
3234
  # Required. Full resource name of parent data store. Format: `projects/`
3232
3235
  # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3233
- # `data_store_id``
3236
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
3237
+ # collections/`collection_id`/engines/`engine_id``.
3234
3238
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
3235
3239
  # @param [String] control_id
3236
3240
  # Required. The ID to use for the Control, which will become the final component
@@ -3335,6 +3339,8 @@ module Google
3335
3339
  # @param [String] parent
3336
3340
  # Required. The data store resource name. Format: `projects/`project_number`/
3337
3341
  # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3342
+ # or `projects/`project_number`/locations/`location_id`/collections/`
3343
+ # collection_id`/engines/`engine_id``.
3338
3344
  # @param [String] filter
3339
3345
  # Optional. A filter to apply on the list results. Supported features: * List
3340
3346
  # all the products under the parent branch if filter is unset. Currently this
@@ -4934,7 +4940,8 @@ module Google
4934
4940
  # @param [String] parent
4935
4941
  # Required. Full resource name of parent data store. Format: `projects/`
4936
4942
  # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4937
- # `data_store_id``
4943
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
4944
+ # collections/`collection_id`/engines/`engine_id``.
4938
4945
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
4939
4946
  # @param [String] control_id
4940
4947
  # Required. The ID to use for the Control, which will become the final component
@@ -5039,6 +5046,8 @@ module Google
5039
5046
  # @param [String] parent
5040
5047
  # Required. The data store resource name. Format: `projects/`project_number`/
5041
5048
  # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
5049
+ # or `projects/`project_number`/locations/`location_id`/collections/`
5050
+ # collection_id`/engines/`engine_id``.
5042
5051
  # @param [String] filter
5043
5052
  # Optional. A filter to apply on the list results. Supported features: * List
5044
5053
  # all the products under the parent branch if filter is unset. Currently this
@@ -6785,6 +6794,54 @@ module Google
6785
6794
  execute_or_queue_command(command, &block)
6786
6795
  end
6787
6796
 
6797
+ # Writes a single user event from the browser. This uses a GET request to due to
6798
+ # browser restriction of POST-ing to a third-party domain. This method is used
6799
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
6800
+ # Users should not call this method directly.
6801
+ # @param [String] parent
6802
+ # Required. The parent DataStore resource name, such as `projects/`project`/
6803
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
6804
+ # @param [Fixnum] ets
6805
+ # The event timestamp in milliseconds. This prevents browser caching of
6806
+ # otherwise identical get requests. The name is abbreviated to reduce the
6807
+ # payload bytes.
6808
+ # @param [String] uri
6809
+ # The URL including cgi-parameters but excluding the hash fragment with a length
6810
+ # limit of 5,000 characters. This is often more useful than the referer URL,
6811
+ # because many browsers only send the domain for third-party requests.
6812
+ # @param [String] user_event
6813
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
6814
+ # characters.
6815
+ # @param [String] fields
6816
+ # Selector specifying which fields to include in a partial response.
6817
+ # @param [String] quota_user
6818
+ # Available to use for quota purposes for server-side applications. Can be any
6819
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6820
+ # @param [Google::Apis::RequestOptions] options
6821
+ # Request-specific options
6822
+ #
6823
+ # @yield [result, err] Result & error if block supplied
6824
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody] parsed result object
6825
+ # @yieldparam err [StandardError] error object if request failed
6826
+ #
6827
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody]
6828
+ #
6829
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6830
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6831
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6832
+ def collect_project_location_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
6833
+ command = make_simple_command(:get, 'v1beta/{+parent}/userEvents:collect', options)
6834
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody::Representation
6835
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody
6836
+ command.params['parent'] = parent unless parent.nil?
6837
+ command.query['ets'] = ets unless ets.nil?
6838
+ command.query['uri'] = uri unless uri.nil?
6839
+ command.query['userEvent'] = user_event unless user_event.nil?
6840
+ command.query['fields'] = fields unless fields.nil?
6841
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6842
+ execute_or_queue_command(command, &block)
6843
+ end
6844
+
6788
6845
  # Writes a single user event.
6789
6846
  # @param [String] parent
6790
6847
  # Required. The parent resource name. If the write user event action is applied
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.46.0
4
+ version: 0.47.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-06-02 00:00:00.000000000 Z
11
+ date: 2024-06-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.46.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.47.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []