@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240517 → 0.0.20240530
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/index.d.ts +1168 -138
- package/package.json +1 -1
- package/readme.md +4 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240530
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -82,6 +82,20 @@ declare namespace gapi.client {
|
|
|
82
82
|
/** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
|
|
83
83
|
functionName?: string;
|
|
84
84
|
}
|
|
85
|
+
interface GoogleCloudDiscoveryengineV1AlloyDbSource {
|
|
86
|
+
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
87
|
+
clusterId?: string;
|
|
88
|
+
/** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
|
|
89
|
+
databaseId?: string;
|
|
90
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
91
|
+
gcsStagingDir?: string;
|
|
92
|
+
/** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
|
|
93
|
+
locationId?: string;
|
|
94
|
+
/** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
95
|
+
projectId?: string;
|
|
96
|
+
/** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
|
|
97
|
+
tableId?: string;
|
|
98
|
+
}
|
|
85
99
|
interface GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
86
100
|
/** Identity provider config. */
|
|
87
101
|
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
@@ -155,6 +169,8 @@ declare namespace gapi.client {
|
|
|
155
169
|
document?: string;
|
|
156
170
|
/** Page identifier. */
|
|
157
171
|
pageIdentifier?: string;
|
|
172
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
173
|
+
structData?: {[P in string]: any};
|
|
158
174
|
/** Title. */
|
|
159
175
|
title?: string;
|
|
160
176
|
/** URI for the document. */
|
|
@@ -165,6 +181,8 @@ declare namespace gapi.client {
|
|
|
165
181
|
chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
166
182
|
/** Document resource name. */
|
|
167
183
|
document?: string;
|
|
184
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
185
|
+
structData?: {[P in string]: any};
|
|
168
186
|
/** Title. */
|
|
169
187
|
title?: string;
|
|
170
188
|
/** URI for the document. */
|
|
@@ -236,6 +254,68 @@ declare namespace gapi.client {
|
|
|
236
254
|
/** TargetSites created. */
|
|
237
255
|
targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
238
256
|
}
|
|
257
|
+
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
258
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
259
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
260
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
261
|
+
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
262
|
+
}
|
|
263
|
+
interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
|
|
264
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
265
|
+
fullMatch?: boolean;
|
|
266
|
+
/** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
|
|
267
|
+
value?: string;
|
|
268
|
+
}
|
|
269
|
+
interface GoogleCloudDiscoveryengineV1alphaConditionTimeRange {
|
|
270
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
271
|
+
endTime?: string;
|
|
272
|
+
/** Start of time range. Range is inclusive. */
|
|
273
|
+
startTime?: string;
|
|
274
|
+
}
|
|
275
|
+
interface GoogleCloudDiscoveryengineV1alphaControl {
|
|
276
|
+
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
277
|
+
associatedServingConfigIds?: string[];
|
|
278
|
+
/** Defines a boost-type control */
|
|
279
|
+
boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
|
|
280
|
+
/** Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
281
|
+
conditions?: GoogleCloudDiscoveryengineV1alphaCondition[];
|
|
282
|
+
/** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
283
|
+
displayName?: string;
|
|
284
|
+
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
285
|
+
filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
|
|
286
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
287
|
+
name?: string;
|
|
288
|
+
/** Defines a redirect-type control. */
|
|
289
|
+
redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
|
|
290
|
+
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
291
|
+
solutionType?: string;
|
|
292
|
+
/** Treats a group of terms as synonyms of one another. */
|
|
293
|
+
synonymsAction?: GoogleCloudDiscoveryengineV1alphaControlSynonymsAction;
|
|
294
|
+
/** Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */
|
|
295
|
+
useCases?: string[];
|
|
296
|
+
}
|
|
297
|
+
interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
|
|
298
|
+
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
299
|
+
boost?: number;
|
|
300
|
+
/** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
|
|
301
|
+
dataStore?: string;
|
|
302
|
+
/** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
303
|
+
filter?: string;
|
|
304
|
+
}
|
|
305
|
+
interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
|
|
306
|
+
/** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
|
|
307
|
+
dataStore?: string;
|
|
308
|
+
/** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
309
|
+
filter?: string;
|
|
310
|
+
}
|
|
311
|
+
interface GoogleCloudDiscoveryengineV1alphaControlRedirectAction {
|
|
312
|
+
/** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
313
|
+
redirectUri?: string;
|
|
314
|
+
}
|
|
315
|
+
interface GoogleCloudDiscoveryengineV1alphaControlSynonymsAction {
|
|
316
|
+
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
317
|
+
synonyms?: string[];
|
|
318
|
+
}
|
|
239
319
|
interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
|
|
240
320
|
/** Operation create time. */
|
|
241
321
|
createTime?: string;
|
|
@@ -267,6 +347,7 @@ declare namespace gapi.client {
|
|
|
267
347
|
displayName?: string;
|
|
268
348
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
269
349
|
modelState?: string;
|
|
350
|
+
/** The version of the model. */
|
|
270
351
|
modelVersion?: string;
|
|
271
352
|
/** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
|
|
272
353
|
name?: string;
|
|
@@ -424,7 +505,7 @@ declare namespace gapi.client {
|
|
|
424
505
|
dialogflowAgent?: string;
|
|
425
506
|
}
|
|
426
507
|
interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
427
|
-
/**
|
|
508
|
+
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
428
509
|
companyName?: string;
|
|
429
510
|
}
|
|
430
511
|
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
@@ -489,6 +570,8 @@ declare namespace gapi.client {
|
|
|
489
570
|
recsFilterableOption?: string;
|
|
490
571
|
/** If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
491
572
|
retrievableOption?: string;
|
|
573
|
+
/** Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished */
|
|
574
|
+
schemaOrgPaths?: string[];
|
|
492
575
|
/** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
493
576
|
searchableOption?: string;
|
|
494
577
|
}
|
|
@@ -825,6 +908,8 @@ declare namespace gapi.client {
|
|
|
825
908
|
searchSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec;
|
|
826
909
|
/** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
|
|
827
910
|
session?: string;
|
|
911
|
+
/** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
|
|
912
|
+
userLabels?: {[P in string]: string};
|
|
828
913
|
/** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
829
914
|
userPseudoId?: string;
|
|
830
915
|
}
|
|
@@ -833,6 +918,8 @@ declare namespace gapi.client {
|
|
|
833
918
|
answerLanguageCode?: string;
|
|
834
919
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */
|
|
835
920
|
ignoreAdversarialQuery?: boolean;
|
|
921
|
+
/** Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */
|
|
922
|
+
ignoreLowRelevantContent?: boolean;
|
|
836
923
|
/** Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. */
|
|
837
924
|
ignoreNonAnswerSeekingQuery?: boolean;
|
|
838
925
|
/** Specifies whether to include citation metadata in the answer. The default value is `false`. */
|
|
@@ -881,6 +968,8 @@ declare namespace gapi.client {
|
|
|
881
968
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams {
|
|
882
969
|
/** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
|
|
883
970
|
boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
|
|
971
|
+
/** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
|
|
972
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[];
|
|
884
973
|
/** 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 Answer 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 customers 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) */
|
|
885
974
|
filter?: string;
|
|
886
975
|
/** Number of search results to return. The default value is 10. */
|
|
@@ -975,6 +1064,8 @@ declare namespace gapi.client {
|
|
|
975
1064
|
document?: string;
|
|
976
1065
|
/** Page identifier. */
|
|
977
1066
|
pageIdentifier?: string;
|
|
1067
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
1068
|
+
structData?: {[P in string]: any};
|
|
978
1069
|
/** Title. */
|
|
979
1070
|
title?: string;
|
|
980
1071
|
/** URI for the document. */
|
|
@@ -985,6 +1076,8 @@ declare namespace gapi.client {
|
|
|
985
1076
|
chunkContents?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
986
1077
|
/** Document resource name. */
|
|
987
1078
|
document?: string;
|
|
1079
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
1080
|
+
structData?: {[P in string]: any};
|
|
988
1081
|
/** Title. */
|
|
989
1082
|
title?: string;
|
|
990
1083
|
/** URI for the document. */
|
|
@@ -1071,6 +1164,68 @@ declare namespace gapi.client {
|
|
|
1071
1164
|
/** TargetSites created. */
|
|
1072
1165
|
targetSites?: GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
1073
1166
|
}
|
|
1167
|
+
interface GoogleCloudDiscoveryengineV1betaCondition {
|
|
1168
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
1169
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
|
|
1170
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
1171
|
+
queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
|
|
1172
|
+
}
|
|
1173
|
+
interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
|
|
1174
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
1175
|
+
fullMatch?: boolean;
|
|
1176
|
+
/** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
|
|
1177
|
+
value?: string;
|
|
1178
|
+
}
|
|
1179
|
+
interface GoogleCloudDiscoveryengineV1betaConditionTimeRange {
|
|
1180
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
1181
|
+
endTime?: string;
|
|
1182
|
+
/** Start of time range. Range is inclusive. */
|
|
1183
|
+
startTime?: string;
|
|
1184
|
+
}
|
|
1185
|
+
interface GoogleCloudDiscoveryengineV1betaControl {
|
|
1186
|
+
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
1187
|
+
associatedServingConfigIds?: string[];
|
|
1188
|
+
/** Defines a boost-type control */
|
|
1189
|
+
boostAction?: GoogleCloudDiscoveryengineV1betaControlBoostAction;
|
|
1190
|
+
/** Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1191
|
+
conditions?: GoogleCloudDiscoveryengineV1betaCondition[];
|
|
1192
|
+
/** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1193
|
+
displayName?: string;
|
|
1194
|
+
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
1195
|
+
filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
|
|
1196
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
1197
|
+
name?: string;
|
|
1198
|
+
/** Defines a redirect-type control. */
|
|
1199
|
+
redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
|
|
1200
|
+
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1201
|
+
solutionType?: string;
|
|
1202
|
+
/** Treats a group of terms as synonyms of one another. */
|
|
1203
|
+
synonymsAction?: GoogleCloudDiscoveryengineV1betaControlSynonymsAction;
|
|
1204
|
+
/** Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */
|
|
1205
|
+
useCases?: string[];
|
|
1206
|
+
}
|
|
1207
|
+
interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
|
|
1208
|
+
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
1209
|
+
boost?: number;
|
|
1210
|
+
/** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
|
|
1211
|
+
dataStore?: string;
|
|
1212
|
+
/** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1213
|
+
filter?: string;
|
|
1214
|
+
}
|
|
1215
|
+
interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
|
|
1216
|
+
/** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
|
|
1217
|
+
dataStore?: string;
|
|
1218
|
+
/** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1219
|
+
filter?: string;
|
|
1220
|
+
}
|
|
1221
|
+
interface GoogleCloudDiscoveryengineV1betaControlRedirectAction {
|
|
1222
|
+
/** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1223
|
+
redirectUri?: string;
|
|
1224
|
+
}
|
|
1225
|
+
interface GoogleCloudDiscoveryengineV1betaControlSynonymsAction {
|
|
1226
|
+
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1227
|
+
synonyms?: string[];
|
|
1228
|
+
}
|
|
1074
1229
|
interface GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
1075
1230
|
/** Operation create time. */
|
|
1076
1231
|
createTime?: string;
|
|
@@ -1102,6 +1257,7 @@ declare namespace gapi.client {
|
|
|
1102
1257
|
displayName?: string;
|
|
1103
1258
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
1104
1259
|
modelState?: string;
|
|
1260
|
+
/** The version of the model. */
|
|
1105
1261
|
modelVersion?: string;
|
|
1106
1262
|
/** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
|
|
1107
1263
|
name?: string;
|
|
@@ -1160,6 +1316,8 @@ declare namespace gapi.client {
|
|
|
1160
1316
|
}
|
|
1161
1317
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
1162
1318
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
1319
|
+
/** Whether chunking mode is enabled. */
|
|
1320
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
|
|
1163
1321
|
/** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
|
|
1164
1322
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1165
1323
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -1169,13 +1327,26 @@ declare namespace gapi.client {
|
|
|
1169
1327
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1170
1328
|
};
|
|
1171
1329
|
}
|
|
1330
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
1331
|
+
/** Configuration for the layout based chunking. */
|
|
1332
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1333
|
+
}
|
|
1334
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1335
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
1336
|
+
chunkSize?: number;
|
|
1337
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
1338
|
+
includeAncestorHeadings?: boolean;
|
|
1339
|
+
}
|
|
1172
1340
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
1173
1341
|
/** Configurations applied to digital parser. */
|
|
1174
1342
|
digitalParsingConfig?: any;
|
|
1343
|
+
/** Configurations applied to layout parser. */
|
|
1344
|
+
layoutParsingConfig?: any;
|
|
1175
1345
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1176
1346
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1177
1347
|
}
|
|
1178
1348
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1349
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
1179
1350
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1180
1351
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1181
1352
|
enhancedDocumentElements?: string[];
|
|
@@ -1234,7 +1405,7 @@ declare namespace gapi.client {
|
|
|
1234
1405
|
dialogflowAgent?: string;
|
|
1235
1406
|
}
|
|
1236
1407
|
interface GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
1237
|
-
/**
|
|
1408
|
+
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
1238
1409
|
companyName?: string;
|
|
1239
1410
|
}
|
|
1240
1411
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
@@ -1303,6 +1474,31 @@ declare namespace gapi.client {
|
|
|
1303
1474
|
/** List of custom tuning models. */
|
|
1304
1475
|
models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
|
|
1305
1476
|
}
|
|
1477
|
+
interface GoogleCloudDiscoveryengineV1betaProject {
|
|
1478
|
+
/** Output only. The timestamp when this project is created. */
|
|
1479
|
+
createTime?: string;
|
|
1480
|
+
/** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
|
|
1481
|
+
name?: string;
|
|
1482
|
+
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
1483
|
+
provisionCompletionTime?: string;
|
|
1484
|
+
/** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
|
|
1485
|
+
serviceTermsMap?: {
|
|
1486
|
+
[P in string]: GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
|
|
1487
|
+
};
|
|
1488
|
+
}
|
|
1489
|
+
interface GoogleCloudDiscoveryengineV1betaProjectServiceTerms {
|
|
1490
|
+
/** The last time when the project agreed to the terms of service. */
|
|
1491
|
+
acceptTime?: string;
|
|
1492
|
+
/** The last time when the project declined or revoked the agreement to terms of service. */
|
|
1493
|
+
declineTime?: string;
|
|
1494
|
+
/** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
|
|
1495
|
+
id?: string;
|
|
1496
|
+
/** Whether the project has accepted/rejected the service terms or it is still pending. */
|
|
1497
|
+
state?: string;
|
|
1498
|
+
/** The version string of the terms of service. For acceptable values, see the comments for id above. */
|
|
1499
|
+
version?: string;
|
|
1500
|
+
}
|
|
1501
|
+
interface GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {}
|
|
1306
1502
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
1307
1503
|
/** Operation create time. */
|
|
1308
1504
|
createTime?: string;
|
|
@@ -1530,6 +1726,68 @@ declare namespace gapi.client {
|
|
|
1530
1726
|
/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
|
|
1531
1727
|
selectedSuggestion?: string;
|
|
1532
1728
|
}
|
|
1729
|
+
interface GoogleCloudDiscoveryengineV1Condition {
|
|
1730
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
1731
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
1732
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
1733
|
+
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
1734
|
+
}
|
|
1735
|
+
interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
|
|
1736
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
1737
|
+
fullMatch?: boolean;
|
|
1738
|
+
/** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
|
|
1739
|
+
value?: string;
|
|
1740
|
+
}
|
|
1741
|
+
interface GoogleCloudDiscoveryengineV1ConditionTimeRange {
|
|
1742
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
1743
|
+
endTime?: string;
|
|
1744
|
+
/** Start of time range. Range is inclusive. */
|
|
1745
|
+
startTime?: string;
|
|
1746
|
+
}
|
|
1747
|
+
interface GoogleCloudDiscoveryengineV1Control {
|
|
1748
|
+
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
1749
|
+
associatedServingConfigIds?: string[];
|
|
1750
|
+
/** Defines a boost-type control */
|
|
1751
|
+
boostAction?: GoogleCloudDiscoveryengineV1ControlBoostAction;
|
|
1752
|
+
/** Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1753
|
+
conditions?: GoogleCloudDiscoveryengineV1Condition[];
|
|
1754
|
+
/** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1755
|
+
displayName?: string;
|
|
1756
|
+
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
1757
|
+
filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
|
|
1758
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
1759
|
+
name?: string;
|
|
1760
|
+
/** Defines a redirect-type control. */
|
|
1761
|
+
redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
|
|
1762
|
+
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1763
|
+
solutionType?: string;
|
|
1764
|
+
/** Treats a group of terms as synonyms of one another. */
|
|
1765
|
+
synonymsAction?: GoogleCloudDiscoveryengineV1ControlSynonymsAction;
|
|
1766
|
+
/** Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */
|
|
1767
|
+
useCases?: string[];
|
|
1768
|
+
}
|
|
1769
|
+
interface GoogleCloudDiscoveryengineV1ControlBoostAction {
|
|
1770
|
+
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
1771
|
+
boost?: number;
|
|
1772
|
+
/** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
|
|
1773
|
+
dataStore?: string;
|
|
1774
|
+
/** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1775
|
+
filter?: string;
|
|
1776
|
+
}
|
|
1777
|
+
interface GoogleCloudDiscoveryengineV1ControlFilterAction {
|
|
1778
|
+
/** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
|
|
1779
|
+
dataStore?: string;
|
|
1780
|
+
/** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1781
|
+
filter?: string;
|
|
1782
|
+
}
|
|
1783
|
+
interface GoogleCloudDiscoveryengineV1ControlRedirectAction {
|
|
1784
|
+
/** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1785
|
+
redirectUri?: string;
|
|
1786
|
+
}
|
|
1787
|
+
interface GoogleCloudDiscoveryengineV1ControlSynonymsAction {
|
|
1788
|
+
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1789
|
+
synonyms?: string[];
|
|
1790
|
+
}
|
|
1533
1791
|
interface GoogleCloudDiscoveryengineV1Conversation {
|
|
1534
1792
|
/** Output only. The time the conversation finished. */
|
|
1535
1793
|
endTime?: string;
|
|
@@ -1713,6 +1971,8 @@ declare namespace gapi.client {
|
|
|
1713
1971
|
uri?: string;
|
|
1714
1972
|
}
|
|
1715
1973
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
1974
|
+
/** Whether chunking mode is enabled. */
|
|
1975
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
|
|
1716
1976
|
/** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
|
|
1717
1977
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
1718
1978
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -1722,13 +1982,26 @@ declare namespace gapi.client {
|
|
|
1722
1982
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
1723
1983
|
};
|
|
1724
1984
|
}
|
|
1985
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
1986
|
+
/** Configuration for the layout based chunking. */
|
|
1987
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1988
|
+
}
|
|
1989
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1990
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
1991
|
+
chunkSize?: number;
|
|
1992
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
1993
|
+
includeAncestorHeadings?: boolean;
|
|
1994
|
+
}
|
|
1725
1995
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
1726
1996
|
/** Configurations applied to digital parser. */
|
|
1727
1997
|
digitalParsingConfig?: any;
|
|
1998
|
+
/** Configurations applied to layout parser. */
|
|
1999
|
+
layoutParsingConfig?: any;
|
|
1728
2000
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1729
2001
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1730
2002
|
}
|
|
1731
2003
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2004
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
1732
2005
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1733
2006
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1734
2007
|
enhancedDocumentElements?: string[];
|
|
@@ -1788,7 +2061,7 @@ declare namespace gapi.client {
|
|
|
1788
2061
|
dialogflowAgent?: string;
|
|
1789
2062
|
}
|
|
1790
2063
|
interface GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
1791
|
-
/**
|
|
2064
|
+
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
1792
2065
|
companyName?: string;
|
|
1793
2066
|
}
|
|
1794
2067
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
@@ -1856,6 +2129,8 @@ declare namespace gapi.client {
|
|
|
1856
2129
|
updateTime?: string;
|
|
1857
2130
|
}
|
|
1858
2131
|
interface GoogleCloudDiscoveryengineV1ImportDocumentsRequest {
|
|
2132
|
+
/** AlloyDB input source. */
|
|
2133
|
+
alloyDbSource?: GoogleCloudDiscoveryengineV1AlloyDbSource;
|
|
1859
2134
|
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
|
|
1860
2135
|
autoGenerateIds?: boolean;
|
|
1861
2136
|
/** BigQuery input source. */
|
|
@@ -1965,6 +2240,12 @@ declare namespace gapi.client {
|
|
|
1965
2240
|
/** Inclusive lower bound. */
|
|
1966
2241
|
minimum?: number;
|
|
1967
2242
|
}
|
|
2243
|
+
interface GoogleCloudDiscoveryengineV1ListControlsResponse {
|
|
2244
|
+
/** All the Controls for a given data store. */
|
|
2245
|
+
controls?: GoogleCloudDiscoveryengineV1Control[];
|
|
2246
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
2247
|
+
nextPageToken?: string;
|
|
2248
|
+
}
|
|
1968
2249
|
interface GoogleCloudDiscoveryengineV1ListConversationsResponse {
|
|
1969
2250
|
/** All the Conversations for a given data store. */
|
|
1970
2251
|
conversations?: GoogleCloudDiscoveryengineV1Conversation[];
|
|
@@ -2035,6 +2316,37 @@ declare namespace gapi.client {
|
|
|
2035
2316
|
/** The total number of panels, including this one, shown to the user. Must be set if panel_position is set. */
|
|
2036
2317
|
totalPanels?: number;
|
|
2037
2318
|
}
|
|
2319
|
+
interface GoogleCloudDiscoveryengineV1Project {
|
|
2320
|
+
/** Output only. The timestamp when this project is created. */
|
|
2321
|
+
createTime?: string;
|
|
2322
|
+
/** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
|
|
2323
|
+
name?: string;
|
|
2324
|
+
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
2325
|
+
provisionCompletionTime?: string;
|
|
2326
|
+
/** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
|
|
2327
|
+
serviceTermsMap?: {
|
|
2328
|
+
[P in string]: GoogleCloudDiscoveryengineV1ProjectServiceTerms;
|
|
2329
|
+
};
|
|
2330
|
+
}
|
|
2331
|
+
interface GoogleCloudDiscoveryengineV1ProjectServiceTerms {
|
|
2332
|
+
/** The last time when the project agreed to the terms of service. */
|
|
2333
|
+
acceptTime?: string;
|
|
2334
|
+
/** The last time when the project declined or revoked the agreement to terms of service. */
|
|
2335
|
+
declineTime?: string;
|
|
2336
|
+
/** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
|
|
2337
|
+
id?: string;
|
|
2338
|
+
/** Whether the project has accepted/rejected the service terms or it is still pending. */
|
|
2339
|
+
state?: string;
|
|
2340
|
+
/** The version string of the terms of service. For acceptable values, see the comments for id above. */
|
|
2341
|
+
version?: string;
|
|
2342
|
+
}
|
|
2343
|
+
interface GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {}
|
|
2344
|
+
interface GoogleCloudDiscoveryengineV1ProvisionProjectRequest {
|
|
2345
|
+
/** Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). */
|
|
2346
|
+
acceptDataUseTerms?: boolean;
|
|
2347
|
+
/** Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */
|
|
2348
|
+
dataUseTermsVersion?: string;
|
|
2349
|
+
}
|
|
2038
2350
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
2039
2351
|
/** Operation create time. */
|
|
2040
2352
|
createTime?: string;
|
|
@@ -2099,6 +2411,8 @@ declare namespace gapi.client {
|
|
|
2099
2411
|
records?: GoogleCloudDiscoveryengineV1RankingRecord[];
|
|
2100
2412
|
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
2101
2413
|
topN?: number;
|
|
2414
|
+
/** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
|
|
2415
|
+
userLabels?: {[P in string]: string};
|
|
2102
2416
|
}
|
|
2103
2417
|
interface GoogleCloudDiscoveryengineV1RankResponse {
|
|
2104
2418
|
/** A list of records sorted by descending score. */
|
|
@@ -2531,10 +2845,14 @@ declare namespace gapi.client {
|
|
|
2531
2845
|
attributionToken?: string;
|
|
2532
2846
|
/** CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
|
|
2533
2847
|
completionInfo?: GoogleCloudDiscoveryengineV1CompletionInfo;
|
|
2848
|
+
/** The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. */
|
|
2849
|
+
dataStore?: string;
|
|
2534
2850
|
/** Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent. */
|
|
2535
2851
|
directUserRequest?: boolean;
|
|
2536
2852
|
/** List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired. */
|
|
2537
2853
|
documents?: GoogleCloudDiscoveryengineV1DocumentInfo[];
|
|
2854
|
+
/** The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. */
|
|
2855
|
+
engine?: string;
|
|
2538
2856
|
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
2539
2857
|
eventTime?: string;
|
|
2540
2858
|
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
|
|
@@ -3124,66 +3442,8 @@ declare namespace gapi.client {
|
|
|
3124
3442
|
documents: DocumentsResource;
|
|
3125
3443
|
operations: OperationsResource;
|
|
3126
3444
|
}
|
|
3127
|
-
interface
|
|
3128
|
-
/**
|
|
3129
|
-
converse(request: {
|
|
3130
|
-
/** V1 error format. */
|
|
3131
|
-
'$.xgafv'?: string;
|
|
3132
|
-
/** OAuth access token. */
|
|
3133
|
-
access_token?: string;
|
|
3134
|
-
/** Data format for response. */
|
|
3135
|
-
alt?: string;
|
|
3136
|
-
/** JSONP */
|
|
3137
|
-
callback?: string;
|
|
3138
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3139
|
-
fields?: string;
|
|
3140
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3141
|
-
key?: string;
|
|
3142
|
-
/** 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. */
|
|
3143
|
-
name: string;
|
|
3144
|
-
/** OAuth 2.0 token for the current user. */
|
|
3145
|
-
oauth_token?: string;
|
|
3146
|
-
/** Returns response with indentations and line breaks. */
|
|
3147
|
-
prettyPrint?: boolean;
|
|
3148
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3149
|
-
quotaUser?: string;
|
|
3150
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3151
|
-
upload_protocol?: string;
|
|
3152
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3153
|
-
uploadType?: string;
|
|
3154
|
-
/** Request body */
|
|
3155
|
-
resource: GoogleCloudDiscoveryengineV1ConverseConversationRequest;
|
|
3156
|
-
}): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
|
|
3157
|
-
converse(
|
|
3158
|
-
request: {
|
|
3159
|
-
/** V1 error format. */
|
|
3160
|
-
'$.xgafv'?: string;
|
|
3161
|
-
/** OAuth access token. */
|
|
3162
|
-
access_token?: string;
|
|
3163
|
-
/** Data format for response. */
|
|
3164
|
-
alt?: string;
|
|
3165
|
-
/** JSONP */
|
|
3166
|
-
callback?: string;
|
|
3167
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3168
|
-
fields?: string;
|
|
3169
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3170
|
-
key?: string;
|
|
3171
|
-
/** 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. */
|
|
3172
|
-
name: string;
|
|
3173
|
-
/** OAuth 2.0 token for the current user. */
|
|
3174
|
-
oauth_token?: string;
|
|
3175
|
-
/** Returns response with indentations and line breaks. */
|
|
3176
|
-
prettyPrint?: boolean;
|
|
3177
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3178
|
-
quotaUser?: string;
|
|
3179
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3180
|
-
upload_protocol?: string;
|
|
3181
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3182
|
-
uploadType?: string;
|
|
3183
|
-
},
|
|
3184
|
-
body: GoogleCloudDiscoveryengineV1ConverseConversationRequest
|
|
3185
|
-
): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
|
|
3186
|
-
/** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
|
|
3445
|
+
interface ControlsResource {
|
|
3446
|
+
/** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
|
|
3187
3447
|
create(request: {
|
|
3188
3448
|
/** V1 error format. */
|
|
3189
3449
|
'$.xgafv'?: string;
|
|
@@ -3193,13 +3453,15 @@ declare namespace gapi.client {
|
|
|
3193
3453
|
alt?: string;
|
|
3194
3454
|
/** JSONP */
|
|
3195
3455
|
callback?: string;
|
|
3456
|
+
/** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
|
|
3457
|
+
controlId?: string;
|
|
3196
3458
|
/** Selector specifying which fields to include in a partial response. */
|
|
3197
3459
|
fields?: string;
|
|
3198
3460
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3199
3461
|
key?: string;
|
|
3200
3462
|
/** OAuth 2.0 token for the current user. */
|
|
3201
3463
|
oauth_token?: string;
|
|
3202
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
3464
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3203
3465
|
parent: string;
|
|
3204
3466
|
/** Returns response with indentations and line breaks. */
|
|
3205
3467
|
prettyPrint?: boolean;
|
|
@@ -3210,8 +3472,8 @@ declare namespace gapi.client {
|
|
|
3210
3472
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3211
3473
|
uploadType?: string;
|
|
3212
3474
|
/** Request body */
|
|
3213
|
-
resource:
|
|
3214
|
-
}): Request<
|
|
3475
|
+
resource: GoogleCloudDiscoveryengineV1Control;
|
|
3476
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
3215
3477
|
create(
|
|
3216
3478
|
request: {
|
|
3217
3479
|
/** V1 error format. */
|
|
@@ -3222,13 +3484,15 @@ declare namespace gapi.client {
|
|
|
3222
3484
|
alt?: string;
|
|
3223
3485
|
/** JSONP */
|
|
3224
3486
|
callback?: string;
|
|
3487
|
+
/** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
|
|
3488
|
+
controlId?: string;
|
|
3225
3489
|
/** Selector specifying which fields to include in a partial response. */
|
|
3226
3490
|
fields?: string;
|
|
3227
3491
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3228
3492
|
key?: string;
|
|
3229
3493
|
/** OAuth 2.0 token for the current user. */
|
|
3230
3494
|
oauth_token?: string;
|
|
3231
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
3495
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3232
3496
|
parent: string;
|
|
3233
3497
|
/** Returns response with indentations and line breaks. */
|
|
3234
3498
|
prettyPrint?: boolean;
|
|
@@ -3239,9 +3503,9 @@ declare namespace gapi.client {
|
|
|
3239
3503
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3240
3504
|
uploadType?: string;
|
|
3241
3505
|
},
|
|
3242
|
-
body:
|
|
3243
|
-
): Request<
|
|
3244
|
-
/** Deletes a
|
|
3506
|
+
body: GoogleCloudDiscoveryengineV1Control
|
|
3507
|
+
): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
3508
|
+
/** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
|
|
3245
3509
|
delete(request?: {
|
|
3246
3510
|
/** V1 error format. */
|
|
3247
3511
|
'$.xgafv'?: string;
|
|
@@ -3255,7 +3519,7 @@ declare namespace gapi.client {
|
|
|
3255
3519
|
fields?: string;
|
|
3256
3520
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3257
3521
|
key?: string;
|
|
3258
|
-
/** Required. The resource name of the
|
|
3522
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
3259
3523
|
name: string;
|
|
3260
3524
|
/** OAuth 2.0 token for the current user. */
|
|
3261
3525
|
oauth_token?: string;
|
|
@@ -3268,7 +3532,7 @@ declare namespace gapi.client {
|
|
|
3268
3532
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3269
3533
|
uploadType?: string;
|
|
3270
3534
|
}): Request<{}>;
|
|
3271
|
-
/** Gets a
|
|
3535
|
+
/** Gets a Control. */
|
|
3272
3536
|
get(request?: {
|
|
3273
3537
|
/** V1 error format. */
|
|
3274
3538
|
'$.xgafv'?: string;
|
|
@@ -3282,7 +3546,7 @@ declare namespace gapi.client {
|
|
|
3282
3546
|
fields?: string;
|
|
3283
3547
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3284
3548
|
key?: string;
|
|
3285
|
-
/** Required. The resource name of the
|
|
3549
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
3286
3550
|
name: string;
|
|
3287
3551
|
/** OAuth 2.0 token for the current user. */
|
|
3288
3552
|
oauth_token?: string;
|
|
@@ -3294,8 +3558,8 @@ declare namespace gapi.client {
|
|
|
3294
3558
|
upload_protocol?: string;
|
|
3295
3559
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3296
3560
|
uploadType?: string;
|
|
3297
|
-
}): Request<
|
|
3298
|
-
/** Lists all
|
|
3561
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
3562
|
+
/** Lists all Controls by their parent DataStore. */
|
|
3299
3563
|
list(request?: {
|
|
3300
3564
|
/** V1 error format. */
|
|
3301
3565
|
'$.xgafv'?: string;
|
|
@@ -3307,19 +3571,17 @@ declare namespace gapi.client {
|
|
|
3307
3571
|
callback?: string;
|
|
3308
3572
|
/** Selector specifying which fields to include in a partial response. */
|
|
3309
3573
|
fields?: string;
|
|
3310
|
-
/** A filter to apply on the list results.
|
|
3574
|
+
/** Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */
|
|
3311
3575
|
filter?: string;
|
|
3312
3576
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3313
3577
|
key?: string;
|
|
3314
3578
|
/** OAuth 2.0 token for the current user. */
|
|
3315
3579
|
oauth_token?: string;
|
|
3316
|
-
/**
|
|
3317
|
-
orderBy?: string;
|
|
3318
|
-
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3580
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3319
3581
|
pageSize?: number;
|
|
3320
|
-
/** A page token, received from a previous `
|
|
3582
|
+
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
3321
3583
|
pageToken?: string;
|
|
3322
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
3584
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3323
3585
|
parent: string;
|
|
3324
3586
|
/** Returns response with indentations and line breaks. */
|
|
3325
3587
|
prettyPrint?: boolean;
|
|
@@ -3329,8 +3591,8 @@ declare namespace gapi.client {
|
|
|
3329
3591
|
upload_protocol?: string;
|
|
3330
3592
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3331
3593
|
uploadType?: string;
|
|
3332
|
-
}): Request<
|
|
3333
|
-
/** Updates a
|
|
3594
|
+
}): Request<GoogleCloudDiscoveryengineV1ListControlsResponse>;
|
|
3595
|
+
/** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
|
|
3334
3596
|
patch(request: {
|
|
3335
3597
|
/** V1 error format. */
|
|
3336
3598
|
'$.xgafv'?: string;
|
|
@@ -3344,7 +3606,7 @@ declare namespace gapi.client {
|
|
|
3344
3606
|
fields?: string;
|
|
3345
3607
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3346
3608
|
key?: string;
|
|
3347
|
-
/** Immutable. Fully qualified name `projects
|
|
3609
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
3348
3610
|
name: string;
|
|
3349
3611
|
/** OAuth 2.0 token for the current user. */
|
|
3350
3612
|
oauth_token?: string;
|
|
@@ -3352,15 +3614,15 @@ declare namespace gapi.client {
|
|
|
3352
3614
|
prettyPrint?: boolean;
|
|
3353
3615
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3354
3616
|
quotaUser?: string;
|
|
3355
|
-
/** Indicates which fields in the provided
|
|
3617
|
+
/** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
|
|
3356
3618
|
updateMask?: string;
|
|
3357
3619
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3358
3620
|
upload_protocol?: string;
|
|
3359
3621
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3360
3622
|
uploadType?: string;
|
|
3361
3623
|
/** Request body */
|
|
3362
|
-
resource:
|
|
3363
|
-
}): Request<
|
|
3624
|
+
resource: GoogleCloudDiscoveryengineV1Control;
|
|
3625
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
3364
3626
|
patch(
|
|
3365
3627
|
request: {
|
|
3366
3628
|
/** V1 error format. */
|
|
@@ -3375,7 +3637,7 @@ declare namespace gapi.client {
|
|
|
3375
3637
|
fields?: string;
|
|
3376
3638
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3377
3639
|
key?: string;
|
|
3378
|
-
/** Immutable. Fully qualified name `projects
|
|
3640
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
3379
3641
|
name: string;
|
|
3380
3642
|
/** OAuth 2.0 token for the current user. */
|
|
3381
3643
|
oauth_token?: string;
|
|
@@ -3383,19 +3645,19 @@ declare namespace gapi.client {
|
|
|
3383
3645
|
prettyPrint?: boolean;
|
|
3384
3646
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3385
3647
|
quotaUser?: string;
|
|
3386
|
-
/** Indicates which fields in the provided
|
|
3648
|
+
/** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
|
|
3387
3649
|
updateMask?: string;
|
|
3388
3650
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3389
3651
|
upload_protocol?: string;
|
|
3390
3652
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3391
3653
|
uploadType?: string;
|
|
3392
3654
|
},
|
|
3393
|
-
body:
|
|
3394
|
-
): Request<
|
|
3655
|
+
body: GoogleCloudDiscoveryengineV1Control
|
|
3656
|
+
): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
3395
3657
|
}
|
|
3396
|
-
interface
|
|
3397
|
-
/**
|
|
3398
|
-
|
|
3658
|
+
interface ConversationsResource {
|
|
3659
|
+
/** Converses a conversation. */
|
|
3660
|
+
converse(request: {
|
|
3399
3661
|
/** V1 error format. */
|
|
3400
3662
|
'$.xgafv'?: string;
|
|
3401
3663
|
/** OAuth access token. */
|
|
@@ -3408,7 +3670,7 @@ declare namespace gapi.client {
|
|
|
3408
3670
|
fields?: string;
|
|
3409
3671
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3410
3672
|
key?: string;
|
|
3411
|
-
/** The name of the
|
|
3673
|
+
/** 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. */
|
|
3412
3674
|
name: string;
|
|
3413
3675
|
/** OAuth 2.0 token for the current user. */
|
|
3414
3676
|
oauth_token?: string;
|
|
@@ -3420,23 +3682,292 @@ declare namespace gapi.client {
|
|
|
3420
3682
|
upload_protocol?: string;
|
|
3421
3683
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3422
3684
|
uploadType?: string;
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
|
|
3426
|
-
|
|
3427
|
-
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3685
|
+
/** Request body */
|
|
3686
|
+
resource: GoogleCloudDiscoveryengineV1ConverseConversationRequest;
|
|
3687
|
+
}): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
|
|
3688
|
+
converse(
|
|
3689
|
+
request: {
|
|
3690
|
+
/** V1 error format. */
|
|
3691
|
+
'$.xgafv'?: string;
|
|
3692
|
+
/** OAuth access token. */
|
|
3693
|
+
access_token?: string;
|
|
3694
|
+
/** Data format for response. */
|
|
3695
|
+
alt?: string;
|
|
3696
|
+
/** JSONP */
|
|
3697
|
+
callback?: string;
|
|
3698
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3699
|
+
fields?: string;
|
|
3700
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3701
|
+
key?: string;
|
|
3702
|
+
/** 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. */
|
|
3703
|
+
name: string;
|
|
3704
|
+
/** OAuth 2.0 token for the current user. */
|
|
3705
|
+
oauth_token?: string;
|
|
3706
|
+
/** Returns response with indentations and line breaks. */
|
|
3707
|
+
prettyPrint?: boolean;
|
|
3708
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3709
|
+
quotaUser?: string;
|
|
3710
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3711
|
+
upload_protocol?: string;
|
|
3712
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3713
|
+
uploadType?: string;
|
|
3714
|
+
},
|
|
3715
|
+
body: GoogleCloudDiscoveryengineV1ConverseConversationRequest
|
|
3716
|
+
): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
|
|
3717
|
+
/** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
|
|
3718
|
+
create(request: {
|
|
3719
|
+
/** V1 error format. */
|
|
3720
|
+
'$.xgafv'?: string;
|
|
3721
|
+
/** OAuth access token. */
|
|
3722
|
+
access_token?: string;
|
|
3723
|
+
/** Data format for response. */
|
|
3724
|
+
alt?: string;
|
|
3725
|
+
/** JSONP */
|
|
3726
|
+
callback?: string;
|
|
3727
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3728
|
+
fields?: string;
|
|
3729
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3730
|
+
key?: string;
|
|
3731
|
+
/** OAuth 2.0 token for the current user. */
|
|
3732
|
+
oauth_token?: string;
|
|
3733
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
3734
|
+
parent: string;
|
|
3735
|
+
/** Returns response with indentations and line breaks. */
|
|
3736
|
+
prettyPrint?: boolean;
|
|
3737
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3738
|
+
quotaUser?: string;
|
|
3739
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3740
|
+
upload_protocol?: string;
|
|
3741
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3742
|
+
uploadType?: string;
|
|
3743
|
+
/** Request body */
|
|
3744
|
+
resource: GoogleCloudDiscoveryengineV1Conversation;
|
|
3745
|
+
}): Request<GoogleCloudDiscoveryengineV1Conversation>;
|
|
3746
|
+
create(
|
|
3747
|
+
request: {
|
|
3748
|
+
/** V1 error format. */
|
|
3749
|
+
'$.xgafv'?: string;
|
|
3750
|
+
/** OAuth access token. */
|
|
3751
|
+
access_token?: string;
|
|
3752
|
+
/** Data format for response. */
|
|
3753
|
+
alt?: string;
|
|
3754
|
+
/** JSONP */
|
|
3755
|
+
callback?: string;
|
|
3756
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3757
|
+
fields?: string;
|
|
3758
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3759
|
+
key?: string;
|
|
3760
|
+
/** OAuth 2.0 token for the current user. */
|
|
3761
|
+
oauth_token?: string;
|
|
3762
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
3763
|
+
parent: string;
|
|
3764
|
+
/** Returns response with indentations and line breaks. */
|
|
3765
|
+
prettyPrint?: boolean;
|
|
3766
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3767
|
+
quotaUser?: string;
|
|
3768
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3769
|
+
upload_protocol?: string;
|
|
3770
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3771
|
+
uploadType?: string;
|
|
3772
|
+
},
|
|
3773
|
+
body: GoogleCloudDiscoveryengineV1Conversation
|
|
3774
|
+
): Request<GoogleCloudDiscoveryengineV1Conversation>;
|
|
3775
|
+
/** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
|
|
3776
|
+
delete(request?: {
|
|
3777
|
+
/** V1 error format. */
|
|
3778
|
+
'$.xgafv'?: string;
|
|
3779
|
+
/** OAuth access token. */
|
|
3780
|
+
access_token?: string;
|
|
3781
|
+
/** Data format for response. */
|
|
3782
|
+
alt?: string;
|
|
3783
|
+
/** JSONP */
|
|
3784
|
+
callback?: string;
|
|
3785
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3786
|
+
fields?: string;
|
|
3787
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3788
|
+
key?: string;
|
|
3789
|
+
/** 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}` */
|
|
3790
|
+
name: string;
|
|
3791
|
+
/** OAuth 2.0 token for the current user. */
|
|
3792
|
+
oauth_token?: string;
|
|
3793
|
+
/** Returns response with indentations and line breaks. */
|
|
3794
|
+
prettyPrint?: boolean;
|
|
3795
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3796
|
+
quotaUser?: string;
|
|
3797
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3798
|
+
upload_protocol?: string;
|
|
3799
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3800
|
+
uploadType?: string;
|
|
3801
|
+
}): Request<{}>;
|
|
3802
|
+
/** Gets a Conversation. */
|
|
3803
|
+
get(request?: {
|
|
3804
|
+
/** V1 error format. */
|
|
3805
|
+
'$.xgafv'?: string;
|
|
3806
|
+
/** OAuth access token. */
|
|
3807
|
+
access_token?: string;
|
|
3808
|
+
/** Data format for response. */
|
|
3809
|
+
alt?: string;
|
|
3810
|
+
/** JSONP */
|
|
3811
|
+
callback?: string;
|
|
3812
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3813
|
+
fields?: string;
|
|
3814
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3815
|
+
key?: string;
|
|
3816
|
+
/** 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}` */
|
|
3817
|
+
name: string;
|
|
3818
|
+
/** OAuth 2.0 token for the current user. */
|
|
3819
|
+
oauth_token?: string;
|
|
3820
|
+
/** Returns response with indentations and line breaks. */
|
|
3821
|
+
prettyPrint?: boolean;
|
|
3822
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3823
|
+
quotaUser?: string;
|
|
3824
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3825
|
+
upload_protocol?: string;
|
|
3826
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3827
|
+
uploadType?: string;
|
|
3828
|
+
}): Request<GoogleCloudDiscoveryengineV1Conversation>;
|
|
3829
|
+
/** Lists all Conversations by their parent DataStore. */
|
|
3830
|
+
list(request?: {
|
|
3831
|
+
/** V1 error format. */
|
|
3832
|
+
'$.xgafv'?: string;
|
|
3833
|
+
/** OAuth access token. */
|
|
3834
|
+
access_token?: string;
|
|
3835
|
+
/** Data format for response. */
|
|
3836
|
+
alt?: string;
|
|
3837
|
+
/** JSONP */
|
|
3838
|
+
callback?: string;
|
|
3839
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3840
|
+
fields?: string;
|
|
3841
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
3842
|
+
filter?: string;
|
|
3843
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3844
|
+
key?: string;
|
|
3845
|
+
/** OAuth 2.0 token for the current user. */
|
|
3846
|
+
oauth_token?: string;
|
|
3847
|
+
/** 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" */
|
|
3848
|
+
orderBy?: string;
|
|
3849
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3850
|
+
pageSize?: number;
|
|
3851
|
+
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
3852
|
+
pageToken?: string;
|
|
3853
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
3854
|
+
parent: string;
|
|
3855
|
+
/** Returns response with indentations and line breaks. */
|
|
3856
|
+
prettyPrint?: boolean;
|
|
3857
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3858
|
+
quotaUser?: string;
|
|
3859
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3860
|
+
upload_protocol?: string;
|
|
3861
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3862
|
+
uploadType?: string;
|
|
3863
|
+
}): Request<GoogleCloudDiscoveryengineV1ListConversationsResponse>;
|
|
3864
|
+
/** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
|
|
3865
|
+
patch(request: {
|
|
3866
|
+
/** V1 error format. */
|
|
3867
|
+
'$.xgafv'?: string;
|
|
3868
|
+
/** OAuth access token. */
|
|
3869
|
+
access_token?: string;
|
|
3870
|
+
/** Data format for response. */
|
|
3871
|
+
alt?: string;
|
|
3872
|
+
/** JSONP */
|
|
3873
|
+
callback?: string;
|
|
3874
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3875
|
+
fields?: string;
|
|
3876
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3877
|
+
key?: string;
|
|
3878
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
3879
|
+
name: string;
|
|
3880
|
+
/** OAuth 2.0 token for the current user. */
|
|
3881
|
+
oauth_token?: string;
|
|
3882
|
+
/** Returns response with indentations and line breaks. */
|
|
3883
|
+
prettyPrint?: boolean;
|
|
3884
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3885
|
+
quotaUser?: string;
|
|
3886
|
+
/** 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. */
|
|
3887
|
+
updateMask?: string;
|
|
3888
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3889
|
+
upload_protocol?: string;
|
|
3890
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3891
|
+
uploadType?: string;
|
|
3892
|
+
/** Request body */
|
|
3893
|
+
resource: GoogleCloudDiscoveryengineV1Conversation;
|
|
3894
|
+
}): Request<GoogleCloudDiscoveryengineV1Conversation>;
|
|
3895
|
+
patch(
|
|
3896
|
+
request: {
|
|
3897
|
+
/** V1 error format. */
|
|
3898
|
+
'$.xgafv'?: string;
|
|
3899
|
+
/** OAuth access token. */
|
|
3900
|
+
access_token?: string;
|
|
3901
|
+
/** Data format for response. */
|
|
3902
|
+
alt?: string;
|
|
3903
|
+
/** JSONP */
|
|
3904
|
+
callback?: string;
|
|
3905
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3906
|
+
fields?: string;
|
|
3907
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3908
|
+
key?: string;
|
|
3909
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
3910
|
+
name: string;
|
|
3911
|
+
/** OAuth 2.0 token for the current user. */
|
|
3912
|
+
oauth_token?: string;
|
|
3913
|
+
/** Returns response with indentations and line breaks. */
|
|
3914
|
+
prettyPrint?: boolean;
|
|
3915
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3916
|
+
quotaUser?: string;
|
|
3917
|
+
/** 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. */
|
|
3918
|
+
updateMask?: string;
|
|
3919
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3920
|
+
upload_protocol?: string;
|
|
3921
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3922
|
+
uploadType?: string;
|
|
3923
|
+
},
|
|
3924
|
+
body: GoogleCloudDiscoveryengineV1Conversation
|
|
3925
|
+
): Request<GoogleCloudDiscoveryengineV1Conversation>;
|
|
3926
|
+
}
|
|
3927
|
+
interface OperationsResource {
|
|
3928
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
3929
|
+
get(request?: {
|
|
3930
|
+
/** V1 error format. */
|
|
3931
|
+
'$.xgafv'?: string;
|
|
3932
|
+
/** OAuth access token. */
|
|
3933
|
+
access_token?: string;
|
|
3934
|
+
/** Data format for response. */
|
|
3935
|
+
alt?: string;
|
|
3936
|
+
/** JSONP */
|
|
3937
|
+
callback?: string;
|
|
3938
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3939
|
+
fields?: string;
|
|
3940
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3941
|
+
key?: string;
|
|
3942
|
+
/** The name of the operation resource. */
|
|
3943
|
+
name: string;
|
|
3944
|
+
/** OAuth 2.0 token for the current user. */
|
|
3945
|
+
oauth_token?: string;
|
|
3946
|
+
/** Returns response with indentations and line breaks. */
|
|
3947
|
+
prettyPrint?: boolean;
|
|
3948
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3949
|
+
quotaUser?: string;
|
|
3950
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3951
|
+
upload_protocol?: string;
|
|
3952
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3953
|
+
uploadType?: string;
|
|
3954
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3955
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
3956
|
+
list(request?: {
|
|
3957
|
+
/** V1 error format. */
|
|
3958
|
+
'$.xgafv'?: string;
|
|
3959
|
+
/** OAuth access token. */
|
|
3960
|
+
access_token?: string;
|
|
3961
|
+
/** Data format for response. */
|
|
3962
|
+
alt?: string;
|
|
3963
|
+
/** JSONP */
|
|
3964
|
+
callback?: string;
|
|
3965
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3966
|
+
fields?: string;
|
|
3967
|
+
/** The standard list filter. */
|
|
3968
|
+
filter?: string;
|
|
3969
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3970
|
+
key?: string;
|
|
3440
3971
|
/** The name of the operation's parent resource. */
|
|
3441
3972
|
name: string;
|
|
3442
3973
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -5100,6 +5631,8 @@ declare namespace gapi.client {
|
|
|
5100
5631
|
upload_protocol?: string;
|
|
5101
5632
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5102
5633
|
uploadType?: string;
|
|
5634
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
5635
|
+
writeAsync?: boolean;
|
|
5103
5636
|
/** Request body */
|
|
5104
5637
|
resource: GoogleCloudDiscoveryengineV1UserEvent;
|
|
5105
5638
|
}): Request<GoogleCloudDiscoveryengineV1UserEvent>;
|
|
@@ -5129,6 +5662,8 @@ declare namespace gapi.client {
|
|
|
5129
5662
|
upload_protocol?: string;
|
|
5130
5663
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5131
5664
|
uploadType?: string;
|
|
5665
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
5666
|
+
writeAsync?: boolean;
|
|
5132
5667
|
},
|
|
5133
5668
|
body: GoogleCloudDiscoveryengineV1UserEvent
|
|
5134
5669
|
): Request<GoogleCloudDiscoveryengineV1UserEvent>;
|
|
@@ -5328,17 +5863,241 @@ declare namespace gapi.client {
|
|
|
5328
5863
|
callback?: string;
|
|
5329
5864
|
/** Selector specifying which fields to include in a partial response. */
|
|
5330
5865
|
fields?: string;
|
|
5331
|
-
/** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
5866
|
+
/** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
|
|
5867
|
+
filter?: string;
|
|
5868
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5869
|
+
key?: string;
|
|
5870
|
+
/** OAuth 2.0 token for the current user. */
|
|
5871
|
+
oauth_token?: string;
|
|
5872
|
+
/** Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. */
|
|
5873
|
+
pageSize?: number;
|
|
5874
|
+
/** A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
5875
|
+
pageToken?: string;
|
|
5876
|
+
/** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */
|
|
5877
|
+
parent: string;
|
|
5878
|
+
/** Returns response with indentations and line breaks. */
|
|
5879
|
+
prettyPrint?: boolean;
|
|
5880
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5881
|
+
quotaUser?: string;
|
|
5882
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5883
|
+
upload_protocol?: string;
|
|
5884
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5885
|
+
uploadType?: string;
|
|
5886
|
+
}): Request<GoogleCloudDiscoveryengineV1ListDataStoresResponse>;
|
|
5887
|
+
/** Updates a DataStore */
|
|
5888
|
+
patch(request: {
|
|
5889
|
+
/** V1 error format. */
|
|
5890
|
+
'$.xgafv'?: string;
|
|
5891
|
+
/** OAuth access token. */
|
|
5892
|
+
access_token?: string;
|
|
5893
|
+
/** Data format for response. */
|
|
5894
|
+
alt?: string;
|
|
5895
|
+
/** JSONP */
|
|
5896
|
+
callback?: string;
|
|
5897
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5898
|
+
fields?: string;
|
|
5899
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5900
|
+
key?: string;
|
|
5901
|
+
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
5902
|
+
name: string;
|
|
5903
|
+
/** OAuth 2.0 token for the current user. */
|
|
5904
|
+
oauth_token?: string;
|
|
5905
|
+
/** Returns response with indentations and line breaks. */
|
|
5906
|
+
prettyPrint?: boolean;
|
|
5907
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5908
|
+
quotaUser?: string;
|
|
5909
|
+
/** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
|
|
5910
|
+
updateMask?: string;
|
|
5911
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5912
|
+
upload_protocol?: string;
|
|
5913
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5914
|
+
uploadType?: string;
|
|
5915
|
+
/** Request body */
|
|
5916
|
+
resource: GoogleCloudDiscoveryengineV1DataStore;
|
|
5917
|
+
}): Request<GoogleCloudDiscoveryengineV1DataStore>;
|
|
5918
|
+
patch(
|
|
5919
|
+
request: {
|
|
5920
|
+
/** V1 error format. */
|
|
5921
|
+
'$.xgafv'?: string;
|
|
5922
|
+
/** OAuth access token. */
|
|
5923
|
+
access_token?: string;
|
|
5924
|
+
/** Data format for response. */
|
|
5925
|
+
alt?: string;
|
|
5926
|
+
/** JSONP */
|
|
5927
|
+
callback?: string;
|
|
5928
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5929
|
+
fields?: string;
|
|
5930
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5931
|
+
key?: string;
|
|
5932
|
+
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
5933
|
+
name: string;
|
|
5934
|
+
/** OAuth 2.0 token for the current user. */
|
|
5935
|
+
oauth_token?: string;
|
|
5936
|
+
/** Returns response with indentations and line breaks. */
|
|
5937
|
+
prettyPrint?: boolean;
|
|
5938
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5939
|
+
quotaUser?: string;
|
|
5940
|
+
/** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
|
|
5941
|
+
updateMask?: string;
|
|
5942
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5943
|
+
upload_protocol?: string;
|
|
5944
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5945
|
+
uploadType?: string;
|
|
5946
|
+
},
|
|
5947
|
+
body: GoogleCloudDiscoveryengineV1DataStore
|
|
5948
|
+
): Request<GoogleCloudDiscoveryengineV1DataStore>;
|
|
5949
|
+
branches: BranchesResource;
|
|
5950
|
+
controls: ControlsResource;
|
|
5951
|
+
conversations: ConversationsResource;
|
|
5952
|
+
models: ModelsResource;
|
|
5953
|
+
operations: OperationsResource;
|
|
5954
|
+
schemas: SchemasResource;
|
|
5955
|
+
servingConfigs: ServingConfigsResource;
|
|
5956
|
+
sessions: SessionsResource;
|
|
5957
|
+
siteSearchEngine: SiteSearchEngineResource;
|
|
5958
|
+
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
5959
|
+
userEvents: UserEventsResource;
|
|
5960
|
+
}
|
|
5961
|
+
interface ControlsResource {
|
|
5962
|
+
/** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
|
|
5963
|
+
create(request: {
|
|
5964
|
+
/** V1 error format. */
|
|
5965
|
+
'$.xgafv'?: string;
|
|
5966
|
+
/** OAuth access token. */
|
|
5967
|
+
access_token?: string;
|
|
5968
|
+
/** Data format for response. */
|
|
5969
|
+
alt?: string;
|
|
5970
|
+
/** JSONP */
|
|
5971
|
+
callback?: string;
|
|
5972
|
+
/** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
|
|
5973
|
+
controlId?: string;
|
|
5974
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5975
|
+
fields?: string;
|
|
5976
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5977
|
+
key?: string;
|
|
5978
|
+
/** OAuth 2.0 token for the current user. */
|
|
5979
|
+
oauth_token?: string;
|
|
5980
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
5981
|
+
parent: string;
|
|
5982
|
+
/** Returns response with indentations and line breaks. */
|
|
5983
|
+
prettyPrint?: boolean;
|
|
5984
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5985
|
+
quotaUser?: string;
|
|
5986
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5987
|
+
upload_protocol?: string;
|
|
5988
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5989
|
+
uploadType?: string;
|
|
5990
|
+
/** Request body */
|
|
5991
|
+
resource: GoogleCloudDiscoveryengineV1Control;
|
|
5992
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
5993
|
+
create(
|
|
5994
|
+
request: {
|
|
5995
|
+
/** V1 error format. */
|
|
5996
|
+
'$.xgafv'?: string;
|
|
5997
|
+
/** OAuth access token. */
|
|
5998
|
+
access_token?: string;
|
|
5999
|
+
/** Data format for response. */
|
|
6000
|
+
alt?: string;
|
|
6001
|
+
/** JSONP */
|
|
6002
|
+
callback?: string;
|
|
6003
|
+
/** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
|
|
6004
|
+
controlId?: string;
|
|
6005
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6006
|
+
fields?: string;
|
|
6007
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6008
|
+
key?: string;
|
|
6009
|
+
/** OAuth 2.0 token for the current user. */
|
|
6010
|
+
oauth_token?: string;
|
|
6011
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6012
|
+
parent: string;
|
|
6013
|
+
/** Returns response with indentations and line breaks. */
|
|
6014
|
+
prettyPrint?: boolean;
|
|
6015
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6016
|
+
quotaUser?: string;
|
|
6017
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6018
|
+
upload_protocol?: string;
|
|
6019
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6020
|
+
uploadType?: string;
|
|
6021
|
+
},
|
|
6022
|
+
body: GoogleCloudDiscoveryengineV1Control
|
|
6023
|
+
): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
6024
|
+
/** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
|
|
6025
|
+
delete(request?: {
|
|
6026
|
+
/** V1 error format. */
|
|
6027
|
+
'$.xgafv'?: string;
|
|
6028
|
+
/** OAuth access token. */
|
|
6029
|
+
access_token?: string;
|
|
6030
|
+
/** Data format for response. */
|
|
6031
|
+
alt?: string;
|
|
6032
|
+
/** JSONP */
|
|
6033
|
+
callback?: string;
|
|
6034
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6035
|
+
fields?: string;
|
|
6036
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6037
|
+
key?: string;
|
|
6038
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
6039
|
+
name: string;
|
|
6040
|
+
/** OAuth 2.0 token for the current user. */
|
|
6041
|
+
oauth_token?: string;
|
|
6042
|
+
/** Returns response with indentations and line breaks. */
|
|
6043
|
+
prettyPrint?: boolean;
|
|
6044
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6045
|
+
quotaUser?: string;
|
|
6046
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6047
|
+
upload_protocol?: string;
|
|
6048
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6049
|
+
uploadType?: string;
|
|
6050
|
+
}): Request<{}>;
|
|
6051
|
+
/** Gets a Control. */
|
|
6052
|
+
get(request?: {
|
|
6053
|
+
/** V1 error format. */
|
|
6054
|
+
'$.xgafv'?: string;
|
|
6055
|
+
/** OAuth access token. */
|
|
6056
|
+
access_token?: string;
|
|
6057
|
+
/** Data format for response. */
|
|
6058
|
+
alt?: string;
|
|
6059
|
+
/** JSONP */
|
|
6060
|
+
callback?: string;
|
|
6061
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6062
|
+
fields?: string;
|
|
6063
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6064
|
+
key?: string;
|
|
6065
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
6066
|
+
name: string;
|
|
6067
|
+
/** OAuth 2.0 token for the current user. */
|
|
6068
|
+
oauth_token?: string;
|
|
6069
|
+
/** Returns response with indentations and line breaks. */
|
|
6070
|
+
prettyPrint?: boolean;
|
|
6071
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6072
|
+
quotaUser?: string;
|
|
6073
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6074
|
+
upload_protocol?: string;
|
|
6075
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6076
|
+
uploadType?: string;
|
|
6077
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
6078
|
+
/** Lists all Controls by their parent DataStore. */
|
|
6079
|
+
list(request?: {
|
|
6080
|
+
/** V1 error format. */
|
|
6081
|
+
'$.xgafv'?: string;
|
|
6082
|
+
/** OAuth access token. */
|
|
6083
|
+
access_token?: string;
|
|
6084
|
+
/** Data format for response. */
|
|
6085
|
+
alt?: string;
|
|
6086
|
+
/** JSONP */
|
|
6087
|
+
callback?: string;
|
|
6088
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6089
|
+
fields?: string;
|
|
6090
|
+
/** Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */
|
|
5332
6091
|
filter?: string;
|
|
5333
6092
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5334
6093
|
key?: string;
|
|
5335
6094
|
/** OAuth 2.0 token for the current user. */
|
|
5336
6095
|
oauth_token?: string;
|
|
5337
|
-
/** Maximum number of
|
|
6096
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
5338
6097
|
pageSize?: number;
|
|
5339
|
-
/** A page token
|
|
6098
|
+
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
5340
6099
|
pageToken?: string;
|
|
5341
|
-
/** Required. The
|
|
6100
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
5342
6101
|
parent: string;
|
|
5343
6102
|
/** Returns response with indentations and line breaks. */
|
|
5344
6103
|
prettyPrint?: boolean;
|
|
@@ -5348,8 +6107,8 @@ declare namespace gapi.client {
|
|
|
5348
6107
|
upload_protocol?: string;
|
|
5349
6108
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5350
6109
|
uploadType?: string;
|
|
5351
|
-
}): Request<
|
|
5352
|
-
/** Updates a
|
|
6110
|
+
}): Request<GoogleCloudDiscoveryengineV1ListControlsResponse>;
|
|
6111
|
+
/** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
|
|
5353
6112
|
patch(request: {
|
|
5354
6113
|
/** V1 error format. */
|
|
5355
6114
|
'$.xgafv'?: string;
|
|
@@ -5363,7 +6122,7 @@ declare namespace gapi.client {
|
|
|
5363
6122
|
fields?: string;
|
|
5364
6123
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5365
6124
|
key?: string;
|
|
5366
|
-
/** Immutable.
|
|
6125
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
5367
6126
|
name: string;
|
|
5368
6127
|
/** OAuth 2.0 token for the current user. */
|
|
5369
6128
|
oauth_token?: string;
|
|
@@ -5371,15 +6130,15 @@ declare namespace gapi.client {
|
|
|
5371
6130
|
prettyPrint?: boolean;
|
|
5372
6131
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5373
6132
|
quotaUser?: string;
|
|
5374
|
-
/** Indicates which fields in the provided
|
|
6133
|
+
/** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
|
|
5375
6134
|
updateMask?: string;
|
|
5376
6135
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5377
6136
|
upload_protocol?: string;
|
|
5378
6137
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5379
6138
|
uploadType?: string;
|
|
5380
6139
|
/** Request body */
|
|
5381
|
-
resource:
|
|
5382
|
-
}): Request<
|
|
6140
|
+
resource: GoogleCloudDiscoveryengineV1Control;
|
|
6141
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
5383
6142
|
patch(
|
|
5384
6143
|
request: {
|
|
5385
6144
|
/** V1 error format. */
|
|
@@ -5394,7 +6153,7 @@ declare namespace gapi.client {
|
|
|
5394
6153
|
fields?: string;
|
|
5395
6154
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
5396
6155
|
key?: string;
|
|
5397
|
-
/** Immutable.
|
|
6156
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
5398
6157
|
name: string;
|
|
5399
6158
|
/** OAuth 2.0 token for the current user. */
|
|
5400
6159
|
oauth_token?: string;
|
|
@@ -5402,25 +6161,15 @@ declare namespace gapi.client {
|
|
|
5402
6161
|
prettyPrint?: boolean;
|
|
5403
6162
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5404
6163
|
quotaUser?: string;
|
|
5405
|
-
/** Indicates which fields in the provided
|
|
6164
|
+
/** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
|
|
5406
6165
|
updateMask?: string;
|
|
5407
6166
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5408
6167
|
upload_protocol?: string;
|
|
5409
6168
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5410
6169
|
uploadType?: string;
|
|
5411
6170
|
},
|
|
5412
|
-
body:
|
|
5413
|
-
): Request<
|
|
5414
|
-
branches: BranchesResource;
|
|
5415
|
-
conversations: ConversationsResource;
|
|
5416
|
-
models: ModelsResource;
|
|
5417
|
-
operations: OperationsResource;
|
|
5418
|
-
schemas: SchemasResource;
|
|
5419
|
-
servingConfigs: ServingConfigsResource;
|
|
5420
|
-
sessions: SessionsResource;
|
|
5421
|
-
siteSearchEngine: SiteSearchEngineResource;
|
|
5422
|
-
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
5423
|
-
userEvents: UserEventsResource;
|
|
6171
|
+
body: GoogleCloudDiscoveryengineV1Control
|
|
6172
|
+
): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
5424
6173
|
}
|
|
5425
6174
|
interface ConversationsResource {
|
|
5426
6175
|
/** Converses a conversation. */
|
|
@@ -6382,6 +7131,7 @@ declare namespace gapi.client {
|
|
|
6382
7131
|
},
|
|
6383
7132
|
body: GoogleCloudDiscoveryengineV1Engine
|
|
6384
7133
|
): Request<GoogleCloudDiscoveryengineV1Engine>;
|
|
7134
|
+
controls: ControlsResource;
|
|
6385
7135
|
conversations: ConversationsResource;
|
|
6386
7136
|
operations: OperationsResource;
|
|
6387
7137
|
servingConfigs: ServingConfigsResource;
|
|
@@ -6910,6 +7660,219 @@ declare namespace gapi.client {
|
|
|
6910
7660
|
documents: DocumentsResource;
|
|
6911
7661
|
operations: OperationsResource;
|
|
6912
7662
|
}
|
|
7663
|
+
interface ControlsResource {
|
|
7664
|
+
/** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
|
|
7665
|
+
create(request: {
|
|
7666
|
+
/** V1 error format. */
|
|
7667
|
+
'$.xgafv'?: string;
|
|
7668
|
+
/** OAuth access token. */
|
|
7669
|
+
access_token?: string;
|
|
7670
|
+
/** Data format for response. */
|
|
7671
|
+
alt?: string;
|
|
7672
|
+
/** JSONP */
|
|
7673
|
+
callback?: string;
|
|
7674
|
+
/** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
|
|
7675
|
+
controlId?: string;
|
|
7676
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7677
|
+
fields?: string;
|
|
7678
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7679
|
+
key?: string;
|
|
7680
|
+
/** OAuth 2.0 token for the current user. */
|
|
7681
|
+
oauth_token?: string;
|
|
7682
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
7683
|
+
parent: string;
|
|
7684
|
+
/** Returns response with indentations and line breaks. */
|
|
7685
|
+
prettyPrint?: boolean;
|
|
7686
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7687
|
+
quotaUser?: string;
|
|
7688
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7689
|
+
upload_protocol?: string;
|
|
7690
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7691
|
+
uploadType?: string;
|
|
7692
|
+
/** Request body */
|
|
7693
|
+
resource: GoogleCloudDiscoveryengineV1Control;
|
|
7694
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
7695
|
+
create(
|
|
7696
|
+
request: {
|
|
7697
|
+
/** V1 error format. */
|
|
7698
|
+
'$.xgafv'?: string;
|
|
7699
|
+
/** OAuth access token. */
|
|
7700
|
+
access_token?: string;
|
|
7701
|
+
/** Data format for response. */
|
|
7702
|
+
alt?: string;
|
|
7703
|
+
/** JSONP */
|
|
7704
|
+
callback?: string;
|
|
7705
|
+
/** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
|
|
7706
|
+
controlId?: string;
|
|
7707
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7708
|
+
fields?: string;
|
|
7709
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7710
|
+
key?: string;
|
|
7711
|
+
/** OAuth 2.0 token for the current user. */
|
|
7712
|
+
oauth_token?: string;
|
|
7713
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
7714
|
+
parent: string;
|
|
7715
|
+
/** Returns response with indentations and line breaks. */
|
|
7716
|
+
prettyPrint?: boolean;
|
|
7717
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7718
|
+
quotaUser?: string;
|
|
7719
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7720
|
+
upload_protocol?: string;
|
|
7721
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7722
|
+
uploadType?: string;
|
|
7723
|
+
},
|
|
7724
|
+
body: GoogleCloudDiscoveryengineV1Control
|
|
7725
|
+
): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
7726
|
+
/** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
|
|
7727
|
+
delete(request?: {
|
|
7728
|
+
/** V1 error format. */
|
|
7729
|
+
'$.xgafv'?: string;
|
|
7730
|
+
/** OAuth access token. */
|
|
7731
|
+
access_token?: string;
|
|
7732
|
+
/** Data format for response. */
|
|
7733
|
+
alt?: string;
|
|
7734
|
+
/** JSONP */
|
|
7735
|
+
callback?: string;
|
|
7736
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7737
|
+
fields?: string;
|
|
7738
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7739
|
+
key?: string;
|
|
7740
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7741
|
+
name: string;
|
|
7742
|
+
/** OAuth 2.0 token for the current user. */
|
|
7743
|
+
oauth_token?: string;
|
|
7744
|
+
/** Returns response with indentations and line breaks. */
|
|
7745
|
+
prettyPrint?: boolean;
|
|
7746
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7747
|
+
quotaUser?: string;
|
|
7748
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7749
|
+
upload_protocol?: string;
|
|
7750
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7751
|
+
uploadType?: string;
|
|
7752
|
+
}): Request<{}>;
|
|
7753
|
+
/** Gets a Control. */
|
|
7754
|
+
get(request?: {
|
|
7755
|
+
/** V1 error format. */
|
|
7756
|
+
'$.xgafv'?: string;
|
|
7757
|
+
/** OAuth access token. */
|
|
7758
|
+
access_token?: string;
|
|
7759
|
+
/** Data format for response. */
|
|
7760
|
+
alt?: string;
|
|
7761
|
+
/** JSONP */
|
|
7762
|
+
callback?: string;
|
|
7763
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7764
|
+
fields?: string;
|
|
7765
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7766
|
+
key?: string;
|
|
7767
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7768
|
+
name: string;
|
|
7769
|
+
/** OAuth 2.0 token for the current user. */
|
|
7770
|
+
oauth_token?: string;
|
|
7771
|
+
/** Returns response with indentations and line breaks. */
|
|
7772
|
+
prettyPrint?: boolean;
|
|
7773
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7774
|
+
quotaUser?: string;
|
|
7775
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7776
|
+
upload_protocol?: string;
|
|
7777
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7778
|
+
uploadType?: string;
|
|
7779
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
7780
|
+
/** Lists all Controls by their parent DataStore. */
|
|
7781
|
+
list(request?: {
|
|
7782
|
+
/** V1 error format. */
|
|
7783
|
+
'$.xgafv'?: string;
|
|
7784
|
+
/** OAuth access token. */
|
|
7785
|
+
access_token?: string;
|
|
7786
|
+
/** Data format for response. */
|
|
7787
|
+
alt?: string;
|
|
7788
|
+
/** JSONP */
|
|
7789
|
+
callback?: string;
|
|
7790
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7791
|
+
fields?: string;
|
|
7792
|
+
/** Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */
|
|
7793
|
+
filter?: string;
|
|
7794
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7795
|
+
key?: string;
|
|
7796
|
+
/** OAuth 2.0 token for the current user. */
|
|
7797
|
+
oauth_token?: string;
|
|
7798
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
7799
|
+
pageSize?: number;
|
|
7800
|
+
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
7801
|
+
pageToken?: string;
|
|
7802
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
7803
|
+
parent: string;
|
|
7804
|
+
/** Returns response with indentations and line breaks. */
|
|
7805
|
+
prettyPrint?: boolean;
|
|
7806
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7807
|
+
quotaUser?: string;
|
|
7808
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7809
|
+
upload_protocol?: string;
|
|
7810
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7811
|
+
uploadType?: string;
|
|
7812
|
+
}): Request<GoogleCloudDiscoveryengineV1ListControlsResponse>;
|
|
7813
|
+
/** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
|
|
7814
|
+
patch(request: {
|
|
7815
|
+
/** V1 error format. */
|
|
7816
|
+
'$.xgafv'?: string;
|
|
7817
|
+
/** OAuth access token. */
|
|
7818
|
+
access_token?: string;
|
|
7819
|
+
/** Data format for response. */
|
|
7820
|
+
alt?: string;
|
|
7821
|
+
/** JSONP */
|
|
7822
|
+
callback?: string;
|
|
7823
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7824
|
+
fields?: string;
|
|
7825
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7826
|
+
key?: string;
|
|
7827
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
7828
|
+
name: string;
|
|
7829
|
+
/** OAuth 2.0 token for the current user. */
|
|
7830
|
+
oauth_token?: string;
|
|
7831
|
+
/** Returns response with indentations and line breaks. */
|
|
7832
|
+
prettyPrint?: boolean;
|
|
7833
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7834
|
+
quotaUser?: string;
|
|
7835
|
+
/** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
|
|
7836
|
+
updateMask?: string;
|
|
7837
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7838
|
+
upload_protocol?: string;
|
|
7839
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7840
|
+
uploadType?: string;
|
|
7841
|
+
/** Request body */
|
|
7842
|
+
resource: GoogleCloudDiscoveryengineV1Control;
|
|
7843
|
+
}): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
7844
|
+
patch(
|
|
7845
|
+
request: {
|
|
7846
|
+
/** V1 error format. */
|
|
7847
|
+
'$.xgafv'?: string;
|
|
7848
|
+
/** OAuth access token. */
|
|
7849
|
+
access_token?: string;
|
|
7850
|
+
/** Data format for response. */
|
|
7851
|
+
alt?: string;
|
|
7852
|
+
/** JSONP */
|
|
7853
|
+
callback?: string;
|
|
7854
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7855
|
+
fields?: string;
|
|
7856
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
7857
|
+
key?: string;
|
|
7858
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
7859
|
+
name: string;
|
|
7860
|
+
/** OAuth 2.0 token for the current user. */
|
|
7861
|
+
oauth_token?: string;
|
|
7862
|
+
/** Returns response with indentations and line breaks. */
|
|
7863
|
+
prettyPrint?: boolean;
|
|
7864
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
7865
|
+
quotaUser?: string;
|
|
7866
|
+
/** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
|
|
7867
|
+
updateMask?: string;
|
|
7868
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7869
|
+
upload_protocol?: string;
|
|
7870
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7871
|
+
uploadType?: string;
|
|
7872
|
+
},
|
|
7873
|
+
body: GoogleCloudDiscoveryengineV1Control
|
|
7874
|
+
): Request<GoogleCloudDiscoveryengineV1Control>;
|
|
7875
|
+
}
|
|
6913
7876
|
interface ConversationsResource {
|
|
6914
7877
|
/** Converses a conversation. */
|
|
6915
7878
|
converse(request: {
|
|
@@ -8608,6 +9571,8 @@ declare namespace gapi.client {
|
|
|
8608
9571
|
upload_protocol?: string;
|
|
8609
9572
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8610
9573
|
uploadType?: string;
|
|
9574
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
9575
|
+
writeAsync?: boolean;
|
|
8611
9576
|
/** Request body */
|
|
8612
9577
|
resource: GoogleCloudDiscoveryengineV1UserEvent;
|
|
8613
9578
|
}): Request<GoogleCloudDiscoveryengineV1UserEvent>;
|
|
@@ -8637,6 +9602,8 @@ declare namespace gapi.client {
|
|
|
8637
9602
|
upload_protocol?: string;
|
|
8638
9603
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8639
9604
|
uploadType?: string;
|
|
9605
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
9606
|
+
writeAsync?: boolean;
|
|
8640
9607
|
},
|
|
8641
9608
|
body: GoogleCloudDiscoveryengineV1UserEvent
|
|
8642
9609
|
): Request<GoogleCloudDiscoveryengineV1UserEvent>;
|
|
@@ -8836,7 +9803,7 @@ declare namespace gapi.client {
|
|
|
8836
9803
|
callback?: string;
|
|
8837
9804
|
/** Selector specifying which fields to include in a partial response. */
|
|
8838
9805
|
fields?: string;
|
|
8839
|
-
/** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
9806
|
+
/** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
|
|
8840
9807
|
filter?: string;
|
|
8841
9808
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8842
9809
|
key?: string;
|
|
@@ -8920,6 +9887,7 @@ declare namespace gapi.client {
|
|
|
8920
9887
|
body: GoogleCloudDiscoveryengineV1DataStore
|
|
8921
9888
|
): Request<GoogleCloudDiscoveryengineV1DataStore>;
|
|
8922
9889
|
branches: BranchesResource;
|
|
9890
|
+
controls: ControlsResource;
|
|
8923
9891
|
conversations: ConversationsResource;
|
|
8924
9892
|
models: ModelsResource;
|
|
8925
9893
|
operations: OperationsResource;
|
|
@@ -9139,6 +10107,8 @@ declare namespace gapi.client {
|
|
|
9139
10107
|
upload_protocol?: string;
|
|
9140
10108
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9141
10109
|
uploadType?: string;
|
|
10110
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
10111
|
+
writeAsync?: boolean;
|
|
9142
10112
|
/** Request body */
|
|
9143
10113
|
resource: GoogleCloudDiscoveryengineV1UserEvent;
|
|
9144
10114
|
}): Request<GoogleCloudDiscoveryengineV1UserEvent>;
|
|
@@ -9168,6 +10138,8 @@ declare namespace gapi.client {
|
|
|
9168
10138
|
upload_protocol?: string;
|
|
9169
10139
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9170
10140
|
uploadType?: string;
|
|
10141
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
10142
|
+
writeAsync?: boolean;
|
|
9171
10143
|
},
|
|
9172
10144
|
body: GoogleCloudDiscoveryengineV1UserEvent
|
|
9173
10145
|
): Request<GoogleCloudDiscoveryengineV1UserEvent>;
|
|
@@ -9301,6 +10273,64 @@ declare namespace gapi.client {
|
|
|
9301
10273
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
9302
10274
|
}
|
|
9303
10275
|
interface ProjectsResource {
|
|
10276
|
+
/** Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. */
|
|
10277
|
+
provision(request: {
|
|
10278
|
+
/** V1 error format. */
|
|
10279
|
+
'$.xgafv'?: string;
|
|
10280
|
+
/** OAuth access token. */
|
|
10281
|
+
access_token?: string;
|
|
10282
|
+
/** Data format for response. */
|
|
10283
|
+
alt?: string;
|
|
10284
|
+
/** JSONP */
|
|
10285
|
+
callback?: string;
|
|
10286
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10287
|
+
fields?: string;
|
|
10288
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
10289
|
+
key?: string;
|
|
10290
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
10291
|
+
name: string;
|
|
10292
|
+
/** OAuth 2.0 token for the current user. */
|
|
10293
|
+
oauth_token?: string;
|
|
10294
|
+
/** Returns response with indentations and line breaks. */
|
|
10295
|
+
prettyPrint?: boolean;
|
|
10296
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
10297
|
+
quotaUser?: string;
|
|
10298
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10299
|
+
upload_protocol?: string;
|
|
10300
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10301
|
+
uploadType?: string;
|
|
10302
|
+
/** Request body */
|
|
10303
|
+
resource: GoogleCloudDiscoveryengineV1ProvisionProjectRequest;
|
|
10304
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10305
|
+
provision(
|
|
10306
|
+
request: {
|
|
10307
|
+
/** V1 error format. */
|
|
10308
|
+
'$.xgafv'?: string;
|
|
10309
|
+
/** OAuth access token. */
|
|
10310
|
+
access_token?: string;
|
|
10311
|
+
/** Data format for response. */
|
|
10312
|
+
alt?: string;
|
|
10313
|
+
/** JSONP */
|
|
10314
|
+
callback?: string;
|
|
10315
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10316
|
+
fields?: string;
|
|
10317
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
10318
|
+
key?: string;
|
|
10319
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
10320
|
+
name: string;
|
|
10321
|
+
/** OAuth 2.0 token for the current user. */
|
|
10322
|
+
oauth_token?: string;
|
|
10323
|
+
/** Returns response with indentations and line breaks. */
|
|
10324
|
+
prettyPrint?: boolean;
|
|
10325
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
10326
|
+
quotaUser?: string;
|
|
10327
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10328
|
+
upload_protocol?: string;
|
|
10329
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10330
|
+
uploadType?: string;
|
|
10331
|
+
},
|
|
10332
|
+
body: GoogleCloudDiscoveryengineV1ProvisionProjectRequest
|
|
10333
|
+
): Request<GoogleLongrunningOperation>;
|
|
9304
10334
|
locations: LocationsResource;
|
|
9305
10335
|
operations: OperationsResource;
|
|
9306
10336
|
}
|