@googleapis/discoveryengine 4.0.0 → 5.0.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.
- package/CHANGELOG.md +24 -0
- package/build/v1alpha.d.ts +1307 -84
- package/build/v1alpha.js +1132 -92
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +439 -3
- package/build/v1beta.js +200 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +7733 -3848
- package/v1beta.ts +943 -3
package/build/v1beta.d.ts
CHANGED
|
@@ -192,6 +192,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
192
192
|
*/
|
|
193
193
|
functionName?: string | null;
|
|
194
194
|
}
|
|
195
|
+
/**
|
|
196
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
197
|
+
*/
|
|
198
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
199
|
+
/**
|
|
200
|
+
* Operation create time.
|
|
201
|
+
*/
|
|
202
|
+
createTime?: string | null;
|
|
203
|
+
/**
|
|
204
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
205
|
+
*/
|
|
206
|
+
updateTime?: string | null;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
210
|
+
*/
|
|
211
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
|
|
212
|
+
/**
|
|
213
|
+
* TargetSites created.
|
|
214
|
+
*/
|
|
215
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
216
|
+
}
|
|
195
217
|
/**
|
|
196
218
|
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
197
219
|
*/
|
|
@@ -231,6 +253,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
231
253
|
*/
|
|
232
254
|
updateTime?: string | null;
|
|
233
255
|
}
|
|
256
|
+
/**
|
|
257
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
258
|
+
*/
|
|
259
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata {
|
|
260
|
+
/**
|
|
261
|
+
* Operation create time.
|
|
262
|
+
*/
|
|
263
|
+
createTime?: string | null;
|
|
264
|
+
/**
|
|
265
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
266
|
+
*/
|
|
267
|
+
updateTime?: string | null;
|
|
268
|
+
}
|
|
234
269
|
/**
|
|
235
270
|
* DataStore captures global settings and configs at the DataStore level.
|
|
236
271
|
*/
|
|
@@ -303,6 +338,68 @@ export declare namespace discoveryengine_v1beta {
|
|
|
303
338
|
*/
|
|
304
339
|
updateTime?: string | null;
|
|
305
340
|
}
|
|
341
|
+
/**
|
|
342
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
343
|
+
*/
|
|
344
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata {
|
|
345
|
+
/**
|
|
346
|
+
* Operation create time.
|
|
347
|
+
*/
|
|
348
|
+
createTime?: string | null;
|
|
349
|
+
/**
|
|
350
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
351
|
+
*/
|
|
352
|
+
updateTime?: string | null;
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
356
|
+
*/
|
|
357
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata {
|
|
358
|
+
/**
|
|
359
|
+
* Operation create time.
|
|
360
|
+
*/
|
|
361
|
+
createTime?: string | null;
|
|
362
|
+
/**
|
|
363
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
364
|
+
*/
|
|
365
|
+
updateTime?: string | null;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
369
|
+
*/
|
|
370
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
|
|
374
|
+
*/
|
|
375
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
376
|
+
/**
|
|
377
|
+
* Output only. The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
378
|
+
*/
|
|
379
|
+
name?: string | null;
|
|
380
|
+
/**
|
|
381
|
+
* The OCR config. Currently it only applies to PDFs.
|
|
382
|
+
*/
|
|
383
|
+
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
387
|
+
*/
|
|
388
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
|
|
389
|
+
/**
|
|
390
|
+
* Operation create time.
|
|
391
|
+
*/
|
|
392
|
+
createTime?: string | null;
|
|
393
|
+
/**
|
|
394
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
395
|
+
*/
|
|
396
|
+
updateTime?: string | null;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
400
|
+
*/
|
|
401
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {
|
|
402
|
+
}
|
|
306
403
|
/**
|
|
307
404
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
308
405
|
*/
|
|
@@ -485,6 +582,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
485
582
|
*/
|
|
486
583
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {
|
|
487
584
|
}
|
|
585
|
+
/**
|
|
586
|
+
* Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
587
|
+
*/
|
|
588
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata {
|
|
589
|
+
/**
|
|
590
|
+
* Operation create time.
|
|
591
|
+
*/
|
|
592
|
+
createTime?: string | null;
|
|
593
|
+
}
|
|
594
|
+
/**
|
|
595
|
+
* Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
596
|
+
*/
|
|
597
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse {
|
|
598
|
+
/**
|
|
599
|
+
* Data size in terms of bytes.
|
|
600
|
+
*/
|
|
601
|
+
dataSizeBytes?: string | null;
|
|
602
|
+
/**
|
|
603
|
+
* Total number of documents.
|
|
604
|
+
*/
|
|
605
|
+
documentCount?: string | null;
|
|
606
|
+
}
|
|
488
607
|
/**
|
|
489
608
|
* Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
|
|
490
609
|
*/
|
|
@@ -611,6 +730,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
611
730
|
*/
|
|
612
731
|
unjoinedEventsCount?: string | null;
|
|
613
732
|
}
|
|
733
|
+
/**
|
|
734
|
+
* The OCR options for parsing documents.
|
|
735
|
+
*/
|
|
736
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
737
|
+
/**
|
|
738
|
+
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
|
|
739
|
+
*/
|
|
740
|
+
enabled?: boolean | null;
|
|
741
|
+
/**
|
|
742
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
743
|
+
*/
|
|
744
|
+
enhancedDocumentElements?: string[] | null;
|
|
745
|
+
/**
|
|
746
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
747
|
+
*/
|
|
748
|
+
useNativeText?: boolean | null;
|
|
749
|
+
}
|
|
614
750
|
/**
|
|
615
751
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
616
752
|
*/
|
|
@@ -835,6 +971,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
835
971
|
}
|
|
836
972
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
837
973
|
}
|
|
974
|
+
/**
|
|
975
|
+
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
976
|
+
*/
|
|
977
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata {
|
|
978
|
+
/**
|
|
979
|
+
* Operation create time.
|
|
980
|
+
*/
|
|
981
|
+
createTime?: string | null;
|
|
982
|
+
/**
|
|
983
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
984
|
+
*/
|
|
985
|
+
updateTime?: string | null;
|
|
986
|
+
}
|
|
987
|
+
/**
|
|
988
|
+
* Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
|
|
989
|
+
*/
|
|
990
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
|
|
991
|
+
/**
|
|
992
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
993
|
+
*/
|
|
994
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
995
|
+
/**
|
|
996
|
+
* A sample of errors encountered while processing the data.
|
|
997
|
+
*/
|
|
998
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
999
|
+
/**
|
|
1000
|
+
* The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.
|
|
1001
|
+
*/
|
|
1002
|
+
modelStatus?: string | null;
|
|
1003
|
+
}
|
|
838
1004
|
/**
|
|
839
1005
|
* Metadata associated with a tune operation.
|
|
840
1006
|
*/
|
|
@@ -862,6 +1028,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
862
1028
|
*/
|
|
863
1029
|
updateTime?: string | null;
|
|
864
1030
|
}
|
|
1031
|
+
/**
|
|
1032
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1033
|
+
*/
|
|
1034
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata {
|
|
1035
|
+
/**
|
|
1036
|
+
* Operation create time.
|
|
1037
|
+
*/
|
|
1038
|
+
createTime?: string | null;
|
|
1039
|
+
/**
|
|
1040
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1041
|
+
*/
|
|
1042
|
+
updateTime?: string | null;
|
|
1043
|
+
}
|
|
865
1044
|
/**
|
|
866
1045
|
* BigQuery source import data from.
|
|
867
1046
|
*/
|
|
@@ -943,7 +1122,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
943
1122
|
*/
|
|
944
1123
|
messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[];
|
|
945
1124
|
/**
|
|
946
|
-
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x`
|
|
1125
|
+
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
947
1126
|
*/
|
|
948
1127
|
name?: string | null;
|
|
949
1128
|
/**
|
|
@@ -997,6 +1176,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
997
1176
|
* The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
|
|
998
1177
|
*/
|
|
999
1178
|
conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation;
|
|
1179
|
+
/**
|
|
1180
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
|
1181
|
+
*/
|
|
1182
|
+
filter?: string | null;
|
|
1000
1183
|
/**
|
|
1001
1184
|
* Required. Current user input.
|
|
1002
1185
|
*/
|
|
@@ -1841,11 +2024,37 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1841
2024
|
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
1842
2025
|
*/
|
|
1843
2026
|
languageCode?: string | null;
|
|
2027
|
+
/**
|
|
2028
|
+
* If specified, the spec will be used to modify the prompt provided to the LLM.
|
|
2029
|
+
*/
|
|
2030
|
+
modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
2031
|
+
/**
|
|
2032
|
+
* If specified, the spec will be used to modify the model specification provided to the LLM.
|
|
2033
|
+
*/
|
|
2034
|
+
modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1844
2035
|
/**
|
|
1845
2036
|
* The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.
|
|
1846
2037
|
*/
|
|
1847
2038
|
summaryResultCount?: number | null;
|
|
1848
2039
|
}
|
|
2040
|
+
/**
|
|
2041
|
+
* Specification of the prompt to use with the model.
|
|
2042
|
+
*/
|
|
2043
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
2044
|
+
/**
|
|
2045
|
+
* Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
|
|
2046
|
+
*/
|
|
2047
|
+
preamble?: string | null;
|
|
2048
|
+
}
|
|
2049
|
+
/**
|
|
2050
|
+
* Specification of the model.
|
|
2051
|
+
*/
|
|
2052
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2053
|
+
/**
|
|
2054
|
+
* The string format of the model version. e.g. stable, preview, etc.
|
|
2055
|
+
*/
|
|
2056
|
+
version?: string | null;
|
|
2057
|
+
}
|
|
1849
2058
|
/**
|
|
1850
2059
|
* The specification that uses customized query embedding vector to do semantic document retrieval.
|
|
1851
2060
|
*/
|
|
@@ -2124,6 +2333,59 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2124
2333
|
* The summary content.
|
|
2125
2334
|
*/
|
|
2126
2335
|
summaryText?: string | null;
|
|
2336
|
+
summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata;
|
|
2337
|
+
}
|
|
2338
|
+
/**
|
|
2339
|
+
* Citation info for a segment.
|
|
2340
|
+
*/
|
|
2341
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation {
|
|
2342
|
+
/**
|
|
2343
|
+
* End of the attributed segment, exclusive.
|
|
2344
|
+
*/
|
|
2345
|
+
endIndex?: string | null;
|
|
2346
|
+
/**
|
|
2347
|
+
* Citation sources for the attributed segment.
|
|
2348
|
+
*/
|
|
2349
|
+
sources?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[];
|
|
2350
|
+
/**
|
|
2351
|
+
* Index indicates the start of the segment, measured in bytes/unicode.
|
|
2352
|
+
*/
|
|
2353
|
+
startIndex?: string | null;
|
|
2354
|
+
}
|
|
2355
|
+
/**
|
|
2356
|
+
* Citation metadata.
|
|
2357
|
+
*/
|
|
2358
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata {
|
|
2359
|
+
/**
|
|
2360
|
+
* Citations for segments.
|
|
2361
|
+
*/
|
|
2362
|
+
citations?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[];
|
|
2363
|
+
}
|
|
2364
|
+
/**
|
|
2365
|
+
* Citation source.
|
|
2366
|
+
*/
|
|
2367
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource {
|
|
2368
|
+
/**
|
|
2369
|
+
* Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
|
|
2370
|
+
*/
|
|
2371
|
+
referenceIndex?: string | null;
|
|
2372
|
+
}
|
|
2373
|
+
/**
|
|
2374
|
+
* Document reference.
|
|
2375
|
+
*/
|
|
2376
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
|
|
2377
|
+
/**
|
|
2378
|
+
* Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`.
|
|
2379
|
+
*/
|
|
2380
|
+
document?: string | null;
|
|
2381
|
+
/**
|
|
2382
|
+
* Title of the document.
|
|
2383
|
+
*/
|
|
2384
|
+
title?: string | null;
|
|
2385
|
+
/**
|
|
2386
|
+
* GCS or HTTP uri for the document.
|
|
2387
|
+
*/
|
|
2388
|
+
uri?: string | null;
|
|
2127
2389
|
}
|
|
2128
2390
|
/**
|
|
2129
2391
|
* Safety Attribute categories and their associated confidence scores.
|
|
@@ -2138,6 +2400,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2138
2400
|
*/
|
|
2139
2401
|
scores?: number[] | null;
|
|
2140
2402
|
}
|
|
2403
|
+
/**
|
|
2404
|
+
* Summary with metadata information.
|
|
2405
|
+
*/
|
|
2406
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata {
|
|
2407
|
+
/**
|
|
2408
|
+
* Citation metadata for given summary.
|
|
2409
|
+
*/
|
|
2410
|
+
citationMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata;
|
|
2411
|
+
/**
|
|
2412
|
+
* Document References.
|
|
2413
|
+
*/
|
|
2414
|
+
references?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[];
|
|
2415
|
+
/**
|
|
2416
|
+
* Summary text with no citation information.
|
|
2417
|
+
*/
|
|
2418
|
+
summary?: string | null;
|
|
2419
|
+
}
|
|
2141
2420
|
/**
|
|
2142
2421
|
* Defines text input.
|
|
2143
2422
|
*/
|
|
@@ -3057,7 +3336,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3057
3336
|
}
|
|
3058
3337
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters {
|
|
3059
3338
|
/**
|
|
3060
|
-
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x`
|
|
3339
|
+
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
3061
3340
|
*/
|
|
3062
3341
|
name?: string;
|
|
3063
3342
|
/**
|
|
@@ -3632,10 +3911,167 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3632
3911
|
}
|
|
3633
3912
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
3634
3913
|
context: APIRequestContext;
|
|
3914
|
+
conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
|
|
3635
3915
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3636
3916
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3637
3917
|
constructor(context: APIRequestContext);
|
|
3638
3918
|
}
|
|
3919
|
+
export class Resource$Projects$Locations$Collections$Engines$Conversations {
|
|
3920
|
+
context: APIRequestContext;
|
|
3921
|
+
constructor(context: APIRequestContext);
|
|
3922
|
+
/**
|
|
3923
|
+
* Converses a conversation.
|
|
3924
|
+
*
|
|
3925
|
+
* @param params - Parameters for request
|
|
3926
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3927
|
+
* @param callback - Optional callback that handles the response.
|
|
3928
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3929
|
+
*/
|
|
3930
|
+
converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3931
|
+
converse(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse>;
|
|
3932
|
+
converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3933
|
+
converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse>): void;
|
|
3934
|
+
converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse>): void;
|
|
3935
|
+
converse(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse>): void;
|
|
3936
|
+
/**
|
|
3937
|
+
* Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
|
|
3938
|
+
*
|
|
3939
|
+
* @param params - Parameters for request
|
|
3940
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3941
|
+
* @param callback - Optional callback that handles the response.
|
|
3942
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3943
|
+
*/
|
|
3944
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3945
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaConversation>;
|
|
3946
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3947
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
3948
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
3949
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
3950
|
+
/**
|
|
3951
|
+
* Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
|
|
3952
|
+
*
|
|
3953
|
+
* @param params - Parameters for request
|
|
3954
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3955
|
+
* @param callback - Optional callback that handles the response.
|
|
3956
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3957
|
+
*/
|
|
3958
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3959
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
3960
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3961
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
3962
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
3963
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
3964
|
+
/**
|
|
3965
|
+
* Gets a Conversation.
|
|
3966
|
+
*
|
|
3967
|
+
* @param params - Parameters for request
|
|
3968
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3969
|
+
* @param callback - Optional callback that handles the response.
|
|
3970
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3971
|
+
*/
|
|
3972
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3973
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaConversation>;
|
|
3974
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3975
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
3976
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
3977
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
3978
|
+
/**
|
|
3979
|
+
* Lists all Conversations by their parent DataStore.
|
|
3980
|
+
*
|
|
3981
|
+
* @param params - Parameters for request
|
|
3982
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3983
|
+
* @param callback - Optional callback that handles the response.
|
|
3984
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3985
|
+
*/
|
|
3986
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3987
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse>;
|
|
3988
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3989
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse>): void;
|
|
3990
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse>): void;
|
|
3991
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse>): void;
|
|
3992
|
+
/**
|
|
3993
|
+
* Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
|
|
3994
|
+
*
|
|
3995
|
+
* @param params - Parameters for request
|
|
3996
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3997
|
+
* @param callback - Optional callback that handles the response.
|
|
3998
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3999
|
+
*/
|
|
4000
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4001
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaConversation>;
|
|
4002
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4003
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
4004
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
4005
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaConversation>): void;
|
|
4006
|
+
}
|
|
4007
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse extends StandardParameters {
|
|
4008
|
+
/**
|
|
4009
|
+
* Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
|
|
4010
|
+
*/
|
|
4011
|
+
name?: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* Request body metadata
|
|
4014
|
+
*/
|
|
4015
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest;
|
|
4016
|
+
}
|
|
4017
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create extends StandardParameters {
|
|
4018
|
+
/**
|
|
4019
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
4020
|
+
*/
|
|
4021
|
+
parent?: string;
|
|
4022
|
+
/**
|
|
4023
|
+
* Request body metadata
|
|
4024
|
+
*/
|
|
4025
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation;
|
|
4026
|
+
}
|
|
4027
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete extends StandardParameters {
|
|
4028
|
+
/**
|
|
4029
|
+
* Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
|
|
4030
|
+
*/
|
|
4031
|
+
name?: string;
|
|
4032
|
+
}
|
|
4033
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get extends StandardParameters {
|
|
4034
|
+
/**
|
|
4035
|
+
* Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
|
|
4036
|
+
*/
|
|
4037
|
+
name?: string;
|
|
4038
|
+
}
|
|
4039
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List extends StandardParameters {
|
|
4040
|
+
/**
|
|
4041
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
4042
|
+
*/
|
|
4043
|
+
filter?: string;
|
|
4044
|
+
/**
|
|
4045
|
+
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
|
|
4046
|
+
*/
|
|
4047
|
+
orderBy?: string;
|
|
4048
|
+
/**
|
|
4049
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
4050
|
+
*/
|
|
4051
|
+
pageSize?: number;
|
|
4052
|
+
/**
|
|
4053
|
+
* A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
|
|
4054
|
+
*/
|
|
4055
|
+
pageToken?: string;
|
|
4056
|
+
/**
|
|
4057
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
4058
|
+
*/
|
|
4059
|
+
parent?: string;
|
|
4060
|
+
}
|
|
4061
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters {
|
|
4062
|
+
/**
|
|
4063
|
+
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
4064
|
+
*/
|
|
4065
|
+
name?: string;
|
|
4066
|
+
/**
|
|
4067
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated.
|
|
4068
|
+
*/
|
|
4069
|
+
updateMask?: string;
|
|
4070
|
+
/**
|
|
4071
|
+
* Request body metadata
|
|
4072
|
+
*/
|
|
4073
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation;
|
|
4074
|
+
}
|
|
3639
4075
|
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
3640
4076
|
context: APIRequestContext;
|
|
3641
4077
|
constructor(context: APIRequestContext);
|
|
@@ -4229,7 +4665,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4229
4665
|
}
|
|
4230
4666
|
export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters {
|
|
4231
4667
|
/**
|
|
4232
|
-
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x`
|
|
4668
|
+
* Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
4233
4669
|
*/
|
|
4234
4670
|
name?: string;
|
|
4235
4671
|
/**
|