google-apis-discoveryengine_v1beta 0.29.0 → 0.31.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2b02fc1f1bc67e55c85507df977a55fe291b03de5c0bd510b9f43b0e4b843ab0
|
4
|
+
data.tar.gz: 109a557b52a4642a1810a2383b2b5590651064ff9514d34c3f336ff0430a825b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 49df332b2a793c359def1c9c8e04240aaf953c465b07b962c2d7d82884b16dd3c7067a65f84ead84404083b6499e7255838a965b4a6c00a698967ccffa86b8cf
|
7
|
+
data.tar.gz: a253ebf6a49cfd93f74943ecd885fa4d5648e4aab711dfe656100b1054c903e63f113ca17bee5ee3ab2657b0d0235bcfc514dc22048f88cdb983ce74d67d29ec
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1beta
|
2
2
|
|
3
|
+
### v0.31.0 (2023-12-24)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20231218
|
6
|
+
|
7
|
+
### v0.30.0 (2023-12-17)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20231209
|
10
|
+
|
3
11
|
### v0.29.0 (2023-12-10)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20231130
|
@@ -992,6 +992,34 @@ module Google
|
|
992
992
|
end
|
993
993
|
end
|
994
994
|
|
995
|
+
# A singleton resource of DataStore. It's empty when DataStore is created, which
|
996
|
+
# defaults to digital parser. The first call to DataStoreService.
|
997
|
+
# UpdateDocumentProcessingConfig method will initialize the config.
|
998
|
+
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
|
999
|
+
include Google::Apis::Core::Hashable
|
1000
|
+
|
1001
|
+
# Output only. The full resource name of the Document Processing Config. Format:
|
1002
|
+
# `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
|
1003
|
+
# Corresponds to the JSON property `name`
|
1004
|
+
# @return [String]
|
1005
|
+
attr_accessor :name
|
1006
|
+
|
1007
|
+
# The OCR options for parsing documents.
|
1008
|
+
# Corresponds to the JSON property `ocrConfig`
|
1009
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaOcrConfig]
|
1010
|
+
attr_accessor :ocr_config
|
1011
|
+
|
1012
|
+
def initialize(**args)
|
1013
|
+
update!(**args)
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
# Update properties of this object
|
1017
|
+
def update!(**args)
|
1018
|
+
@name = args[:name] if args.key?(:name)
|
1019
|
+
@ocr_config = args[:ocr_config] if args.key?(:ocr_config)
|
1020
|
+
end
|
1021
|
+
end
|
1022
|
+
|
995
1023
|
# Metadata related to the progress of the SiteSearchEngineService.
|
996
1024
|
# EnableAdvancedSiteSearch operation. This will be returned by the google.
|
997
1025
|
# longrunning.Operation.metadata field.
|
@@ -1420,6 +1448,53 @@ module Google
|
|
1420
1448
|
end
|
1421
1449
|
end
|
1422
1450
|
|
1451
|
+
# Metadata related to the progress of the EstimateDataSize operation. This is
|
1452
|
+
# returned by the google.longrunning.Operation.metadata field.
|
1453
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
|
1454
|
+
include Google::Apis::Core::Hashable
|
1455
|
+
|
1456
|
+
# Operation create time.
|
1457
|
+
# Corresponds to the JSON property `createTime`
|
1458
|
+
# @return [String]
|
1459
|
+
attr_accessor :create_time
|
1460
|
+
|
1461
|
+
def initialize(**args)
|
1462
|
+
update!(**args)
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Update properties of this object
|
1466
|
+
def update!(**args)
|
1467
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1468
|
+
end
|
1469
|
+
end
|
1470
|
+
|
1471
|
+
# Response of the EstimateDataSize request. If the long running operation was
|
1472
|
+
# successful, then this message is returned by the google.longrunning.Operations.
|
1473
|
+
# response field if the operation was successful.
|
1474
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
|
1475
|
+
include Google::Apis::Core::Hashable
|
1476
|
+
|
1477
|
+
# Data size in terms of bytes.
|
1478
|
+
# Corresponds to the JSON property `dataSizeBytes`
|
1479
|
+
# @return [Fixnum]
|
1480
|
+
attr_accessor :data_size_bytes
|
1481
|
+
|
1482
|
+
# Total number of documents.
|
1483
|
+
# Corresponds to the JSON property `documentCount`
|
1484
|
+
# @return [Fixnum]
|
1485
|
+
attr_accessor :document_count
|
1486
|
+
|
1487
|
+
def initialize(**args)
|
1488
|
+
update!(**args)
|
1489
|
+
end
|
1490
|
+
|
1491
|
+
# Update properties of this object
|
1492
|
+
def update!(**args)
|
1493
|
+
@data_size_bytes = args[:data_size_bytes] if args.key?(:data_size_bytes)
|
1494
|
+
@document_count = args[:document_count] if args.key?(:document_count)
|
1495
|
+
end
|
1496
|
+
end
|
1497
|
+
|
1423
1498
|
# Configurations for fields of a schema. For example, configuring a field is
|
1424
1499
|
# indexable, or searchable.
|
1425
1500
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -1703,6 +1778,42 @@ module Google
|
|
1703
1778
|
end
|
1704
1779
|
end
|
1705
1780
|
|
1781
|
+
# The OCR options for parsing documents.
|
1782
|
+
class GoogleCloudDiscoveryengineV1alphaOcrConfig
|
1783
|
+
include Google::Apis::Core::Hashable
|
1784
|
+
|
1785
|
+
# Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig
|
1786
|
+
# options to apply.
|
1787
|
+
# Corresponds to the JSON property `enabled`
|
1788
|
+
# @return [Boolean]
|
1789
|
+
attr_accessor :enabled
|
1790
|
+
alias_method :enabled?, :enabled
|
1791
|
+
|
1792
|
+
# Apply additional enhanced OCR processing to a list of document elements.
|
1793
|
+
# Supported values: * `table`: advanced table parsing model.
|
1794
|
+
# Corresponds to the JSON property `enhancedDocumentElements`
|
1795
|
+
# @return [Array<String>]
|
1796
|
+
attr_accessor :enhanced_document_elements
|
1797
|
+
|
1798
|
+
# If true, will use native text instead of OCR text on pages containing native
|
1799
|
+
# text.
|
1800
|
+
# Corresponds to the JSON property `useNativeText`
|
1801
|
+
# @return [Boolean]
|
1802
|
+
attr_accessor :use_native_text
|
1803
|
+
alias_method :use_native_text?, :use_native_text
|
1804
|
+
|
1805
|
+
def initialize(**args)
|
1806
|
+
update!(**args)
|
1807
|
+
end
|
1808
|
+
|
1809
|
+
# Update properties of this object
|
1810
|
+
def update!(**args)
|
1811
|
+
@enabled = args[:enabled] if args.key?(:enabled)
|
1812
|
+
@enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
|
1813
|
+
@use_native_text = args[:use_native_text] if args.key?(:use_native_text)
|
1814
|
+
end
|
1815
|
+
end
|
1816
|
+
|
1706
1817
|
# Metadata related to the progress of the PurgeDocuments operation. This will be
|
1707
1818
|
# returned by the google.longrunning.Operation.metadata field.
|
1708
1819
|
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
@@ -2143,6 +2254,68 @@ module Google
|
|
2143
2254
|
end
|
2144
2255
|
end
|
2145
2256
|
|
2257
|
+
# Metadata related to the progress of the TrainCustomModel operation. This is
|
2258
|
+
# returned by the google.longrunning.Operation.metadata field.
|
2259
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
|
2260
|
+
include Google::Apis::Core::Hashable
|
2261
|
+
|
2262
|
+
# Operation create time.
|
2263
|
+
# Corresponds to the JSON property `createTime`
|
2264
|
+
# @return [String]
|
2265
|
+
attr_accessor :create_time
|
2266
|
+
|
2267
|
+
# Operation last update time. If the operation is done, this is also the finish
|
2268
|
+
# time.
|
2269
|
+
# Corresponds to the JSON property `updateTime`
|
2270
|
+
# @return [String]
|
2271
|
+
attr_accessor :update_time
|
2272
|
+
|
2273
|
+
def initialize(**args)
|
2274
|
+
update!(**args)
|
2275
|
+
end
|
2276
|
+
|
2277
|
+
# Update properties of this object
|
2278
|
+
def update!(**args)
|
2279
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
2280
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
2281
|
+
end
|
2282
|
+
end
|
2283
|
+
|
2284
|
+
# Response of the TrainCustomModelRequest. This message is returned by the
|
2285
|
+
# google.longrunning.Operations.response field.
|
2286
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
|
2287
|
+
include Google::Apis::Core::Hashable
|
2288
|
+
|
2289
|
+
# Configuration of destination for Import related errors.
|
2290
|
+
# Corresponds to the JSON property `errorConfig`
|
2291
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaImportErrorConfig]
|
2292
|
+
attr_accessor :error_config
|
2293
|
+
|
2294
|
+
# A sample of errors encountered while processing the data.
|
2295
|
+
# Corresponds to the JSON property `errorSamples`
|
2296
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
|
2297
|
+
attr_accessor :error_samples
|
2298
|
+
|
2299
|
+
# The trained model status. Possible values are: * **bad-data**: The training
|
2300
|
+
# data quality is bad. * **no-improvement**: Tuning didn't improve performance.
|
2301
|
+
# Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
|
2302
|
+
# The model is ready for serving.
|
2303
|
+
# Corresponds to the JSON property `modelStatus`
|
2304
|
+
# @return [String]
|
2305
|
+
attr_accessor :model_status
|
2306
|
+
|
2307
|
+
def initialize(**args)
|
2308
|
+
update!(**args)
|
2309
|
+
end
|
2310
|
+
|
2311
|
+
# Update properties of this object
|
2312
|
+
def update!(**args)
|
2313
|
+
@error_config = args[:error_config] if args.key?(:error_config)
|
2314
|
+
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
2315
|
+
@model_status = args[:model_status] if args.key?(:model_status)
|
2316
|
+
end
|
2317
|
+
end
|
2318
|
+
|
2146
2319
|
# Metadata associated with a tune operation.
|
2147
2320
|
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
2148
2321
|
include Google::Apis::Core::Hashable
|
@@ -2500,6 +2673,22 @@ module Google
|
|
2500
2673
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2501
2674
|
attr_accessor :conversation
|
2502
2675
|
|
2676
|
+
# The filter syntax consists of an expression language for constructing a
|
2677
|
+
# predicate from one or more fields of the documents being filtered. Filter
|
2678
|
+
# expression is case-sensitive. This will be used to filter search results which
|
2679
|
+
# may affect the summary response. If this field is unrecognizable, an `
|
2680
|
+
# INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
|
2681
|
+
# mapping the LHS filter key to a key property defined in the Vertex AI Search
|
2682
|
+
# backend -- this mapping is defined by the customer in their schema. For
|
2683
|
+
# example a media customer might have a field 'name' in their schema. In this
|
2684
|
+
# case the filter would look like this: filter --> name:'ANY("king kong")' For
|
2685
|
+
# more information about filtering including syntax and filter operators, see [
|
2686
|
+
# Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
|
2687
|
+
# metadata)
|
2688
|
+
# Corresponds to the JSON property `filter`
|
2689
|
+
# @return [String]
|
2690
|
+
attr_accessor :filter
|
2691
|
+
|
2503
2692
|
# Defines text input.
|
2504
2693
|
# Corresponds to the JSON property `query`
|
2505
2694
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTextInput]
|
@@ -2546,6 +2735,7 @@ module Google
|
|
2546
2735
|
# Update properties of this object
|
2547
2736
|
def update!(**args)
|
2548
2737
|
@conversation = args[:conversation] if args.key?(:conversation)
|
2738
|
+
@filter = args[:filter] if args.key?(:filter)
|
2549
2739
|
@query = args[:query] if args.key?(:query)
|
2550
2740
|
@safe_search = args[:safe_search] if args.key?(:safe_search)
|
2551
2741
|
@serving_config = args[:serving_config] if args.key?(:serving_config)
|
@@ -4309,6 +4499,11 @@ module Google
|
|
4309
4499
|
# @return [String]
|
4310
4500
|
attr_accessor :language_code
|
4311
4501
|
|
4502
|
+
# Specification of the prompt to use with the model.
|
4503
|
+
# Corresponds to the JSON property `modelPromptSpec`
|
4504
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec]
|
4505
|
+
attr_accessor :model_prompt_spec
|
4506
|
+
|
4312
4507
|
# Specification of the model.
|
4313
4508
|
# Corresponds to the JSON property `modelSpec`
|
4314
4509
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec]
|
@@ -4332,16 +4527,37 @@ module Google
|
|
4332
4527
|
@ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
|
4333
4528
|
@include_citations = args[:include_citations] if args.key?(:include_citations)
|
4334
4529
|
@language_code = args[:language_code] if args.key?(:language_code)
|
4530
|
+
@model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
|
4335
4531
|
@model_spec = args[:model_spec] if args.key?(:model_spec)
|
4336
4532
|
@summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
|
4337
4533
|
end
|
4338
4534
|
end
|
4339
4535
|
|
4536
|
+
# Specification of the prompt to use with the model.
|
4537
|
+
class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
|
4538
|
+
include Google::Apis::Core::Hashable
|
4539
|
+
|
4540
|
+
# Text at the beginning of the prompt that instructs the assistant. Examples are
|
4541
|
+
# available in the user guide.
|
4542
|
+
# Corresponds to the JSON property `preamble`
|
4543
|
+
# @return [String]
|
4544
|
+
attr_accessor :preamble
|
4545
|
+
|
4546
|
+
def initialize(**args)
|
4547
|
+
update!(**args)
|
4548
|
+
end
|
4549
|
+
|
4550
|
+
# Update properties of this object
|
4551
|
+
def update!(**args)
|
4552
|
+
@preamble = args[:preamble] if args.key?(:preamble)
|
4553
|
+
end
|
4554
|
+
end
|
4555
|
+
|
4340
4556
|
# Specification of the model.
|
4341
4557
|
class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
|
4342
4558
|
include Google::Apis::Core::Hashable
|
4343
4559
|
|
4344
|
-
# The string format of the model version. e.g. stable,
|
4560
|
+
# The string format of the model version. e.g. stable, preview, etc.
|
4345
4561
|
# Corresponds to the JSON property `version`
|
4346
4562
|
# @return [String]
|
4347
4563
|
attr_accessor :version
|
@@ -4933,6 +5149,11 @@ module Google
|
|
4933
5149
|
# @return [String]
|
4934
5150
|
attr_accessor :summary_text
|
4935
5151
|
|
5152
|
+
# Summary with metadata information.
|
5153
|
+
# Corresponds to the JSON property `summaryWithMetadata`
|
5154
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata]
|
5155
|
+
attr_accessor :summary_with_metadata
|
5156
|
+
|
4936
5157
|
def initialize(**args)
|
4937
5158
|
update!(**args)
|
4938
5159
|
end
|
@@ -4942,6 +5163,110 @@ module Google
|
|
4942
5163
|
@safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
|
4943
5164
|
@summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
|
4944
5165
|
@summary_text = args[:summary_text] if args.key?(:summary_text)
|
5166
|
+
@summary_with_metadata = args[:summary_with_metadata] if args.key?(:summary_with_metadata)
|
5167
|
+
end
|
5168
|
+
end
|
5169
|
+
|
5170
|
+
# Citation info for a segment.
|
5171
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
|
5172
|
+
include Google::Apis::Core::Hashable
|
5173
|
+
|
5174
|
+
# End of the attributed segment, exclusive.
|
5175
|
+
# Corresponds to the JSON property `endIndex`
|
5176
|
+
# @return [Fixnum]
|
5177
|
+
attr_accessor :end_index
|
5178
|
+
|
5179
|
+
# Citation sources for the attributed segment.
|
5180
|
+
# Corresponds to the JSON property `sources`
|
5181
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource>]
|
5182
|
+
attr_accessor :sources
|
5183
|
+
|
5184
|
+
# Index indicates the start of the segment, measured in bytes/unicode.
|
5185
|
+
# Corresponds to the JSON property `startIndex`
|
5186
|
+
# @return [Fixnum]
|
5187
|
+
attr_accessor :start_index
|
5188
|
+
|
5189
|
+
def initialize(**args)
|
5190
|
+
update!(**args)
|
5191
|
+
end
|
5192
|
+
|
5193
|
+
# Update properties of this object
|
5194
|
+
def update!(**args)
|
5195
|
+
@end_index = args[:end_index] if args.key?(:end_index)
|
5196
|
+
@sources = args[:sources] if args.key?(:sources)
|
5197
|
+
@start_index = args[:start_index] if args.key?(:start_index)
|
5198
|
+
end
|
5199
|
+
end
|
5200
|
+
|
5201
|
+
# Citation metadata.
|
5202
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata
|
5203
|
+
include Google::Apis::Core::Hashable
|
5204
|
+
|
5205
|
+
# Citations for segments.
|
5206
|
+
# Corresponds to the JSON property `citations`
|
5207
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation>]
|
5208
|
+
attr_accessor :citations
|
5209
|
+
|
5210
|
+
def initialize(**args)
|
5211
|
+
update!(**args)
|
5212
|
+
end
|
5213
|
+
|
5214
|
+
# Update properties of this object
|
5215
|
+
def update!(**args)
|
5216
|
+
@citations = args[:citations] if args.key?(:citations)
|
5217
|
+
end
|
5218
|
+
end
|
5219
|
+
|
5220
|
+
# Citation source.
|
5221
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource
|
5222
|
+
include Google::Apis::Core::Hashable
|
5223
|
+
|
5224
|
+
# Document reference index from SummaryWithMetadata.references. It is 0-indexed
|
5225
|
+
# and the value will be zero if the reference_index is not set explicitly.
|
5226
|
+
# Corresponds to the JSON property `referenceIndex`
|
5227
|
+
# @return [Fixnum]
|
5228
|
+
attr_accessor :reference_index
|
5229
|
+
|
5230
|
+
def initialize(**args)
|
5231
|
+
update!(**args)
|
5232
|
+
end
|
5233
|
+
|
5234
|
+
# Update properties of this object
|
5235
|
+
def update!(**args)
|
5236
|
+
@reference_index = args[:reference_index] if args.key?(:reference_index)
|
5237
|
+
end
|
5238
|
+
end
|
5239
|
+
|
5240
|
+
# Document reference.
|
5241
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
|
5242
|
+
include Google::Apis::Core::Hashable
|
5243
|
+
|
5244
|
+
# Required. Document.name of the document. Full resource name of the referenced
|
5245
|
+
# document, in the format `projects/*/locations/*/collections/*/dataStores/*/
|
5246
|
+
# branches/*/documents/*`.
|
5247
|
+
# Corresponds to the JSON property `document`
|
5248
|
+
# @return [String]
|
5249
|
+
attr_accessor :document
|
5250
|
+
|
5251
|
+
# Title of the document.
|
5252
|
+
# Corresponds to the JSON property `title`
|
5253
|
+
# @return [String]
|
5254
|
+
attr_accessor :title
|
5255
|
+
|
5256
|
+
# GCS or HTTP uri for the document.
|
5257
|
+
# Corresponds to the JSON property `uri`
|
5258
|
+
# @return [String]
|
5259
|
+
attr_accessor :uri
|
5260
|
+
|
5261
|
+
def initialize(**args)
|
5262
|
+
update!(**args)
|
5263
|
+
end
|
5264
|
+
|
5265
|
+
# Update properties of this object
|
5266
|
+
def update!(**args)
|
5267
|
+
@document = args[:document] if args.key?(:document)
|
5268
|
+
@title = args[:title] if args.key?(:title)
|
5269
|
+
@uri = args[:uri] if args.key?(:uri)
|
4945
5270
|
end
|
4946
5271
|
end
|
4947
5272
|
|
@@ -4972,6 +5297,37 @@ module Google
|
|
4972
5297
|
end
|
4973
5298
|
end
|
4974
5299
|
|
5300
|
+
# Summary with metadata information.
|
5301
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
|
5302
|
+
include Google::Apis::Core::Hashable
|
5303
|
+
|
5304
|
+
# Citation metadata.
|
5305
|
+
# Corresponds to the JSON property `citationMetadata`
|
5306
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata]
|
5307
|
+
attr_accessor :citation_metadata
|
5308
|
+
|
5309
|
+
# Document References.
|
5310
|
+
# Corresponds to the JSON property `references`
|
5311
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference>]
|
5312
|
+
attr_accessor :references
|
5313
|
+
|
5314
|
+
# Summary text with no citation information.
|
5315
|
+
# Corresponds to the JSON property `summary`
|
5316
|
+
# @return [String]
|
5317
|
+
attr_accessor :summary
|
5318
|
+
|
5319
|
+
def initialize(**args)
|
5320
|
+
update!(**args)
|
5321
|
+
end
|
5322
|
+
|
5323
|
+
# Update properties of this object
|
5324
|
+
def update!(**args)
|
5325
|
+
@citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
|
5326
|
+
@references = args[:references] if args.key?(:references)
|
5327
|
+
@summary = args[:summary] if args.key?(:summary)
|
5328
|
+
end
|
5329
|
+
end
|
5330
|
+
|
4975
5331
|
# Defines text input.
|
4976
5332
|
class GoogleCloudDiscoveryengineV1betaTextInput
|
4977
5333
|
include Google::Apis::Core::Hashable
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.31.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20231218"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -208,6 +208,12 @@ module Google
|
|
208
208
|
include Google::Apis::Core::JsonObjectSupport
|
209
209
|
end
|
210
210
|
|
211
|
+
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
|
212
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
213
|
+
|
214
|
+
include Google::Apis::Core::JsonObjectSupport
|
215
|
+
end
|
216
|
+
|
211
217
|
class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
|
212
218
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
213
219
|
|
@@ -280,6 +286,18 @@ module Google
|
|
280
286
|
include Google::Apis::Core::JsonObjectSupport
|
281
287
|
end
|
282
288
|
|
289
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
|
290
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
291
|
+
|
292
|
+
include Google::Apis::Core::JsonObjectSupport
|
293
|
+
end
|
294
|
+
|
295
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
|
296
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
297
|
+
|
298
|
+
include Google::Apis::Core::JsonObjectSupport
|
299
|
+
end
|
300
|
+
|
283
301
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
284
302
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
285
303
|
|
@@ -316,6 +334,12 @@ module Google
|
|
316
334
|
include Google::Apis::Core::JsonObjectSupport
|
317
335
|
end
|
318
336
|
|
337
|
+
class GoogleCloudDiscoveryengineV1alphaOcrConfig
|
338
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
339
|
+
|
340
|
+
include Google::Apis::Core::JsonObjectSupport
|
341
|
+
end
|
342
|
+
|
319
343
|
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
320
344
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
321
345
|
|
@@ -394,6 +418,18 @@ module Google
|
|
394
418
|
include Google::Apis::Core::JsonObjectSupport
|
395
419
|
end
|
396
420
|
|
421
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
|
422
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
423
|
+
|
424
|
+
include Google::Apis::Core::JsonObjectSupport
|
425
|
+
end
|
426
|
+
|
427
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
|
428
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
429
|
+
|
430
|
+
include Google::Apis::Core::JsonObjectSupport
|
431
|
+
end
|
432
|
+
|
397
433
|
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
398
434
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
399
435
|
|
@@ -718,6 +754,12 @@ module Google
|
|
718
754
|
include Google::Apis::Core::JsonObjectSupport
|
719
755
|
end
|
720
756
|
|
757
|
+
class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
|
758
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
759
|
+
|
760
|
+
include Google::Apis::Core::JsonObjectSupport
|
761
|
+
end
|
762
|
+
|
721
763
|
class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
|
722
764
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
723
765
|
|
@@ -820,12 +862,42 @@ module Google
|
|
820
862
|
include Google::Apis::Core::JsonObjectSupport
|
821
863
|
end
|
822
864
|
|
865
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
|
866
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
867
|
+
|
868
|
+
include Google::Apis::Core::JsonObjectSupport
|
869
|
+
end
|
870
|
+
|
871
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata
|
872
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
873
|
+
|
874
|
+
include Google::Apis::Core::JsonObjectSupport
|
875
|
+
end
|
876
|
+
|
877
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource
|
878
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
879
|
+
|
880
|
+
include Google::Apis::Core::JsonObjectSupport
|
881
|
+
end
|
882
|
+
|
883
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
|
884
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
885
|
+
|
886
|
+
include Google::Apis::Core::JsonObjectSupport
|
887
|
+
end
|
888
|
+
|
823
889
|
class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
|
824
890
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
825
891
|
|
826
892
|
include Google::Apis::Core::JsonObjectSupport
|
827
893
|
end
|
828
894
|
|
895
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
|
896
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
897
|
+
|
898
|
+
include Google::Apis::Core::JsonObjectSupport
|
899
|
+
end
|
900
|
+
|
829
901
|
class GoogleCloudDiscoveryengineV1betaTextInput
|
830
902
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
831
903
|
|
@@ -1161,6 +1233,15 @@ module Google
|
|
1161
1233
|
end
|
1162
1234
|
end
|
1163
1235
|
|
1236
|
+
class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
|
1237
|
+
# @private
|
1238
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1239
|
+
property :name, as: 'name'
|
1240
|
+
property :ocr_config, as: 'ocrConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaOcrConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaOcrConfig::Representation
|
1241
|
+
|
1242
|
+
end
|
1243
|
+
end
|
1244
|
+
|
1164
1245
|
class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
|
1165
1246
|
# @private
|
1166
1247
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1277,6 +1358,21 @@ module Google
|
|
1277
1358
|
end
|
1278
1359
|
end
|
1279
1360
|
|
1361
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
|
1362
|
+
# @private
|
1363
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1364
|
+
property :create_time, as: 'createTime'
|
1365
|
+
end
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
|
1369
|
+
# @private
|
1370
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1371
|
+
property :data_size_bytes, :numeric_string => true, as: 'dataSizeBytes'
|
1372
|
+
property :document_count, :numeric_string => true, as: 'documentCount'
|
1373
|
+
end
|
1374
|
+
end
|
1375
|
+
|
1280
1376
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
1281
1377
|
# @private
|
1282
1378
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1341,6 +1437,15 @@ module Google
|
|
1341
1437
|
end
|
1342
1438
|
end
|
1343
1439
|
|
1440
|
+
class GoogleCloudDiscoveryengineV1alphaOcrConfig
|
1441
|
+
# @private
|
1442
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1443
|
+
property :enabled, as: 'enabled'
|
1444
|
+
collection :enhanced_document_elements, as: 'enhancedDocumentElements'
|
1445
|
+
property :use_native_text, as: 'useNativeText'
|
1446
|
+
end
|
1447
|
+
end
|
1448
|
+
|
1344
1449
|
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
1345
1450
|
# @private
|
1346
1451
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1465,6 +1570,25 @@ module Google
|
|
1465
1570
|
end
|
1466
1571
|
end
|
1467
1572
|
|
1573
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
|
1574
|
+
# @private
|
1575
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1576
|
+
property :create_time, as: 'createTime'
|
1577
|
+
property :update_time, as: 'updateTime'
|
1578
|
+
end
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
|
1582
|
+
# @private
|
1583
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1584
|
+
property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaImportErrorConfig::Representation
|
1585
|
+
|
1586
|
+
collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
|
1587
|
+
|
1588
|
+
property :model_status, as: 'modelStatus'
|
1589
|
+
end
|
1590
|
+
end
|
1591
|
+
|
1468
1592
|
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
1469
1593
|
# @private
|
1470
1594
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1569,6 +1693,7 @@ module Google
|
|
1569
1693
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1570
1694
|
property :conversation, as: 'conversation', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
1571
1695
|
|
1696
|
+
property :filter, as: 'filter'
|
1572
1697
|
property :query, as: 'query', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTextInput, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTextInput::Representation
|
1573
1698
|
|
1574
1699
|
property :safe_search, as: 'safeSearch'
|
@@ -2015,12 +2140,21 @@ module Google
|
|
2015
2140
|
property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
|
2016
2141
|
property :include_citations, as: 'includeCitations'
|
2017
2142
|
property :language_code, as: 'languageCode'
|
2143
|
+
property :model_prompt_spec, as: 'modelPromptSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec::Representation
|
2144
|
+
|
2018
2145
|
property :model_spec, as: 'modelSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec::Representation
|
2019
2146
|
|
2020
2147
|
property :summary_result_count, as: 'summaryResultCount'
|
2021
2148
|
end
|
2022
2149
|
end
|
2023
2150
|
|
2151
|
+
class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
|
2152
|
+
# @private
|
2153
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2154
|
+
property :preamble, as: 'preamble'
|
2155
|
+
end
|
2156
|
+
end
|
2157
|
+
|
2024
2158
|
class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
|
2025
2159
|
# @private
|
2026
2160
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2186,6 +2320,42 @@ module Google
|
|
2186
2320
|
|
2187
2321
|
collection :summary_skipped_reasons, as: 'summarySkippedReasons'
|
2188
2322
|
property :summary_text, as: 'summaryText'
|
2323
|
+
property :summary_with_metadata, as: 'summaryWithMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata::Representation
|
2324
|
+
|
2325
|
+
end
|
2326
|
+
end
|
2327
|
+
|
2328
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
|
2329
|
+
# @private
|
2330
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2331
|
+
property :end_index, :numeric_string => true, as: 'endIndex'
|
2332
|
+
collection :sources, as: 'sources', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource::Representation
|
2333
|
+
|
2334
|
+
property :start_index, :numeric_string => true, as: 'startIndex'
|
2335
|
+
end
|
2336
|
+
end
|
2337
|
+
|
2338
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata
|
2339
|
+
# @private
|
2340
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2341
|
+
collection :citations, as: 'citations', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation::Representation
|
2342
|
+
|
2343
|
+
end
|
2344
|
+
end
|
2345
|
+
|
2346
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource
|
2347
|
+
# @private
|
2348
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2349
|
+
property :reference_index, :numeric_string => true, as: 'referenceIndex'
|
2350
|
+
end
|
2351
|
+
end
|
2352
|
+
|
2353
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
|
2354
|
+
# @private
|
2355
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2356
|
+
property :document, as: 'document'
|
2357
|
+
property :title, as: 'title'
|
2358
|
+
property :uri, as: 'uri'
|
2189
2359
|
end
|
2190
2360
|
end
|
2191
2361
|
|
@@ -2197,6 +2367,17 @@ module Google
|
|
2197
2367
|
end
|
2198
2368
|
end
|
2199
2369
|
|
2370
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
|
2371
|
+
# @private
|
2372
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2373
|
+
property :citation_metadata, as: 'citationMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata::Representation
|
2374
|
+
|
2375
|
+
collection :references, as: 'references', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference::Representation
|
2376
|
+
|
2377
|
+
property :summary, as: 'summary'
|
2378
|
+
end
|
2379
|
+
end
|
2380
|
+
|
2200
2381
|
class GoogleCloudDiscoveryengineV1betaTextInput
|
2201
2382
|
# @private
|
2202
2383
|
class Representation < Google::Apis::Core::JsonRepresentation
|
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.
|
4
|
+
version: 0.31.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: 2023-12-
|
11
|
+
date: 2023-12-24 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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.31.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: []
|