@maxim_mazurok/gapi.client.discoveryengine-v1beta 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 +1162 -132
- 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240530
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -155,6 +155,8 @@ declare namespace gapi.client {
|
|
|
155
155
|
document?: string;
|
|
156
156
|
/** Page identifier. */
|
|
157
157
|
pageIdentifier?: string;
|
|
158
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
159
|
+
structData?: {[P in string]: any};
|
|
158
160
|
/** Title. */
|
|
159
161
|
title?: string;
|
|
160
162
|
/** URI for the document. */
|
|
@@ -165,6 +167,8 @@ declare namespace gapi.client {
|
|
|
165
167
|
chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
166
168
|
/** Document resource name. */
|
|
167
169
|
document?: string;
|
|
170
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
171
|
+
structData?: {[P in string]: any};
|
|
168
172
|
/** Title. */
|
|
169
173
|
title?: string;
|
|
170
174
|
/** URI for the document. */
|
|
@@ -236,6 +240,68 @@ declare namespace gapi.client {
|
|
|
236
240
|
/** TargetSites created. */
|
|
237
241
|
targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
238
242
|
}
|
|
243
|
+
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
244
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
245
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
246
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
247
|
+
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
248
|
+
}
|
|
249
|
+
interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
|
|
250
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
251
|
+
fullMatch?: boolean;
|
|
252
|
+
/** 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. */
|
|
253
|
+
value?: string;
|
|
254
|
+
}
|
|
255
|
+
interface GoogleCloudDiscoveryengineV1alphaConditionTimeRange {
|
|
256
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
257
|
+
endTime?: string;
|
|
258
|
+
/** Start of time range. Range is inclusive. */
|
|
259
|
+
startTime?: string;
|
|
260
|
+
}
|
|
261
|
+
interface GoogleCloudDiscoveryengineV1alphaControl {
|
|
262
|
+
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
263
|
+
associatedServingConfigIds?: string[];
|
|
264
|
+
/** Defines a boost-type control */
|
|
265
|
+
boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
|
|
266
|
+
/** 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. */
|
|
267
|
+
conditions?: GoogleCloudDiscoveryengineV1alphaCondition[];
|
|
268
|
+
/** 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. */
|
|
269
|
+
displayName?: string;
|
|
270
|
+
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
271
|
+
filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
|
|
272
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
273
|
+
name?: string;
|
|
274
|
+
/** Defines a redirect-type control. */
|
|
275
|
+
redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
|
|
276
|
+
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
277
|
+
solutionType?: string;
|
|
278
|
+
/** Treats a group of terms as synonyms of one another. */
|
|
279
|
+
synonymsAction?: GoogleCloudDiscoveryengineV1alphaControlSynonymsAction;
|
|
280
|
+
/** 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. */
|
|
281
|
+
useCases?: string[];
|
|
282
|
+
}
|
|
283
|
+
interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
|
|
284
|
+
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
285
|
+
boost?: number;
|
|
286
|
+
/** 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 */
|
|
287
|
+
dataStore?: string;
|
|
288
|
+
/** 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. */
|
|
289
|
+
filter?: string;
|
|
290
|
+
}
|
|
291
|
+
interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
|
|
292
|
+
/** 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 */
|
|
293
|
+
dataStore?: string;
|
|
294
|
+
/** 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. */
|
|
295
|
+
filter?: string;
|
|
296
|
+
}
|
|
297
|
+
interface GoogleCloudDiscoveryengineV1alphaControlRedirectAction {
|
|
298
|
+
/** 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. */
|
|
299
|
+
redirectUri?: string;
|
|
300
|
+
}
|
|
301
|
+
interface GoogleCloudDiscoveryengineV1alphaControlSynonymsAction {
|
|
302
|
+
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
303
|
+
synonyms?: string[];
|
|
304
|
+
}
|
|
239
305
|
interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
|
|
240
306
|
/** Operation create time. */
|
|
241
307
|
createTime?: string;
|
|
@@ -267,6 +333,7 @@ declare namespace gapi.client {
|
|
|
267
333
|
displayName?: string;
|
|
268
334
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
269
335
|
modelState?: string;
|
|
336
|
+
/** The version of the model. */
|
|
270
337
|
modelVersion?: string;
|
|
271
338
|
/** 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
339
|
name?: string;
|
|
@@ -424,7 +491,7 @@ declare namespace gapi.client {
|
|
|
424
491
|
dialogflowAgent?: string;
|
|
425
492
|
}
|
|
426
493
|
interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
427
|
-
/**
|
|
494
|
+
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
428
495
|
companyName?: string;
|
|
429
496
|
}
|
|
430
497
|
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
@@ -489,6 +556,8 @@ declare namespace gapi.client {
|
|
|
489
556
|
recsFilterableOption?: string;
|
|
490
557
|
/** 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
558
|
retrievableOption?: string;
|
|
559
|
+
/** 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 */
|
|
560
|
+
schemaOrgPaths?: string[];
|
|
492
561
|
/** 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
562
|
searchableOption?: string;
|
|
494
563
|
}
|
|
@@ -782,6 +851,20 @@ declare namespace gapi.client {
|
|
|
782
851
|
/** TargetSites created. */
|
|
783
852
|
targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
|
|
784
853
|
}
|
|
854
|
+
interface GoogleCloudDiscoveryengineV1betaAlloyDbSource {
|
|
855
|
+
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
856
|
+
clusterId?: string;
|
|
857
|
+
/** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
|
|
858
|
+
databaseId?: string;
|
|
859
|
+
/** 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. */
|
|
860
|
+
gcsStagingDir?: string;
|
|
861
|
+
/** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
|
|
862
|
+
locationId?: string;
|
|
863
|
+
/** 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. */
|
|
864
|
+
projectId?: string;
|
|
865
|
+
/** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
|
|
866
|
+
tableId?: string;
|
|
867
|
+
}
|
|
785
868
|
interface GoogleCloudDiscoveryengineV1betaAnswer {
|
|
786
869
|
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
787
870
|
answerSkippedReasons?: string[];
|
|
@@ -835,6 +918,8 @@ declare namespace gapi.client {
|
|
|
835
918
|
searchSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec;
|
|
836
919
|
/** 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. */
|
|
837
920
|
session?: string;
|
|
921
|
+
/** 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. */
|
|
922
|
+
userLabels?: {[P in string]: string};
|
|
838
923
|
/** 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. */
|
|
839
924
|
userPseudoId?: string;
|
|
840
925
|
}
|
|
@@ -843,6 +928,8 @@ declare namespace gapi.client {
|
|
|
843
928
|
answerLanguageCode?: string;
|
|
844
929
|
/** 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. */
|
|
845
930
|
ignoreAdversarialQuery?: boolean;
|
|
931
|
+
/** 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. */
|
|
932
|
+
ignoreLowRelevantContent?: boolean;
|
|
846
933
|
/** 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. */
|
|
847
934
|
ignoreNonAnswerSeekingQuery?: boolean;
|
|
848
935
|
/** Specifies whether to include citation metadata in the answer. The default value is `false`. */
|
|
@@ -893,6 +980,8 @@ declare namespace gapi.client {
|
|
|
893
980
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams {
|
|
894
981
|
/** 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) */
|
|
895
982
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
983
|
+
/** 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. */
|
|
984
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
896
985
|
/** 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) */
|
|
897
986
|
filter?: string;
|
|
898
987
|
/** Number of search results to return. The default value is 10. */
|
|
@@ -987,6 +1076,8 @@ declare namespace gapi.client {
|
|
|
987
1076
|
document?: string;
|
|
988
1077
|
/** Page identifier. */
|
|
989
1078
|
pageIdentifier?: 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};
|
|
990
1081
|
/** Title. */
|
|
991
1082
|
title?: string;
|
|
992
1083
|
/** URI for the document. */
|
|
@@ -997,6 +1088,8 @@ declare namespace gapi.client {
|
|
|
997
1088
|
chunkContents?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
998
1089
|
/** Document resource name. */
|
|
999
1090
|
document?: string;
|
|
1091
|
+
/** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
|
|
1092
|
+
structData?: {[P in string]: any};
|
|
1000
1093
|
/** Title. */
|
|
1001
1094
|
title?: string;
|
|
1002
1095
|
/** URI for the document. */
|
|
@@ -1191,6 +1284,68 @@ declare namespace gapi.client {
|
|
|
1191
1284
|
/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
|
|
1192
1285
|
selectedSuggestion?: string;
|
|
1193
1286
|
}
|
|
1287
|
+
interface GoogleCloudDiscoveryengineV1betaCondition {
|
|
1288
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
1289
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
|
|
1290
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
1291
|
+
queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
|
|
1292
|
+
}
|
|
1293
|
+
interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
|
|
1294
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
1295
|
+
fullMatch?: boolean;
|
|
1296
|
+
/** 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. */
|
|
1297
|
+
value?: string;
|
|
1298
|
+
}
|
|
1299
|
+
interface GoogleCloudDiscoveryengineV1betaConditionTimeRange {
|
|
1300
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
1301
|
+
endTime?: string;
|
|
1302
|
+
/** Start of time range. Range is inclusive. */
|
|
1303
|
+
startTime?: string;
|
|
1304
|
+
}
|
|
1305
|
+
interface GoogleCloudDiscoveryengineV1betaControl {
|
|
1306
|
+
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
1307
|
+
associatedServingConfigIds?: string[];
|
|
1308
|
+
/** Defines a boost-type control */
|
|
1309
|
+
boostAction?: GoogleCloudDiscoveryengineV1betaControlBoostAction;
|
|
1310
|
+
/** 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. */
|
|
1311
|
+
conditions?: GoogleCloudDiscoveryengineV1betaCondition[];
|
|
1312
|
+
/** 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. */
|
|
1313
|
+
displayName?: string;
|
|
1314
|
+
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
1315
|
+
filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
|
|
1316
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
1317
|
+
name?: string;
|
|
1318
|
+
/** Defines a redirect-type control. */
|
|
1319
|
+
redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
|
|
1320
|
+
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1321
|
+
solutionType?: string;
|
|
1322
|
+
/** Treats a group of terms as synonyms of one another. */
|
|
1323
|
+
synonymsAction?: GoogleCloudDiscoveryengineV1betaControlSynonymsAction;
|
|
1324
|
+
/** 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. */
|
|
1325
|
+
useCases?: string[];
|
|
1326
|
+
}
|
|
1327
|
+
interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
|
|
1328
|
+
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
1329
|
+
boost?: number;
|
|
1330
|
+
/** 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 */
|
|
1331
|
+
dataStore?: string;
|
|
1332
|
+
/** 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. */
|
|
1333
|
+
filter?: string;
|
|
1334
|
+
}
|
|
1335
|
+
interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
|
|
1336
|
+
/** 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 */
|
|
1337
|
+
dataStore?: string;
|
|
1338
|
+
/** 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. */
|
|
1339
|
+
filter?: string;
|
|
1340
|
+
}
|
|
1341
|
+
interface GoogleCloudDiscoveryengineV1betaControlRedirectAction {
|
|
1342
|
+
/** 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. */
|
|
1343
|
+
redirectUri?: string;
|
|
1344
|
+
}
|
|
1345
|
+
interface GoogleCloudDiscoveryengineV1betaControlSynonymsAction {
|
|
1346
|
+
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1347
|
+
synonyms?: string[];
|
|
1348
|
+
}
|
|
1194
1349
|
interface GoogleCloudDiscoveryengineV1betaConversation {
|
|
1195
1350
|
/** Output only. The time the conversation finished. */
|
|
1196
1351
|
endTime?: string;
|
|
@@ -1290,6 +1445,7 @@ declare namespace gapi.client {
|
|
|
1290
1445
|
displayName?: string;
|
|
1291
1446
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
1292
1447
|
modelState?: string;
|
|
1448
|
+
/** The version of the model. */
|
|
1293
1449
|
modelVersion?: string;
|
|
1294
1450
|
/** 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. */
|
|
1295
1451
|
name?: string;
|
|
@@ -1389,6 +1545,8 @@ declare namespace gapi.client {
|
|
|
1389
1545
|
uri?: string;
|
|
1390
1546
|
}
|
|
1391
1547
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
1548
|
+
/** Whether chunking mode is enabled. */
|
|
1549
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
|
|
1392
1550
|
/** 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. */
|
|
1393
1551
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1394
1552
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -1398,13 +1556,26 @@ declare namespace gapi.client {
|
|
|
1398
1556
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1399
1557
|
};
|
|
1400
1558
|
}
|
|
1559
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
1560
|
+
/** Configuration for the layout based chunking. */
|
|
1561
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1562
|
+
}
|
|
1563
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1564
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
1565
|
+
chunkSize?: number;
|
|
1566
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
1567
|
+
includeAncestorHeadings?: boolean;
|
|
1568
|
+
}
|
|
1401
1569
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
1402
1570
|
/** Configurations applied to digital parser. */
|
|
1403
1571
|
digitalParsingConfig?: any;
|
|
1572
|
+
/** Configurations applied to layout parser. */
|
|
1573
|
+
layoutParsingConfig?: any;
|
|
1404
1574
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1405
1575
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1406
1576
|
}
|
|
1407
1577
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1578
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
1408
1579
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1409
1580
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1410
1581
|
enhancedDocumentElements?: string[];
|
|
@@ -1472,7 +1643,7 @@ declare namespace gapi.client {
|
|
|
1472
1643
|
dialogflowAgent?: string;
|
|
1473
1644
|
}
|
|
1474
1645
|
interface GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
1475
|
-
/**
|
|
1646
|
+
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
1476
1647
|
companyName?: string;
|
|
1477
1648
|
}
|
|
1478
1649
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
@@ -1540,6 +1711,8 @@ declare namespace gapi.client {
|
|
|
1540
1711
|
updateTime?: string;
|
|
1541
1712
|
}
|
|
1542
1713
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
|
|
1714
|
+
/** AlloyDB input source. */
|
|
1715
|
+
alloyDbSource?: GoogleCloudDiscoveryengineV1betaAlloyDbSource;
|
|
1543
1716
|
/** 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. */
|
|
1544
1717
|
autoGenerateIds?: boolean;
|
|
1545
1718
|
/** BigQuery input source. */
|
|
@@ -1649,6 +1822,12 @@ declare namespace gapi.client {
|
|
|
1649
1822
|
/** Inclusive lower bound. */
|
|
1650
1823
|
minimum?: number;
|
|
1651
1824
|
}
|
|
1825
|
+
interface GoogleCloudDiscoveryengineV1betaListControlsResponse {
|
|
1826
|
+
/** All the Controls for a given data store. */
|
|
1827
|
+
controls?: GoogleCloudDiscoveryengineV1betaControl[];
|
|
1828
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
1829
|
+
nextPageToken?: string;
|
|
1830
|
+
}
|
|
1652
1831
|
interface GoogleCloudDiscoveryengineV1betaListConversationsResponse {
|
|
1653
1832
|
/** All the Conversations for a given data store. */
|
|
1654
1833
|
conversations?: GoogleCloudDiscoveryengineV1betaConversation[];
|
|
@@ -1730,6 +1909,37 @@ declare namespace gapi.client {
|
|
|
1730
1909
|
totalPanels?: number;
|
|
1731
1910
|
}
|
|
1732
1911
|
interface GoogleCloudDiscoveryengineV1betaPauseEngineRequest {}
|
|
1912
|
+
interface GoogleCloudDiscoveryengineV1betaProject {
|
|
1913
|
+
/** Output only. The timestamp when this project is created. */
|
|
1914
|
+
createTime?: string;
|
|
1915
|
+
/** 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. */
|
|
1916
|
+
name?: string;
|
|
1917
|
+
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
1918
|
+
provisionCompletionTime?: string;
|
|
1919
|
+
/** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
|
|
1920
|
+
serviceTermsMap?: {
|
|
1921
|
+
[P in string]: GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
|
|
1922
|
+
};
|
|
1923
|
+
}
|
|
1924
|
+
interface GoogleCloudDiscoveryengineV1betaProjectServiceTerms {
|
|
1925
|
+
/** The last time when the project agreed to the terms of service. */
|
|
1926
|
+
acceptTime?: string;
|
|
1927
|
+
/** The last time when the project declined or revoked the agreement to terms of service. */
|
|
1928
|
+
declineTime?: string;
|
|
1929
|
+
/** 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`. */
|
|
1930
|
+
id?: string;
|
|
1931
|
+
/** Whether the project has accepted/rejected the service terms or it is still pending. */
|
|
1932
|
+
state?: string;
|
|
1933
|
+
/** The version string of the terms of service. For acceptable values, see the comments for id above. */
|
|
1934
|
+
version?: string;
|
|
1935
|
+
}
|
|
1936
|
+
interface GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {}
|
|
1937
|
+
interface GoogleCloudDiscoveryengineV1betaProvisionProjectRequest {
|
|
1938
|
+
/** 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). */
|
|
1939
|
+
acceptDataUseTerms?: boolean;
|
|
1940
|
+
/** 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. */
|
|
1941
|
+
dataUseTermsVersion?: string;
|
|
1942
|
+
}
|
|
1733
1943
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
1734
1944
|
/** Operation create time. */
|
|
1735
1945
|
createTime?: string;
|
|
@@ -1794,6 +2004,8 @@ declare namespace gapi.client {
|
|
|
1794
2004
|
records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
1795
2005
|
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
1796
2006
|
topN?: number;
|
|
2007
|
+
/** 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. */
|
|
2008
|
+
userLabels?: {[P in string]: string};
|
|
1797
2009
|
}
|
|
1798
2010
|
interface GoogleCloudDiscoveryengineV1betaRankResponse {
|
|
1799
2011
|
/** A list of records sorted by descending score. */
|
|
@@ -2398,10 +2610,14 @@ declare namespace gapi.client {
|
|
|
2398
2610
|
attributionToken?: string;
|
|
2399
2611
|
/** 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. */
|
|
2400
2612
|
completionInfo?: GoogleCloudDiscoveryengineV1betaCompletionInfo;
|
|
2613
|
+
/** 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. */
|
|
2614
|
+
dataStore?: string;
|
|
2401
2615
|
/** 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. */
|
|
2402
2616
|
directUserRequest?: boolean;
|
|
2403
2617
|
/** 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. */
|
|
2404
2618
|
documents?: GoogleCloudDiscoveryengineV1betaDocumentInfo[];
|
|
2619
|
+
/** 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. */
|
|
2620
|
+
engine?: string;
|
|
2405
2621
|
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
2406
2622
|
eventTime?: string;
|
|
2407
2623
|
/** 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. */
|
|
@@ -2435,6 +2651,68 @@ declare namespace gapi.client {
|
|
|
2435
2651
|
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
2436
2652
|
userId?: string;
|
|
2437
2653
|
}
|
|
2654
|
+
interface GoogleCloudDiscoveryengineV1Condition {
|
|
2655
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
2656
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
2657
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
2658
|
+
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
2659
|
+
}
|
|
2660
|
+
interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
|
|
2661
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
2662
|
+
fullMatch?: boolean;
|
|
2663
|
+
/** 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. */
|
|
2664
|
+
value?: string;
|
|
2665
|
+
}
|
|
2666
|
+
interface GoogleCloudDiscoveryengineV1ConditionTimeRange {
|
|
2667
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
2668
|
+
endTime?: string;
|
|
2669
|
+
/** Start of time range. Range is inclusive. */
|
|
2670
|
+
startTime?: string;
|
|
2671
|
+
}
|
|
2672
|
+
interface GoogleCloudDiscoveryengineV1Control {
|
|
2673
|
+
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
2674
|
+
associatedServingConfigIds?: string[];
|
|
2675
|
+
/** Defines a boost-type control */
|
|
2676
|
+
boostAction?: GoogleCloudDiscoveryengineV1ControlBoostAction;
|
|
2677
|
+
/** 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. */
|
|
2678
|
+
conditions?: GoogleCloudDiscoveryengineV1Condition[];
|
|
2679
|
+
/** 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. */
|
|
2680
|
+
displayName?: string;
|
|
2681
|
+
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
2682
|
+
filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
|
|
2683
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
2684
|
+
name?: string;
|
|
2685
|
+
/** Defines a redirect-type control. */
|
|
2686
|
+
redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
|
|
2687
|
+
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
2688
|
+
solutionType?: string;
|
|
2689
|
+
/** Treats a group of terms as synonyms of one another. */
|
|
2690
|
+
synonymsAction?: GoogleCloudDiscoveryengineV1ControlSynonymsAction;
|
|
2691
|
+
/** 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. */
|
|
2692
|
+
useCases?: string[];
|
|
2693
|
+
}
|
|
2694
|
+
interface GoogleCloudDiscoveryengineV1ControlBoostAction {
|
|
2695
|
+
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
2696
|
+
boost?: number;
|
|
2697
|
+
/** 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 */
|
|
2698
|
+
dataStore?: string;
|
|
2699
|
+
/** 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. */
|
|
2700
|
+
filter?: string;
|
|
2701
|
+
}
|
|
2702
|
+
interface GoogleCloudDiscoveryengineV1ControlFilterAction {
|
|
2703
|
+
/** 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 */
|
|
2704
|
+
dataStore?: string;
|
|
2705
|
+
/** 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. */
|
|
2706
|
+
filter?: string;
|
|
2707
|
+
}
|
|
2708
|
+
interface GoogleCloudDiscoveryengineV1ControlRedirectAction {
|
|
2709
|
+
/** 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. */
|
|
2710
|
+
redirectUri?: string;
|
|
2711
|
+
}
|
|
2712
|
+
interface GoogleCloudDiscoveryengineV1ControlSynonymsAction {
|
|
2713
|
+
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
2714
|
+
synonyms?: string[];
|
|
2715
|
+
}
|
|
2438
2716
|
interface GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
2439
2717
|
/** Operation create time. */
|
|
2440
2718
|
createTime?: string;
|
|
@@ -2511,6 +2789,8 @@ declare namespace gapi.client {
|
|
|
2511
2789
|
}
|
|
2512
2790
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
2513
2791
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
2792
|
+
/** Whether chunking mode is enabled. */
|
|
2793
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
|
|
2514
2794
|
/** 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. */
|
|
2515
2795
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2516
2796
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -2520,13 +2800,26 @@ declare namespace gapi.client {
|
|
|
2520
2800
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2521
2801
|
};
|
|
2522
2802
|
}
|
|
2803
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
2804
|
+
/** Configuration for the layout based chunking. */
|
|
2805
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
2806
|
+
}
|
|
2807
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
2808
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
2809
|
+
chunkSize?: number;
|
|
2810
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
2811
|
+
includeAncestorHeadings?: boolean;
|
|
2812
|
+
}
|
|
2523
2813
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
2524
2814
|
/** Configurations applied to digital parser. */
|
|
2525
2815
|
digitalParsingConfig?: any;
|
|
2816
|
+
/** Configurations applied to layout parser. */
|
|
2817
|
+
layoutParsingConfig?: any;
|
|
2526
2818
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
2527
2819
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
2528
2820
|
}
|
|
2529
2821
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2822
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
2530
2823
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2531
2824
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2532
2825
|
enhancedDocumentElements?: string[];
|
|
@@ -2585,7 +2878,7 @@ declare namespace gapi.client {
|
|
|
2585
2878
|
dialogflowAgent?: string;
|
|
2586
2879
|
}
|
|
2587
2880
|
interface GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
2588
|
-
/**
|
|
2881
|
+
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
2589
2882
|
companyName?: string;
|
|
2590
2883
|
}
|
|
2591
2884
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
@@ -2650,6 +2943,31 @@ declare namespace gapi.client {
|
|
|
2650
2943
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
2651
2944
|
unjoinedEventsCount?: string;
|
|
2652
2945
|
}
|
|
2946
|
+
interface GoogleCloudDiscoveryengineV1Project {
|
|
2947
|
+
/** Output only. The timestamp when this project is created. */
|
|
2948
|
+
createTime?: string;
|
|
2949
|
+
/** 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. */
|
|
2950
|
+
name?: string;
|
|
2951
|
+
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
2952
|
+
provisionCompletionTime?: string;
|
|
2953
|
+
/** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
|
|
2954
|
+
serviceTermsMap?: {
|
|
2955
|
+
[P in string]: GoogleCloudDiscoveryengineV1ProjectServiceTerms;
|
|
2956
|
+
};
|
|
2957
|
+
}
|
|
2958
|
+
interface GoogleCloudDiscoveryengineV1ProjectServiceTerms {
|
|
2959
|
+
/** The last time when the project agreed to the terms of service. */
|
|
2960
|
+
acceptTime?: string;
|
|
2961
|
+
/** The last time when the project declined or revoked the agreement to terms of service. */
|
|
2962
|
+
declineTime?: string;
|
|
2963
|
+
/** 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`. */
|
|
2964
|
+
id?: string;
|
|
2965
|
+
/** Whether the project has accepted/rejected the service terms or it is still pending. */
|
|
2966
|
+
state?: string;
|
|
2967
|
+
/** The version string of the terms of service. For acceptable values, see the comments for id above. */
|
|
2968
|
+
version?: string;
|
|
2969
|
+
}
|
|
2970
|
+
interface GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {}
|
|
2653
2971
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
2654
2972
|
/** Operation create time. */
|
|
2655
2973
|
createTime?: string;
|
|
@@ -3292,66 +3610,8 @@ declare namespace gapi.client {
|
|
|
3292
3610
|
documents: DocumentsResource;
|
|
3293
3611
|
operations: OperationsResource;
|
|
3294
3612
|
}
|
|
3295
|
-
interface
|
|
3296
|
-
/**
|
|
3297
|
-
converse(request: {
|
|
3298
|
-
/** V1 error format. */
|
|
3299
|
-
'$.xgafv'?: string;
|
|
3300
|
-
/** OAuth access token. */
|
|
3301
|
-
access_token?: string;
|
|
3302
|
-
/** Data format for response. */
|
|
3303
|
-
alt?: string;
|
|
3304
|
-
/** JSONP */
|
|
3305
|
-
callback?: string;
|
|
3306
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3307
|
-
fields?: string;
|
|
3308
|
-
/** 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. */
|
|
3309
|
-
key?: string;
|
|
3310
|
-
/** 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. */
|
|
3311
|
-
name: string;
|
|
3312
|
-
/** OAuth 2.0 token for the current user. */
|
|
3313
|
-
oauth_token?: string;
|
|
3314
|
-
/** Returns response with indentations and line breaks. */
|
|
3315
|
-
prettyPrint?: boolean;
|
|
3316
|
-
/** 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. */
|
|
3317
|
-
quotaUser?: string;
|
|
3318
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3319
|
-
upload_protocol?: string;
|
|
3320
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3321
|
-
uploadType?: string;
|
|
3322
|
-
/** Request body */
|
|
3323
|
-
resource: GoogleCloudDiscoveryengineV1betaConverseConversationRequest;
|
|
3324
|
-
}): Request<GoogleCloudDiscoveryengineV1betaConverseConversationResponse>;
|
|
3325
|
-
converse(
|
|
3326
|
-
request: {
|
|
3327
|
-
/** V1 error format. */
|
|
3328
|
-
'$.xgafv'?: string;
|
|
3329
|
-
/** OAuth access token. */
|
|
3330
|
-
access_token?: string;
|
|
3331
|
-
/** Data format for response. */
|
|
3332
|
-
alt?: string;
|
|
3333
|
-
/** JSONP */
|
|
3334
|
-
callback?: string;
|
|
3335
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3336
|
-
fields?: string;
|
|
3337
|
-
/** 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. */
|
|
3338
|
-
key?: string;
|
|
3339
|
-
/** 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. */
|
|
3340
|
-
name: string;
|
|
3341
|
-
/** OAuth 2.0 token for the current user. */
|
|
3342
|
-
oauth_token?: string;
|
|
3343
|
-
/** Returns response with indentations and line breaks. */
|
|
3344
|
-
prettyPrint?: boolean;
|
|
3345
|
-
/** 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. */
|
|
3346
|
-
quotaUser?: string;
|
|
3347
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3348
|
-
upload_protocol?: string;
|
|
3349
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3350
|
-
uploadType?: string;
|
|
3351
|
-
},
|
|
3352
|
-
body: GoogleCloudDiscoveryengineV1betaConverseConversationRequest
|
|
3353
|
-
): Request<GoogleCloudDiscoveryengineV1betaConverseConversationResponse>;
|
|
3354
|
-
/** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
|
|
3613
|
+
interface ControlsResource {
|
|
3614
|
+
/** 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. */
|
|
3355
3615
|
create(request: {
|
|
3356
3616
|
/** V1 error format. */
|
|
3357
3617
|
'$.xgafv'?: string;
|
|
@@ -3361,13 +3621,15 @@ declare namespace gapi.client {
|
|
|
3361
3621
|
alt?: string;
|
|
3362
3622
|
/** JSONP */
|
|
3363
3623
|
callback?: string;
|
|
3624
|
+
/** 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-_/. */
|
|
3625
|
+
controlId?: string;
|
|
3364
3626
|
/** Selector specifying which fields to include in a partial response. */
|
|
3365
3627
|
fields?: string;
|
|
3366
3628
|
/** 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. */
|
|
3367
3629
|
key?: string;
|
|
3368
3630
|
/** OAuth 2.0 token for the current user. */
|
|
3369
3631
|
oauth_token?: string;
|
|
3370
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
3632
|
+
/** 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}`. */
|
|
3371
3633
|
parent: string;
|
|
3372
3634
|
/** Returns response with indentations and line breaks. */
|
|
3373
3635
|
prettyPrint?: boolean;
|
|
@@ -3378,8 +3640,8 @@ declare namespace gapi.client {
|
|
|
3378
3640
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3379
3641
|
uploadType?: string;
|
|
3380
3642
|
/** Request body */
|
|
3381
|
-
resource:
|
|
3382
|
-
}): Request<
|
|
3643
|
+
resource: GoogleCloudDiscoveryengineV1betaControl;
|
|
3644
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
3383
3645
|
create(
|
|
3384
3646
|
request: {
|
|
3385
3647
|
/** V1 error format. */
|
|
@@ -3390,13 +3652,15 @@ declare namespace gapi.client {
|
|
|
3390
3652
|
alt?: string;
|
|
3391
3653
|
/** JSONP */
|
|
3392
3654
|
callback?: string;
|
|
3655
|
+
/** 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-_/. */
|
|
3656
|
+
controlId?: string;
|
|
3393
3657
|
/** Selector specifying which fields to include in a partial response. */
|
|
3394
3658
|
fields?: string;
|
|
3395
3659
|
/** 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. */
|
|
3396
3660
|
key?: string;
|
|
3397
3661
|
/** OAuth 2.0 token for the current user. */
|
|
3398
3662
|
oauth_token?: string;
|
|
3399
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
3663
|
+
/** 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}`. */
|
|
3400
3664
|
parent: string;
|
|
3401
3665
|
/** Returns response with indentations and line breaks. */
|
|
3402
3666
|
prettyPrint?: boolean;
|
|
@@ -3407,9 +3671,9 @@ declare namespace gapi.client {
|
|
|
3407
3671
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3408
3672
|
uploadType?: string;
|
|
3409
3673
|
},
|
|
3410
|
-
body:
|
|
3411
|
-
): Request<
|
|
3412
|
-
/** Deletes a
|
|
3674
|
+
body: GoogleCloudDiscoveryengineV1betaControl
|
|
3675
|
+
): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
3676
|
+
/** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
|
|
3413
3677
|
delete(request?: {
|
|
3414
3678
|
/** V1 error format. */
|
|
3415
3679
|
'$.xgafv'?: string;
|
|
@@ -3423,7 +3687,7 @@ declare namespace gapi.client {
|
|
|
3423
3687
|
fields?: string;
|
|
3424
3688
|
/** 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. */
|
|
3425
3689
|
key?: string;
|
|
3426
|
-
/** Required. The resource name of the
|
|
3690
|
+
/** 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}` */
|
|
3427
3691
|
name: string;
|
|
3428
3692
|
/** OAuth 2.0 token for the current user. */
|
|
3429
3693
|
oauth_token?: string;
|
|
@@ -3436,7 +3700,7 @@ declare namespace gapi.client {
|
|
|
3436
3700
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3437
3701
|
uploadType?: string;
|
|
3438
3702
|
}): Request<{}>;
|
|
3439
|
-
/** Gets a
|
|
3703
|
+
/** Gets a Control. */
|
|
3440
3704
|
get(request?: {
|
|
3441
3705
|
/** V1 error format. */
|
|
3442
3706
|
'$.xgafv'?: string;
|
|
@@ -3450,7 +3714,7 @@ declare namespace gapi.client {
|
|
|
3450
3714
|
fields?: string;
|
|
3451
3715
|
/** 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. */
|
|
3452
3716
|
key?: string;
|
|
3453
|
-
/** Required. The resource name of the
|
|
3717
|
+
/** 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}` */
|
|
3454
3718
|
name: string;
|
|
3455
3719
|
/** OAuth 2.0 token for the current user. */
|
|
3456
3720
|
oauth_token?: string;
|
|
@@ -3462,8 +3726,8 @@ declare namespace gapi.client {
|
|
|
3462
3726
|
upload_protocol?: string;
|
|
3463
3727
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3464
3728
|
uploadType?: string;
|
|
3465
|
-
}): Request<
|
|
3466
|
-
/** Lists all
|
|
3729
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
3730
|
+
/** Lists all Controls by their parent DataStore. */
|
|
3467
3731
|
list(request?: {
|
|
3468
3732
|
/** V1 error format. */
|
|
3469
3733
|
'$.xgafv'?: string;
|
|
@@ -3475,19 +3739,17 @@ declare namespace gapi.client {
|
|
|
3475
3739
|
callback?: string;
|
|
3476
3740
|
/** Selector specifying which fields to include in a partial response. */
|
|
3477
3741
|
fields?: string;
|
|
3478
|
-
/** A filter to apply on the list results.
|
|
3742
|
+
/** 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. */
|
|
3479
3743
|
filter?: string;
|
|
3480
3744
|
/** 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. */
|
|
3481
3745
|
key?: string;
|
|
3482
3746
|
/** OAuth 2.0 token for the current user. */
|
|
3483
3747
|
oauth_token?: string;
|
|
3484
|
-
/**
|
|
3485
|
-
orderBy?: string;
|
|
3486
|
-
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3748
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3487
3749
|
pageSize?: number;
|
|
3488
|
-
/** A page token, received from a previous `
|
|
3750
|
+
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
3489
3751
|
pageToken?: string;
|
|
3490
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
3752
|
+
/** 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}`. */
|
|
3491
3753
|
parent: string;
|
|
3492
3754
|
/** Returns response with indentations and line breaks. */
|
|
3493
3755
|
prettyPrint?: boolean;
|
|
@@ -3497,8 +3759,8 @@ declare namespace gapi.client {
|
|
|
3497
3759
|
upload_protocol?: string;
|
|
3498
3760
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3499
3761
|
uploadType?: string;
|
|
3500
|
-
}): Request<
|
|
3501
|
-
/** Updates a
|
|
3762
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListControlsResponse>;
|
|
3763
|
+
/** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
|
|
3502
3764
|
patch(request: {
|
|
3503
3765
|
/** V1 error format. */
|
|
3504
3766
|
'$.xgafv'?: string;
|
|
@@ -3512,7 +3774,7 @@ declare namespace gapi.client {
|
|
|
3512
3774
|
fields?: string;
|
|
3513
3775
|
/** 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. */
|
|
3514
3776
|
key?: string;
|
|
3515
|
-
/** Immutable. Fully qualified name `projects
|
|
3777
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
3516
3778
|
name: string;
|
|
3517
3779
|
/** OAuth 2.0 token for the current user. */
|
|
3518
3780
|
oauth_token?: string;
|
|
@@ -3520,15 +3782,15 @@ declare namespace gapi.client {
|
|
|
3520
3782
|
prettyPrint?: boolean;
|
|
3521
3783
|
/** 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. */
|
|
3522
3784
|
quotaUser?: string;
|
|
3523
|
-
/** Indicates which fields in the provided
|
|
3785
|
+
/** 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. */
|
|
3524
3786
|
updateMask?: string;
|
|
3525
3787
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3526
3788
|
upload_protocol?: string;
|
|
3527
3789
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3528
3790
|
uploadType?: string;
|
|
3529
3791
|
/** Request body */
|
|
3530
|
-
resource:
|
|
3531
|
-
}): Request<
|
|
3792
|
+
resource: GoogleCloudDiscoveryengineV1betaControl;
|
|
3793
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
3532
3794
|
patch(
|
|
3533
3795
|
request: {
|
|
3534
3796
|
/** V1 error format. */
|
|
@@ -3543,7 +3805,7 @@ declare namespace gapi.client {
|
|
|
3543
3805
|
fields?: string;
|
|
3544
3806
|
/** 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. */
|
|
3545
3807
|
key?: string;
|
|
3546
|
-
/** Immutable. Fully qualified name `projects
|
|
3808
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
3547
3809
|
name: string;
|
|
3548
3810
|
/** OAuth 2.0 token for the current user. */
|
|
3549
3811
|
oauth_token?: string;
|
|
@@ -3551,19 +3813,19 @@ declare namespace gapi.client {
|
|
|
3551
3813
|
prettyPrint?: boolean;
|
|
3552
3814
|
/** 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. */
|
|
3553
3815
|
quotaUser?: string;
|
|
3554
|
-
/** Indicates which fields in the provided
|
|
3816
|
+
/** 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. */
|
|
3555
3817
|
updateMask?: string;
|
|
3556
3818
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3557
3819
|
upload_protocol?: string;
|
|
3558
3820
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3559
3821
|
uploadType?: string;
|
|
3560
3822
|
},
|
|
3561
|
-
body:
|
|
3562
|
-
): Request<
|
|
3823
|
+
body: GoogleCloudDiscoveryengineV1betaControl
|
|
3824
|
+
): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
3563
3825
|
}
|
|
3564
|
-
interface
|
|
3565
|
-
/**
|
|
3566
|
-
|
|
3826
|
+
interface ConversationsResource {
|
|
3827
|
+
/** Converses a conversation. */
|
|
3828
|
+
converse(request: {
|
|
3567
3829
|
/** V1 error format. */
|
|
3568
3830
|
'$.xgafv'?: string;
|
|
3569
3831
|
/** OAuth access token. */
|
|
@@ -3572,12 +3834,12 @@ declare namespace gapi.client {
|
|
|
3572
3834
|
alt?: string;
|
|
3573
3835
|
/** JSONP */
|
|
3574
3836
|
callback?: string;
|
|
3575
|
-
/** Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */
|
|
3576
|
-
dataStore: string;
|
|
3577
3837
|
/** Selector specifying which fields to include in a partial response. */
|
|
3578
3838
|
fields?: string;
|
|
3579
3839
|
/** 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. */
|
|
3580
3840
|
key?: string;
|
|
3841
|
+
/** 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. */
|
|
3842
|
+
name: string;
|
|
3581
3843
|
/** OAuth 2.0 token for the current user. */
|
|
3582
3844
|
oauth_token?: string;
|
|
3583
3845
|
/** Returns response with indentations and line breaks. */
|
|
@@ -3588,21 +3850,290 @@ declare namespace gapi.client {
|
|
|
3588
3850
|
upload_protocol?: string;
|
|
3589
3851
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3590
3852
|
uploadType?: string;
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
|
-
|
|
3853
|
+
/** Request body */
|
|
3854
|
+
resource: GoogleCloudDiscoveryengineV1betaConverseConversationRequest;
|
|
3855
|
+
}): Request<GoogleCloudDiscoveryengineV1betaConverseConversationResponse>;
|
|
3856
|
+
converse(
|
|
3857
|
+
request: {
|
|
3858
|
+
/** V1 error format. */
|
|
3859
|
+
'$.xgafv'?: string;
|
|
3860
|
+
/** OAuth access token. */
|
|
3861
|
+
access_token?: string;
|
|
3862
|
+
/** Data format for response. */
|
|
3863
|
+
alt?: string;
|
|
3864
|
+
/** JSONP */
|
|
3865
|
+
callback?: string;
|
|
3866
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3867
|
+
fields?: string;
|
|
3868
|
+
/** 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. */
|
|
3869
|
+
key?: string;
|
|
3870
|
+
/** 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. */
|
|
3871
|
+
name: string;
|
|
3872
|
+
/** OAuth 2.0 token for the current user. */
|
|
3873
|
+
oauth_token?: string;
|
|
3874
|
+
/** Returns response with indentations and line breaks. */
|
|
3875
|
+
prettyPrint?: boolean;
|
|
3876
|
+
/** 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. */
|
|
3877
|
+
quotaUser?: string;
|
|
3878
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3879
|
+
upload_protocol?: string;
|
|
3880
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3881
|
+
uploadType?: string;
|
|
3882
|
+
},
|
|
3883
|
+
body: GoogleCloudDiscoveryengineV1betaConverseConversationRequest
|
|
3884
|
+
): Request<GoogleCloudDiscoveryengineV1betaConverseConversationResponse>;
|
|
3885
|
+
/** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
|
|
3886
|
+
create(request: {
|
|
3887
|
+
/** V1 error format. */
|
|
3888
|
+
'$.xgafv'?: string;
|
|
3889
|
+
/** OAuth access token. */
|
|
3890
|
+
access_token?: string;
|
|
3891
|
+
/** Data format for response. */
|
|
3892
|
+
alt?: string;
|
|
3893
|
+
/** JSONP */
|
|
3894
|
+
callback?: string;
|
|
3895
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3896
|
+
fields?: string;
|
|
3897
|
+
/** 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. */
|
|
3898
|
+
key?: string;
|
|
3899
|
+
/** OAuth 2.0 token for the current user. */
|
|
3900
|
+
oauth_token?: string;
|
|
3901
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
3902
|
+
parent: string;
|
|
3903
|
+
/** Returns response with indentations and line breaks. */
|
|
3904
|
+
prettyPrint?: boolean;
|
|
3905
|
+
/** 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. */
|
|
3906
|
+
quotaUser?: string;
|
|
3907
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3908
|
+
upload_protocol?: string;
|
|
3909
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3910
|
+
uploadType?: string;
|
|
3911
|
+
/** Request body */
|
|
3912
|
+
resource: GoogleCloudDiscoveryengineV1betaConversation;
|
|
3913
|
+
}): Request<GoogleCloudDiscoveryengineV1betaConversation>;
|
|
3914
|
+
create(
|
|
3915
|
+
request: {
|
|
3916
|
+
/** V1 error format. */
|
|
3917
|
+
'$.xgafv'?: string;
|
|
3918
|
+
/** OAuth access token. */
|
|
3919
|
+
access_token?: string;
|
|
3920
|
+
/** Data format for response. */
|
|
3921
|
+
alt?: string;
|
|
3922
|
+
/** JSONP */
|
|
3923
|
+
callback?: string;
|
|
3924
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3925
|
+
fields?: string;
|
|
3926
|
+
/** 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. */
|
|
3927
|
+
key?: string;
|
|
3928
|
+
/** OAuth 2.0 token for the current user. */
|
|
3929
|
+
oauth_token?: string;
|
|
3930
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
3931
|
+
parent: string;
|
|
3932
|
+
/** Returns response with indentations and line breaks. */
|
|
3933
|
+
prettyPrint?: boolean;
|
|
3934
|
+
/** 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. */
|
|
3935
|
+
quotaUser?: string;
|
|
3936
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3937
|
+
upload_protocol?: string;
|
|
3938
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3939
|
+
uploadType?: string;
|
|
3940
|
+
},
|
|
3941
|
+
body: GoogleCloudDiscoveryengineV1betaConversation
|
|
3942
|
+
): Request<GoogleCloudDiscoveryengineV1betaConversation>;
|
|
3943
|
+
/** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
|
|
3944
|
+
delete(request?: {
|
|
3945
|
+
/** V1 error format. */
|
|
3946
|
+
'$.xgafv'?: string;
|
|
3947
|
+
/** OAuth access token. */
|
|
3948
|
+
access_token?: string;
|
|
3949
|
+
/** Data format for response. */
|
|
3950
|
+
alt?: string;
|
|
3951
|
+
/** JSONP */
|
|
3952
|
+
callback?: string;
|
|
3953
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3954
|
+
fields?: string;
|
|
3955
|
+
/** 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. */
|
|
3956
|
+
key?: string;
|
|
3957
|
+
/** 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}` */
|
|
3958
|
+
name: string;
|
|
3959
|
+
/** OAuth 2.0 token for the current user. */
|
|
3960
|
+
oauth_token?: string;
|
|
3961
|
+
/** Returns response with indentations and line breaks. */
|
|
3962
|
+
prettyPrint?: boolean;
|
|
3963
|
+
/** 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. */
|
|
3964
|
+
quotaUser?: string;
|
|
3965
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3966
|
+
upload_protocol?: string;
|
|
3967
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3968
|
+
uploadType?: string;
|
|
3969
|
+
}): Request<{}>;
|
|
3970
|
+
/** Gets a Conversation. */
|
|
3971
|
+
get(request?: {
|
|
3972
|
+
/** V1 error format. */
|
|
3973
|
+
'$.xgafv'?: string;
|
|
3974
|
+
/** OAuth access token. */
|
|
3975
|
+
access_token?: string;
|
|
3976
|
+
/** Data format for response. */
|
|
3977
|
+
alt?: string;
|
|
3978
|
+
/** JSONP */
|
|
3979
|
+
callback?: string;
|
|
3980
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3981
|
+
fields?: string;
|
|
3982
|
+
/** 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. */
|
|
3983
|
+
key?: string;
|
|
3984
|
+
/** 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}` */
|
|
3985
|
+
name: string;
|
|
3986
|
+
/** OAuth 2.0 token for the current user. */
|
|
3987
|
+
oauth_token?: string;
|
|
3988
|
+
/** Returns response with indentations and line breaks. */
|
|
3989
|
+
prettyPrint?: boolean;
|
|
3990
|
+
/** 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. */
|
|
3991
|
+
quotaUser?: string;
|
|
3992
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3993
|
+
upload_protocol?: string;
|
|
3994
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3995
|
+
uploadType?: string;
|
|
3996
|
+
}): Request<GoogleCloudDiscoveryengineV1betaConversation>;
|
|
3997
|
+
/** Lists all Conversations by their parent DataStore. */
|
|
3998
|
+
list(request?: {
|
|
3999
|
+
/** V1 error format. */
|
|
4000
|
+
'$.xgafv'?: string;
|
|
4001
|
+
/** OAuth access token. */
|
|
4002
|
+
access_token?: string;
|
|
4003
|
+
/** Data format for response. */
|
|
4004
|
+
alt?: string;
|
|
4005
|
+
/** JSONP */
|
|
4006
|
+
callback?: string;
|
|
4007
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4008
|
+
fields?: string;
|
|
4009
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
4010
|
+
filter?: string;
|
|
4011
|
+
/** 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. */
|
|
4012
|
+
key?: string;
|
|
4013
|
+
/** OAuth 2.0 token for the current user. */
|
|
4014
|
+
oauth_token?: string;
|
|
4015
|
+
/** 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" */
|
|
4016
|
+
orderBy?: string;
|
|
4017
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
4018
|
+
pageSize?: number;
|
|
4019
|
+
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
4020
|
+
pageToken?: string;
|
|
4021
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4022
|
+
parent: string;
|
|
4023
|
+
/** Returns response with indentations and line breaks. */
|
|
4024
|
+
prettyPrint?: boolean;
|
|
4025
|
+
/** 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. */
|
|
4026
|
+
quotaUser?: string;
|
|
4027
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4028
|
+
upload_protocol?: string;
|
|
4029
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4030
|
+
uploadType?: string;
|
|
4031
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListConversationsResponse>;
|
|
4032
|
+
/** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
|
|
4033
|
+
patch(request: {
|
|
4034
|
+
/** V1 error format. */
|
|
4035
|
+
'$.xgafv'?: string;
|
|
4036
|
+
/** OAuth access token. */
|
|
4037
|
+
access_token?: string;
|
|
4038
|
+
/** Data format for response. */
|
|
4039
|
+
alt?: string;
|
|
4040
|
+
/** JSONP */
|
|
4041
|
+
callback?: string;
|
|
4042
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4043
|
+
fields?: string;
|
|
4044
|
+
/** 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. */
|
|
4045
|
+
key?: string;
|
|
4046
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
4047
|
+
name: string;
|
|
4048
|
+
/** OAuth 2.0 token for the current user. */
|
|
4049
|
+
oauth_token?: string;
|
|
4050
|
+
/** Returns response with indentations and line breaks. */
|
|
4051
|
+
prettyPrint?: boolean;
|
|
4052
|
+
/** 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. */
|
|
4053
|
+
quotaUser?: string;
|
|
4054
|
+
/** 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. */
|
|
4055
|
+
updateMask?: string;
|
|
4056
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4057
|
+
upload_protocol?: string;
|
|
4058
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4059
|
+
uploadType?: string;
|
|
4060
|
+
/** Request body */
|
|
4061
|
+
resource: GoogleCloudDiscoveryengineV1betaConversation;
|
|
4062
|
+
}): Request<GoogleCloudDiscoveryengineV1betaConversation>;
|
|
4063
|
+
patch(
|
|
4064
|
+
request: {
|
|
4065
|
+
/** V1 error format. */
|
|
4066
|
+
'$.xgafv'?: string;
|
|
4067
|
+
/** OAuth access token. */
|
|
4068
|
+
access_token?: string;
|
|
4069
|
+
/** Data format for response. */
|
|
4070
|
+
alt?: string;
|
|
4071
|
+
/** JSONP */
|
|
4072
|
+
callback?: string;
|
|
4073
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4074
|
+
fields?: string;
|
|
4075
|
+
/** 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. */
|
|
4076
|
+
key?: string;
|
|
4077
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
4078
|
+
name: string;
|
|
4079
|
+
/** OAuth 2.0 token for the current user. */
|
|
4080
|
+
oauth_token?: string;
|
|
4081
|
+
/** Returns response with indentations and line breaks. */
|
|
4082
|
+
prettyPrint?: boolean;
|
|
4083
|
+
/** 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. */
|
|
4084
|
+
quotaUser?: string;
|
|
4085
|
+
/** 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. */
|
|
4086
|
+
updateMask?: string;
|
|
4087
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4088
|
+
upload_protocol?: string;
|
|
4089
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4090
|
+
uploadType?: string;
|
|
4091
|
+
},
|
|
4092
|
+
body: GoogleCloudDiscoveryengineV1betaConversation
|
|
4093
|
+
): Request<GoogleCloudDiscoveryengineV1betaConversation>;
|
|
4094
|
+
}
|
|
4095
|
+
interface CustomModelsResource {
|
|
4096
|
+
/** Gets a list of all the custom models. */
|
|
4097
|
+
list(request?: {
|
|
4098
|
+
/** V1 error format. */
|
|
4099
|
+
'$.xgafv'?: string;
|
|
4100
|
+
/** OAuth access token. */
|
|
4101
|
+
access_token?: string;
|
|
4102
|
+
/** Data format for response. */
|
|
4103
|
+
alt?: string;
|
|
4104
|
+
/** JSONP */
|
|
4105
|
+
callback?: string;
|
|
4106
|
+
/** Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */
|
|
4107
|
+
dataStore: string;
|
|
4108
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4109
|
+
fields?: string;
|
|
4110
|
+
/** 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. */
|
|
4111
|
+
key?: string;
|
|
4112
|
+
/** OAuth 2.0 token for the current user. */
|
|
4113
|
+
oauth_token?: string;
|
|
4114
|
+
/** Returns response with indentations and line breaks. */
|
|
4115
|
+
prettyPrint?: boolean;
|
|
4116
|
+
/** 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. */
|
|
4117
|
+
quotaUser?: string;
|
|
4118
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4119
|
+
upload_protocol?: string;
|
|
4120
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4121
|
+
uploadType?: string;
|
|
4122
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListCustomModelsResponse>;
|
|
4123
|
+
}
|
|
4124
|
+
interface OperationsResource {
|
|
4125
|
+
/** 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. */
|
|
4126
|
+
get(request?: {
|
|
4127
|
+
/** V1 error format. */
|
|
4128
|
+
'$.xgafv'?: string;
|
|
4129
|
+
/** OAuth access token. */
|
|
4130
|
+
access_token?: string;
|
|
4131
|
+
/** Data format for response. */
|
|
4132
|
+
alt?: string;
|
|
4133
|
+
/** JSONP */
|
|
4134
|
+
callback?: string;
|
|
4135
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4136
|
+
fields?: string;
|
|
3606
4137
|
/** 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. */
|
|
3607
4138
|
key?: string;
|
|
3608
4139
|
/** The name of the operation resource. */
|
|
@@ -5417,6 +5948,8 @@ declare namespace gapi.client {
|
|
|
5417
5948
|
upload_protocol?: string;
|
|
5418
5949
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5419
5950
|
uploadType?: string;
|
|
5951
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
5952
|
+
writeAsync?: boolean;
|
|
5420
5953
|
/** Request body */
|
|
5421
5954
|
resource: GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
5422
5955
|
}): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
@@ -5446,6 +5979,8 @@ declare namespace gapi.client {
|
|
|
5446
5979
|
upload_protocol?: string;
|
|
5447
5980
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5448
5981
|
uploadType?: string;
|
|
5982
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
5983
|
+
writeAsync?: boolean;
|
|
5449
5984
|
},
|
|
5450
5985
|
body: GoogleCloudDiscoveryengineV1betaUserEvent
|
|
5451
5986
|
): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
@@ -5645,7 +6180,7 @@ declare namespace gapi.client {
|
|
|
5645
6180
|
callback?: string;
|
|
5646
6181
|
/** Selector specifying which fields to include in a partial response. */
|
|
5647
6182
|
fields?: string;
|
|
5648
|
-
/** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
6183
|
+
/** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
|
|
5649
6184
|
filter?: string;
|
|
5650
6185
|
/** 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. */
|
|
5651
6186
|
key?: string;
|
|
@@ -5755,9 +6290,232 @@ declare namespace gapi.client {
|
|
|
5755
6290
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5756
6291
|
uploadType?: string;
|
|
5757
6292
|
/** Request body */
|
|
5758
|
-
resource: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
|
|
5759
|
-
}): Request<GoogleLongrunningOperation>;
|
|
5760
|
-
trainCustomModel(
|
|
6293
|
+
resource: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
|
|
6294
|
+
}): Request<GoogleLongrunningOperation>;
|
|
6295
|
+
trainCustomModel(
|
|
6296
|
+
request: {
|
|
6297
|
+
/** V1 error format. */
|
|
6298
|
+
'$.xgafv'?: string;
|
|
6299
|
+
/** OAuth access token. */
|
|
6300
|
+
access_token?: string;
|
|
6301
|
+
/** Data format for response. */
|
|
6302
|
+
alt?: string;
|
|
6303
|
+
/** JSONP */
|
|
6304
|
+
callback?: string;
|
|
6305
|
+
/** Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
|
|
6306
|
+
dataStore: string;
|
|
6307
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6308
|
+
fields?: string;
|
|
6309
|
+
/** 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. */
|
|
6310
|
+
key?: string;
|
|
6311
|
+
/** OAuth 2.0 token for the current user. */
|
|
6312
|
+
oauth_token?: string;
|
|
6313
|
+
/** Returns response with indentations and line breaks. */
|
|
6314
|
+
prettyPrint?: boolean;
|
|
6315
|
+
/** 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. */
|
|
6316
|
+
quotaUser?: string;
|
|
6317
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6318
|
+
upload_protocol?: string;
|
|
6319
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6320
|
+
uploadType?: string;
|
|
6321
|
+
},
|
|
6322
|
+
body: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
|
|
6323
|
+
): Request<GoogleLongrunningOperation>;
|
|
6324
|
+
branches: BranchesResource;
|
|
6325
|
+
controls: ControlsResource;
|
|
6326
|
+
conversations: ConversationsResource;
|
|
6327
|
+
customModels: CustomModelsResource;
|
|
6328
|
+
models: ModelsResource;
|
|
6329
|
+
operations: OperationsResource;
|
|
6330
|
+
schemas: SchemasResource;
|
|
6331
|
+
servingConfigs: ServingConfigsResource;
|
|
6332
|
+
sessions: SessionsResource;
|
|
6333
|
+
siteSearchEngine: SiteSearchEngineResource;
|
|
6334
|
+
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
6335
|
+
userEvents: UserEventsResource;
|
|
6336
|
+
}
|
|
6337
|
+
interface ControlsResource {
|
|
6338
|
+
/** 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. */
|
|
6339
|
+
create(request: {
|
|
6340
|
+
/** V1 error format. */
|
|
6341
|
+
'$.xgafv'?: string;
|
|
6342
|
+
/** OAuth access token. */
|
|
6343
|
+
access_token?: string;
|
|
6344
|
+
/** Data format for response. */
|
|
6345
|
+
alt?: string;
|
|
6346
|
+
/** JSONP */
|
|
6347
|
+
callback?: string;
|
|
6348
|
+
/** 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-_/. */
|
|
6349
|
+
controlId?: string;
|
|
6350
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6351
|
+
fields?: string;
|
|
6352
|
+
/** 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. */
|
|
6353
|
+
key?: string;
|
|
6354
|
+
/** OAuth 2.0 token for the current user. */
|
|
6355
|
+
oauth_token?: string;
|
|
6356
|
+
/** 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}`. */
|
|
6357
|
+
parent: string;
|
|
6358
|
+
/** Returns response with indentations and line breaks. */
|
|
6359
|
+
prettyPrint?: boolean;
|
|
6360
|
+
/** 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. */
|
|
6361
|
+
quotaUser?: string;
|
|
6362
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6363
|
+
upload_protocol?: string;
|
|
6364
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6365
|
+
uploadType?: string;
|
|
6366
|
+
/** Request body */
|
|
6367
|
+
resource: GoogleCloudDiscoveryengineV1betaControl;
|
|
6368
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
6369
|
+
create(
|
|
6370
|
+
request: {
|
|
6371
|
+
/** V1 error format. */
|
|
6372
|
+
'$.xgafv'?: string;
|
|
6373
|
+
/** OAuth access token. */
|
|
6374
|
+
access_token?: string;
|
|
6375
|
+
/** Data format for response. */
|
|
6376
|
+
alt?: string;
|
|
6377
|
+
/** JSONP */
|
|
6378
|
+
callback?: string;
|
|
6379
|
+
/** 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-_/. */
|
|
6380
|
+
controlId?: string;
|
|
6381
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6382
|
+
fields?: string;
|
|
6383
|
+
/** 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. */
|
|
6384
|
+
key?: string;
|
|
6385
|
+
/** OAuth 2.0 token for the current user. */
|
|
6386
|
+
oauth_token?: string;
|
|
6387
|
+
/** 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}`. */
|
|
6388
|
+
parent: string;
|
|
6389
|
+
/** Returns response with indentations and line breaks. */
|
|
6390
|
+
prettyPrint?: boolean;
|
|
6391
|
+
/** 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. */
|
|
6392
|
+
quotaUser?: string;
|
|
6393
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6394
|
+
upload_protocol?: string;
|
|
6395
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6396
|
+
uploadType?: string;
|
|
6397
|
+
},
|
|
6398
|
+
body: GoogleCloudDiscoveryengineV1betaControl
|
|
6399
|
+
): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
6400
|
+
/** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
|
|
6401
|
+
delete(request?: {
|
|
6402
|
+
/** V1 error format. */
|
|
6403
|
+
'$.xgafv'?: string;
|
|
6404
|
+
/** OAuth access token. */
|
|
6405
|
+
access_token?: string;
|
|
6406
|
+
/** Data format for response. */
|
|
6407
|
+
alt?: string;
|
|
6408
|
+
/** JSONP */
|
|
6409
|
+
callback?: string;
|
|
6410
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6411
|
+
fields?: string;
|
|
6412
|
+
/** 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. */
|
|
6413
|
+
key?: string;
|
|
6414
|
+
/** 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}` */
|
|
6415
|
+
name: string;
|
|
6416
|
+
/** OAuth 2.0 token for the current user. */
|
|
6417
|
+
oauth_token?: string;
|
|
6418
|
+
/** Returns response with indentations and line breaks. */
|
|
6419
|
+
prettyPrint?: boolean;
|
|
6420
|
+
/** 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. */
|
|
6421
|
+
quotaUser?: string;
|
|
6422
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6423
|
+
upload_protocol?: string;
|
|
6424
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6425
|
+
uploadType?: string;
|
|
6426
|
+
}): Request<{}>;
|
|
6427
|
+
/** Gets a Control. */
|
|
6428
|
+
get(request?: {
|
|
6429
|
+
/** V1 error format. */
|
|
6430
|
+
'$.xgafv'?: string;
|
|
6431
|
+
/** OAuth access token. */
|
|
6432
|
+
access_token?: string;
|
|
6433
|
+
/** Data format for response. */
|
|
6434
|
+
alt?: string;
|
|
6435
|
+
/** JSONP */
|
|
6436
|
+
callback?: string;
|
|
6437
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6438
|
+
fields?: string;
|
|
6439
|
+
/** 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. */
|
|
6440
|
+
key?: string;
|
|
6441
|
+
/** 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}` */
|
|
6442
|
+
name: string;
|
|
6443
|
+
/** OAuth 2.0 token for the current user. */
|
|
6444
|
+
oauth_token?: string;
|
|
6445
|
+
/** Returns response with indentations and line breaks. */
|
|
6446
|
+
prettyPrint?: boolean;
|
|
6447
|
+
/** 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. */
|
|
6448
|
+
quotaUser?: string;
|
|
6449
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6450
|
+
upload_protocol?: string;
|
|
6451
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6452
|
+
uploadType?: string;
|
|
6453
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
6454
|
+
/** Lists all Controls by their parent DataStore. */
|
|
6455
|
+
list(request?: {
|
|
6456
|
+
/** V1 error format. */
|
|
6457
|
+
'$.xgafv'?: string;
|
|
6458
|
+
/** OAuth access token. */
|
|
6459
|
+
access_token?: string;
|
|
6460
|
+
/** Data format for response. */
|
|
6461
|
+
alt?: string;
|
|
6462
|
+
/** JSONP */
|
|
6463
|
+
callback?: string;
|
|
6464
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6465
|
+
fields?: string;
|
|
6466
|
+
/** 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. */
|
|
6467
|
+
filter?: string;
|
|
6468
|
+
/** 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. */
|
|
6469
|
+
key?: string;
|
|
6470
|
+
/** OAuth 2.0 token for the current user. */
|
|
6471
|
+
oauth_token?: string;
|
|
6472
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
6473
|
+
pageSize?: number;
|
|
6474
|
+
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
6475
|
+
pageToken?: string;
|
|
6476
|
+
/** 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}`. */
|
|
6477
|
+
parent: string;
|
|
6478
|
+
/** Returns response with indentations and line breaks. */
|
|
6479
|
+
prettyPrint?: boolean;
|
|
6480
|
+
/** 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. */
|
|
6481
|
+
quotaUser?: string;
|
|
6482
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6483
|
+
upload_protocol?: string;
|
|
6484
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6485
|
+
uploadType?: string;
|
|
6486
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListControlsResponse>;
|
|
6487
|
+
/** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
|
|
6488
|
+
patch(request: {
|
|
6489
|
+
/** V1 error format. */
|
|
6490
|
+
'$.xgafv'?: string;
|
|
6491
|
+
/** OAuth access token. */
|
|
6492
|
+
access_token?: string;
|
|
6493
|
+
/** Data format for response. */
|
|
6494
|
+
alt?: string;
|
|
6495
|
+
/** JSONP */
|
|
6496
|
+
callback?: string;
|
|
6497
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6498
|
+
fields?: string;
|
|
6499
|
+
/** 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. */
|
|
6500
|
+
key?: string;
|
|
6501
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
6502
|
+
name: string;
|
|
6503
|
+
/** OAuth 2.0 token for the current user. */
|
|
6504
|
+
oauth_token?: string;
|
|
6505
|
+
/** Returns response with indentations and line breaks. */
|
|
6506
|
+
prettyPrint?: boolean;
|
|
6507
|
+
/** 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. */
|
|
6508
|
+
quotaUser?: string;
|
|
6509
|
+
/** 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. */
|
|
6510
|
+
updateMask?: string;
|
|
6511
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6512
|
+
upload_protocol?: string;
|
|
6513
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6514
|
+
uploadType?: string;
|
|
6515
|
+
/** Request body */
|
|
6516
|
+
resource: GoogleCloudDiscoveryengineV1betaControl;
|
|
6517
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
6518
|
+
patch(
|
|
5761
6519
|
request: {
|
|
5762
6520
|
/** V1 error format. */
|
|
5763
6521
|
'$.xgafv'?: string;
|
|
@@ -5767,36 +6525,27 @@ declare namespace gapi.client {
|
|
|
5767
6525
|
alt?: string;
|
|
5768
6526
|
/** JSONP */
|
|
5769
6527
|
callback?: string;
|
|
5770
|
-
/** Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
|
|
5771
|
-
dataStore: string;
|
|
5772
6528
|
/** Selector specifying which fields to include in a partial response. */
|
|
5773
6529
|
fields?: string;
|
|
5774
6530
|
/** 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. */
|
|
5775
6531
|
key?: string;
|
|
6532
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
6533
|
+
name: string;
|
|
5776
6534
|
/** OAuth 2.0 token for the current user. */
|
|
5777
6535
|
oauth_token?: string;
|
|
5778
6536
|
/** Returns response with indentations and line breaks. */
|
|
5779
6537
|
prettyPrint?: boolean;
|
|
5780
6538
|
/** 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. */
|
|
5781
6539
|
quotaUser?: string;
|
|
6540
|
+
/** 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. */
|
|
6541
|
+
updateMask?: string;
|
|
5782
6542
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5783
6543
|
upload_protocol?: string;
|
|
5784
6544
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5785
6545
|
uploadType?: string;
|
|
5786
6546
|
},
|
|
5787
|
-
body:
|
|
5788
|
-
): Request<
|
|
5789
|
-
branches: BranchesResource;
|
|
5790
|
-
conversations: ConversationsResource;
|
|
5791
|
-
customModels: CustomModelsResource;
|
|
5792
|
-
models: ModelsResource;
|
|
5793
|
-
operations: OperationsResource;
|
|
5794
|
-
schemas: SchemasResource;
|
|
5795
|
-
servingConfigs: ServingConfigsResource;
|
|
5796
|
-
sessions: SessionsResource;
|
|
5797
|
-
siteSearchEngine: SiteSearchEngineResource;
|
|
5798
|
-
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
5799
|
-
userEvents: UserEventsResource;
|
|
6547
|
+
body: GoogleCloudDiscoveryengineV1betaControl
|
|
6548
|
+
): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
5800
6549
|
}
|
|
5801
6550
|
interface ConversationsResource {
|
|
5802
6551
|
/** Converses a conversation. */
|
|
@@ -7052,6 +7801,7 @@ declare namespace gapi.client {
|
|
|
7052
7801
|
},
|
|
7053
7802
|
body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest
|
|
7054
7803
|
): Request<GoogleLongrunningOperation>;
|
|
7804
|
+
controls: ControlsResource;
|
|
7055
7805
|
conversations: ConversationsResource;
|
|
7056
7806
|
operations: OperationsResource;
|
|
7057
7807
|
servingConfigs: ServingConfigsResource;
|
|
@@ -7580,6 +8330,219 @@ declare namespace gapi.client {
|
|
|
7580
8330
|
documents: DocumentsResource;
|
|
7581
8331
|
operations: OperationsResource;
|
|
7582
8332
|
}
|
|
8333
|
+
interface ControlsResource {
|
|
8334
|
+
/** 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. */
|
|
8335
|
+
create(request: {
|
|
8336
|
+
/** V1 error format. */
|
|
8337
|
+
'$.xgafv'?: string;
|
|
8338
|
+
/** OAuth access token. */
|
|
8339
|
+
access_token?: string;
|
|
8340
|
+
/** Data format for response. */
|
|
8341
|
+
alt?: string;
|
|
8342
|
+
/** JSONP */
|
|
8343
|
+
callback?: string;
|
|
8344
|
+
/** 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-_/. */
|
|
8345
|
+
controlId?: string;
|
|
8346
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8347
|
+
fields?: string;
|
|
8348
|
+
/** 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. */
|
|
8349
|
+
key?: string;
|
|
8350
|
+
/** OAuth 2.0 token for the current user. */
|
|
8351
|
+
oauth_token?: string;
|
|
8352
|
+
/** 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}`. */
|
|
8353
|
+
parent: string;
|
|
8354
|
+
/** Returns response with indentations and line breaks. */
|
|
8355
|
+
prettyPrint?: boolean;
|
|
8356
|
+
/** 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. */
|
|
8357
|
+
quotaUser?: string;
|
|
8358
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8359
|
+
upload_protocol?: string;
|
|
8360
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8361
|
+
uploadType?: string;
|
|
8362
|
+
/** Request body */
|
|
8363
|
+
resource: GoogleCloudDiscoveryengineV1betaControl;
|
|
8364
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
8365
|
+
create(
|
|
8366
|
+
request: {
|
|
8367
|
+
/** V1 error format. */
|
|
8368
|
+
'$.xgafv'?: string;
|
|
8369
|
+
/** OAuth access token. */
|
|
8370
|
+
access_token?: string;
|
|
8371
|
+
/** Data format for response. */
|
|
8372
|
+
alt?: string;
|
|
8373
|
+
/** JSONP */
|
|
8374
|
+
callback?: string;
|
|
8375
|
+
/** 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-_/. */
|
|
8376
|
+
controlId?: string;
|
|
8377
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8378
|
+
fields?: string;
|
|
8379
|
+
/** 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. */
|
|
8380
|
+
key?: string;
|
|
8381
|
+
/** OAuth 2.0 token for the current user. */
|
|
8382
|
+
oauth_token?: string;
|
|
8383
|
+
/** 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}`. */
|
|
8384
|
+
parent: string;
|
|
8385
|
+
/** Returns response with indentations and line breaks. */
|
|
8386
|
+
prettyPrint?: boolean;
|
|
8387
|
+
/** 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. */
|
|
8388
|
+
quotaUser?: string;
|
|
8389
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8390
|
+
upload_protocol?: string;
|
|
8391
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8392
|
+
uploadType?: string;
|
|
8393
|
+
},
|
|
8394
|
+
body: GoogleCloudDiscoveryengineV1betaControl
|
|
8395
|
+
): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
8396
|
+
/** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
|
|
8397
|
+
delete(request?: {
|
|
8398
|
+
/** V1 error format. */
|
|
8399
|
+
'$.xgafv'?: string;
|
|
8400
|
+
/** OAuth access token. */
|
|
8401
|
+
access_token?: string;
|
|
8402
|
+
/** Data format for response. */
|
|
8403
|
+
alt?: string;
|
|
8404
|
+
/** JSONP */
|
|
8405
|
+
callback?: string;
|
|
8406
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8407
|
+
fields?: string;
|
|
8408
|
+
/** 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. */
|
|
8409
|
+
key?: string;
|
|
8410
|
+
/** 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}` */
|
|
8411
|
+
name: string;
|
|
8412
|
+
/** OAuth 2.0 token for the current user. */
|
|
8413
|
+
oauth_token?: string;
|
|
8414
|
+
/** Returns response with indentations and line breaks. */
|
|
8415
|
+
prettyPrint?: boolean;
|
|
8416
|
+
/** 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. */
|
|
8417
|
+
quotaUser?: string;
|
|
8418
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8419
|
+
upload_protocol?: string;
|
|
8420
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8421
|
+
uploadType?: string;
|
|
8422
|
+
}): Request<{}>;
|
|
8423
|
+
/** Gets a Control. */
|
|
8424
|
+
get(request?: {
|
|
8425
|
+
/** V1 error format. */
|
|
8426
|
+
'$.xgafv'?: string;
|
|
8427
|
+
/** OAuth access token. */
|
|
8428
|
+
access_token?: string;
|
|
8429
|
+
/** Data format for response. */
|
|
8430
|
+
alt?: string;
|
|
8431
|
+
/** JSONP */
|
|
8432
|
+
callback?: string;
|
|
8433
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8434
|
+
fields?: string;
|
|
8435
|
+
/** 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. */
|
|
8436
|
+
key?: string;
|
|
8437
|
+
/** 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}` */
|
|
8438
|
+
name: string;
|
|
8439
|
+
/** OAuth 2.0 token for the current user. */
|
|
8440
|
+
oauth_token?: string;
|
|
8441
|
+
/** Returns response with indentations and line breaks. */
|
|
8442
|
+
prettyPrint?: boolean;
|
|
8443
|
+
/** 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. */
|
|
8444
|
+
quotaUser?: string;
|
|
8445
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8446
|
+
upload_protocol?: string;
|
|
8447
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8448
|
+
uploadType?: string;
|
|
8449
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
8450
|
+
/** Lists all Controls by their parent DataStore. */
|
|
8451
|
+
list(request?: {
|
|
8452
|
+
/** V1 error format. */
|
|
8453
|
+
'$.xgafv'?: string;
|
|
8454
|
+
/** OAuth access token. */
|
|
8455
|
+
access_token?: string;
|
|
8456
|
+
/** Data format for response. */
|
|
8457
|
+
alt?: string;
|
|
8458
|
+
/** JSONP */
|
|
8459
|
+
callback?: string;
|
|
8460
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8461
|
+
fields?: string;
|
|
8462
|
+
/** 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. */
|
|
8463
|
+
filter?: string;
|
|
8464
|
+
/** 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. */
|
|
8465
|
+
key?: string;
|
|
8466
|
+
/** OAuth 2.0 token for the current user. */
|
|
8467
|
+
oauth_token?: string;
|
|
8468
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
8469
|
+
pageSize?: number;
|
|
8470
|
+
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
8471
|
+
pageToken?: string;
|
|
8472
|
+
/** 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}`. */
|
|
8473
|
+
parent: string;
|
|
8474
|
+
/** Returns response with indentations and line breaks. */
|
|
8475
|
+
prettyPrint?: boolean;
|
|
8476
|
+
/** 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. */
|
|
8477
|
+
quotaUser?: string;
|
|
8478
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8479
|
+
upload_protocol?: string;
|
|
8480
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8481
|
+
uploadType?: string;
|
|
8482
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListControlsResponse>;
|
|
8483
|
+
/** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
|
|
8484
|
+
patch(request: {
|
|
8485
|
+
/** V1 error format. */
|
|
8486
|
+
'$.xgafv'?: string;
|
|
8487
|
+
/** OAuth access token. */
|
|
8488
|
+
access_token?: string;
|
|
8489
|
+
/** Data format for response. */
|
|
8490
|
+
alt?: string;
|
|
8491
|
+
/** JSONP */
|
|
8492
|
+
callback?: string;
|
|
8493
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8494
|
+
fields?: string;
|
|
8495
|
+
/** 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. */
|
|
8496
|
+
key?: string;
|
|
8497
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
8498
|
+
name: string;
|
|
8499
|
+
/** OAuth 2.0 token for the current user. */
|
|
8500
|
+
oauth_token?: string;
|
|
8501
|
+
/** Returns response with indentations and line breaks. */
|
|
8502
|
+
prettyPrint?: boolean;
|
|
8503
|
+
/** 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. */
|
|
8504
|
+
quotaUser?: string;
|
|
8505
|
+
/** 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. */
|
|
8506
|
+
updateMask?: string;
|
|
8507
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8508
|
+
upload_protocol?: string;
|
|
8509
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8510
|
+
uploadType?: string;
|
|
8511
|
+
/** Request body */
|
|
8512
|
+
resource: GoogleCloudDiscoveryengineV1betaControl;
|
|
8513
|
+
}): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
8514
|
+
patch(
|
|
8515
|
+
request: {
|
|
8516
|
+
/** V1 error format. */
|
|
8517
|
+
'$.xgafv'?: string;
|
|
8518
|
+
/** OAuth access token. */
|
|
8519
|
+
access_token?: string;
|
|
8520
|
+
/** Data format for response. */
|
|
8521
|
+
alt?: string;
|
|
8522
|
+
/** JSONP */
|
|
8523
|
+
callback?: string;
|
|
8524
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8525
|
+
fields?: string;
|
|
8526
|
+
/** 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. */
|
|
8527
|
+
key?: string;
|
|
8528
|
+
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
8529
|
+
name: string;
|
|
8530
|
+
/** OAuth 2.0 token for the current user. */
|
|
8531
|
+
oauth_token?: string;
|
|
8532
|
+
/** Returns response with indentations and line breaks. */
|
|
8533
|
+
prettyPrint?: boolean;
|
|
8534
|
+
/** 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. */
|
|
8535
|
+
quotaUser?: string;
|
|
8536
|
+
/** 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. */
|
|
8537
|
+
updateMask?: string;
|
|
8538
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8539
|
+
upload_protocol?: string;
|
|
8540
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8541
|
+
uploadType?: string;
|
|
8542
|
+
},
|
|
8543
|
+
body: GoogleCloudDiscoveryengineV1betaControl
|
|
8544
|
+
): Request<GoogleCloudDiscoveryengineV1betaControl>;
|
|
8545
|
+
}
|
|
7583
8546
|
interface ConversationsResource {
|
|
7584
8547
|
/** Converses a conversation. */
|
|
7585
8548
|
converse(request: {
|
|
@@ -9398,6 +10361,8 @@ declare namespace gapi.client {
|
|
|
9398
10361
|
upload_protocol?: string;
|
|
9399
10362
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9400
10363
|
uploadType?: string;
|
|
10364
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
10365
|
+
writeAsync?: boolean;
|
|
9401
10366
|
/** Request body */
|
|
9402
10367
|
resource: GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
9403
10368
|
}): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
@@ -9427,6 +10392,8 @@ declare namespace gapi.client {
|
|
|
9427
10392
|
upload_protocol?: string;
|
|
9428
10393
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9429
10394
|
uploadType?: string;
|
|
10395
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
10396
|
+
writeAsync?: boolean;
|
|
9430
10397
|
},
|
|
9431
10398
|
body: GoogleCloudDiscoveryengineV1betaUserEvent
|
|
9432
10399
|
): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
@@ -9626,7 +10593,7 @@ declare namespace gapi.client {
|
|
|
9626
10593
|
callback?: string;
|
|
9627
10594
|
/** Selector specifying which fields to include in a partial response. */
|
|
9628
10595
|
fields?: string;
|
|
9629
|
-
/** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
10596
|
+
/** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
|
|
9630
10597
|
filter?: string;
|
|
9631
10598
|
/** 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. */
|
|
9632
10599
|
key?: string;
|
|
@@ -9710,6 +10677,7 @@ declare namespace gapi.client {
|
|
|
9710
10677
|
body: GoogleCloudDiscoveryengineV1betaDataStore
|
|
9711
10678
|
): Request<GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
9712
10679
|
branches: BranchesResource;
|
|
10680
|
+
controls: ControlsResource;
|
|
9713
10681
|
conversations: ConversationsResource;
|
|
9714
10682
|
models: ModelsResource;
|
|
9715
10683
|
operations: OperationsResource;
|
|
@@ -9929,6 +10897,8 @@ declare namespace gapi.client {
|
|
|
9929
10897
|
upload_protocol?: string;
|
|
9930
10898
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9931
10899
|
uploadType?: string;
|
|
10900
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
10901
|
+
writeAsync?: boolean;
|
|
9932
10902
|
/** Request body */
|
|
9933
10903
|
resource: GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
9934
10904
|
}): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
@@ -9958,6 +10928,8 @@ declare namespace gapi.client {
|
|
|
9958
10928
|
upload_protocol?: string;
|
|
9959
10929
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9960
10930
|
uploadType?: string;
|
|
10931
|
+
/** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
|
|
10932
|
+
writeAsync?: boolean;
|
|
9961
10933
|
},
|
|
9962
10934
|
body: GoogleCloudDiscoveryengineV1betaUserEvent
|
|
9963
10935
|
): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
@@ -10033,6 +11005,64 @@ declare namespace gapi.client {
|
|
|
10033
11005
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
10034
11006
|
}
|
|
10035
11007
|
interface ProjectsResource {
|
|
11008
|
+
/** 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. */
|
|
11009
|
+
provision(request: {
|
|
11010
|
+
/** V1 error format. */
|
|
11011
|
+
'$.xgafv'?: string;
|
|
11012
|
+
/** OAuth access token. */
|
|
11013
|
+
access_token?: string;
|
|
11014
|
+
/** Data format for response. */
|
|
11015
|
+
alt?: string;
|
|
11016
|
+
/** JSONP */
|
|
11017
|
+
callback?: string;
|
|
11018
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11019
|
+
fields?: string;
|
|
11020
|
+
/** 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. */
|
|
11021
|
+
key?: string;
|
|
11022
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
11023
|
+
name: string;
|
|
11024
|
+
/** OAuth 2.0 token for the current user. */
|
|
11025
|
+
oauth_token?: string;
|
|
11026
|
+
/** Returns response with indentations and line breaks. */
|
|
11027
|
+
prettyPrint?: boolean;
|
|
11028
|
+
/** 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. */
|
|
11029
|
+
quotaUser?: string;
|
|
11030
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11031
|
+
upload_protocol?: string;
|
|
11032
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11033
|
+
uploadType?: string;
|
|
11034
|
+
/** Request body */
|
|
11035
|
+
resource: GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
|
|
11036
|
+
}): Request<GoogleLongrunningOperation>;
|
|
11037
|
+
provision(
|
|
11038
|
+
request: {
|
|
11039
|
+
/** V1 error format. */
|
|
11040
|
+
'$.xgafv'?: string;
|
|
11041
|
+
/** OAuth access token. */
|
|
11042
|
+
access_token?: string;
|
|
11043
|
+
/** Data format for response. */
|
|
11044
|
+
alt?: string;
|
|
11045
|
+
/** JSONP */
|
|
11046
|
+
callback?: string;
|
|
11047
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11048
|
+
fields?: string;
|
|
11049
|
+
/** 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. */
|
|
11050
|
+
key?: string;
|
|
11051
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
11052
|
+
name: string;
|
|
11053
|
+
/** OAuth 2.0 token for the current user. */
|
|
11054
|
+
oauth_token?: string;
|
|
11055
|
+
/** Returns response with indentations and line breaks. */
|
|
11056
|
+
prettyPrint?: boolean;
|
|
11057
|
+
/** 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. */
|
|
11058
|
+
quotaUser?: string;
|
|
11059
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11060
|
+
upload_protocol?: string;
|
|
11061
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11062
|
+
uploadType?: string;
|
|
11063
|
+
},
|
|
11064
|
+
body: GoogleCloudDiscoveryengineV1betaProvisionProjectRequest
|
|
11065
|
+
): Request<GoogleLongrunningOperation>;
|
|
10036
11066
|
locations: LocationsResource;
|
|
10037
11067
|
operations: OperationsResource;
|
|
10038
11068
|
}
|