@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230807 → 0.0.20230814
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 +2984 -477
- package/package.json +1 -1
- package/tests.ts +707 -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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230814
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -136,6 +136,28 @@ declare namespace gapi.client {
|
|
|
136
136
|
tableId?:
|
|
137
137
|
string;
|
|
138
138
|
}
|
|
139
|
+
interface GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse {
|
|
140
|
+
/** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
|
|
141
|
+
querySuggestions?:
|
|
142
|
+
GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion[];
|
|
143
|
+
/**
|
|
144
|
+
* True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions
|
|
145
|
+
* that match the full query.
|
|
146
|
+
*/
|
|
147
|
+
tailMatchTriggered?:
|
|
148
|
+
boolean;
|
|
149
|
+
}
|
|
150
|
+
interface GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion {
|
|
151
|
+
/**
|
|
152
|
+
* The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable
|
|
153
|
+
* model.
|
|
154
|
+
*/
|
|
155
|
+
completableFieldPath?:
|
|
156
|
+
string[];
|
|
157
|
+
/** The suggestion for the query. */
|
|
158
|
+
suggestion?:
|
|
159
|
+
string;
|
|
160
|
+
}
|
|
139
161
|
interface GoogleCloudDiscoveryengineV1alphaCompletionInfo {
|
|
140
162
|
/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */
|
|
141
163
|
selectedPosition?:
|
|
@@ -144,6 +166,94 @@ declare namespace gapi.client {
|
|
|
144
166
|
selectedSuggestion?:
|
|
145
167
|
string;
|
|
146
168
|
}
|
|
169
|
+
interface GoogleCloudDiscoveryengineV1alphaConversation {
|
|
170
|
+
/** Output only. The time the conversation finished. */
|
|
171
|
+
endTime?:
|
|
172
|
+
string;
|
|
173
|
+
/** Conversation messages. */
|
|
174
|
+
messages?:
|
|
175
|
+
GoogleCloudDiscoveryengineV1alphaConversationMessage[];
|
|
176
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` */
|
|
177
|
+
name?:
|
|
178
|
+
string;
|
|
179
|
+
/** Output only. The time the conversation started. */
|
|
180
|
+
startTime?:
|
|
181
|
+
string;
|
|
182
|
+
/** The state of the Conversation. */
|
|
183
|
+
state?:
|
|
184
|
+
string;
|
|
185
|
+
/** A unique identifier for tracking users. */
|
|
186
|
+
userPseudoId?:
|
|
187
|
+
string;
|
|
188
|
+
}
|
|
189
|
+
interface GoogleCloudDiscoveryengineV1alphaConversationContext {
|
|
190
|
+
/** The current active document the user opened. It contains the document resource reference. */
|
|
191
|
+
activeDocument?:
|
|
192
|
+
string;
|
|
193
|
+
/** The current list of documents the user is seeing. It contains the document resource references. */
|
|
194
|
+
contextDocuments?:
|
|
195
|
+
string[];
|
|
196
|
+
}
|
|
197
|
+
interface GoogleCloudDiscoveryengineV1alphaConversationMessage {
|
|
198
|
+
/** Output only. Message creation timestamp. */
|
|
199
|
+
createTime?:
|
|
200
|
+
string;
|
|
201
|
+
/** Search reply. */
|
|
202
|
+
reply?:
|
|
203
|
+
GoogleCloudDiscoveryengineV1alphaReply;
|
|
204
|
+
/** User text input. */
|
|
205
|
+
userInput?:
|
|
206
|
+
GoogleCloudDiscoveryengineV1alphaTextInput;
|
|
207
|
+
}
|
|
208
|
+
interface GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
|
|
209
|
+
/** The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. */
|
|
210
|
+
conversation?:
|
|
211
|
+
GoogleCloudDiscoveryengineV1alphaConversation;
|
|
212
|
+
/** Required. Current user input. */
|
|
213
|
+
query?:
|
|
214
|
+
GoogleCloudDiscoveryengineV1alphaTextInput;
|
|
215
|
+
/** Whether to turn on safe search. */
|
|
216
|
+
safeSearch?:
|
|
217
|
+
boolean;
|
|
218
|
+
/**
|
|
219
|
+
* The resource name of the Serving Config to use. Format:
|
|
220
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving
|
|
221
|
+
* config will be used.
|
|
222
|
+
*/
|
|
223
|
+
servingConfig?:
|
|
224
|
+
string;
|
|
225
|
+
/**
|
|
226
|
+
* 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. *
|
|
227
|
+
* 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
|
|
228
|
+
* 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
|
|
229
|
+
* 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
|
|
230
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
231
|
+
*/
|
|
232
|
+
userLabels?:
|
|
233
|
+
{ [P in string]: string };
|
|
234
|
+
}
|
|
235
|
+
interface GoogleCloudDiscoveryengineV1alphaConverseConversationResponse {
|
|
236
|
+
/** Updated conversation including the answer. */
|
|
237
|
+
conversation?:
|
|
238
|
+
GoogleCloudDiscoveryengineV1alphaConversation;
|
|
239
|
+
/** Suggested related questions. */
|
|
240
|
+
relatedQuestions?:
|
|
241
|
+
string[];
|
|
242
|
+
/** Answer to the current query. */
|
|
243
|
+
reply?:
|
|
244
|
+
GoogleCloudDiscoveryengineV1alphaReply;
|
|
245
|
+
/** Search Results. */
|
|
246
|
+
searchResults?:
|
|
247
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
|
|
248
|
+
}
|
|
249
|
+
interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
|
|
250
|
+
/** Operation create time. */
|
|
251
|
+
createTime?:
|
|
252
|
+
string;
|
|
253
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
254
|
+
updateTime?:
|
|
255
|
+
string;
|
|
256
|
+
}
|
|
147
257
|
interface GoogleCloudDiscoveryengineV1alphaCustomAttribute {
|
|
148
258
|
/**
|
|
149
259
|
* The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set.
|
|
@@ -158,7 +268,21 @@ declare namespace gapi.client {
|
|
|
158
268
|
text?:
|
|
159
269
|
string[];
|
|
160
270
|
}
|
|
271
|
+
interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
|
|
272
|
+
/** Operation create time. */
|
|
273
|
+
createTime?:
|
|
274
|
+
string;
|
|
275
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
276
|
+
updateTime?:
|
|
277
|
+
string;
|
|
278
|
+
}
|
|
161
279
|
interface GoogleCloudDiscoveryengineV1alphaDocument {
|
|
280
|
+
/** The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */
|
|
281
|
+
content?:
|
|
282
|
+
GoogleCloudDiscoveryengineV1alphaDocumentContent;
|
|
283
|
+
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
284
|
+
derivedStructData?:
|
|
285
|
+
{ [P in string]: any };
|
|
162
286
|
/** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
|
|
163
287
|
id?:
|
|
164
288
|
string;
|
|
@@ -185,6 +309,25 @@ declare namespace gapi.client {
|
|
|
185
309
|
structData?:
|
|
186
310
|
{ [P in string]: any };
|
|
187
311
|
}
|
|
312
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentContent {
|
|
313
|
+
/**
|
|
314
|
+
* The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) *
|
|
315
|
+
* `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain`
|
|
316
|
+
* (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
|
|
317
|
+
*/
|
|
318
|
+
mimeType?:
|
|
319
|
+
string;
|
|
320
|
+
/**
|
|
321
|
+
* The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in
|
|
322
|
+
* Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
|
|
323
|
+
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
324
|
+
*/
|
|
325
|
+
rawBytes?:
|
|
326
|
+
string;
|
|
327
|
+
/** The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 100 MB. */
|
|
328
|
+
uri?:
|
|
329
|
+
string;
|
|
330
|
+
}
|
|
188
331
|
interface GoogleCloudDiscoveryengineV1alphaDocumentInfo {
|
|
189
332
|
/** The Document resource ID. */
|
|
190
333
|
id?:
|
|
@@ -208,6 +351,71 @@ declare namespace gapi.client {
|
|
|
208
351
|
uri?:
|
|
209
352
|
string;
|
|
210
353
|
}
|
|
354
|
+
interface GoogleCloudDiscoveryengineV1alphaDoubleList {
|
|
355
|
+
/** Double values. */
|
|
356
|
+
values?:
|
|
357
|
+
number[];
|
|
358
|
+
}
|
|
359
|
+
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
360
|
+
/**
|
|
361
|
+
* If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option
|
|
362
|
+
* is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not
|
|
363
|
+
* support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
|
|
364
|
+
*/
|
|
365
|
+
completableOption?:
|
|
366
|
+
string;
|
|
367
|
+
/**
|
|
368
|
+
* If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is
|
|
369
|
+
* INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for
|
|
370
|
+
* fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip
|
|
371
|
+
* dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
|
|
372
|
+
*/
|
|
373
|
+
dynamicFacetableOption?:
|
|
374
|
+
string;
|
|
375
|
+
/** Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. */
|
|
376
|
+
fieldPath?:
|
|
377
|
+
string;
|
|
378
|
+
/** Output only. Raw type of the field. */
|
|
379
|
+
fieldType?:
|
|
380
|
+
string;
|
|
381
|
+
/**
|
|
382
|
+
* If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior
|
|
383
|
+
* defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and
|
|
384
|
+
* key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
|
|
385
|
+
*/
|
|
386
|
+
indexableOption?:
|
|
387
|
+
string;
|
|
388
|
+
/**
|
|
389
|
+
* Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full
|
|
390
|
+
* list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this
|
|
391
|
+
* field cannot be modified.
|
|
392
|
+
*/
|
|
393
|
+
keyPropertyType?:
|
|
394
|
+
string;
|
|
395
|
+
/**
|
|
396
|
+
* If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is
|
|
397
|
+
* numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default
|
|
398
|
+
* setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result
|
|
399
|
+
* is returned.
|
|
400
|
+
*/
|
|
401
|
+
recsFilterableOption?:
|
|
402
|
+
string;
|
|
403
|
+
/**
|
|
404
|
+
* 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
|
|
405
|
+
* 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
|
|
406
|
+
* retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
|
|
407
|
+
*/
|
|
408
|
+
retrievableOption?:
|
|
409
|
+
string;
|
|
410
|
+
/**
|
|
411
|
+
* 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
|
|
412
|
+
* 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
|
|
413
|
+
* 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
|
|
414
|
+
* 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.
|
|
415
|
+
*/
|
|
416
|
+
searchableOption?:
|
|
417
|
+
string;
|
|
418
|
+
}
|
|
211
419
|
interface GoogleCloudDiscoveryengineV1alphaGcsSource {
|
|
212
420
|
/**
|
|
213
421
|
* The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid
|
|
@@ -343,6 +551,28 @@ declare namespace gapi.client {
|
|
|
343
551
|
unjoinedEventsCount?:
|
|
344
552
|
string;
|
|
345
553
|
}
|
|
554
|
+
interface GoogleCloudDiscoveryengineV1alphaInterval {
|
|
555
|
+
/** Exclusive upper bound. */
|
|
556
|
+
exclusiveMaximum?:
|
|
557
|
+
number;
|
|
558
|
+
/** Exclusive lower bound. */
|
|
559
|
+
exclusiveMinimum?:
|
|
560
|
+
number;
|
|
561
|
+
/** Inclusive upper bound. */
|
|
562
|
+
maximum?:
|
|
563
|
+
number;
|
|
564
|
+
/** Inclusive lower bound. */
|
|
565
|
+
minimum?:
|
|
566
|
+
number;
|
|
567
|
+
}
|
|
568
|
+
interface GoogleCloudDiscoveryengineV1alphaListConversationsResponse {
|
|
569
|
+
/** All the Conversations for a given data store. */
|
|
570
|
+
conversations?:
|
|
571
|
+
GoogleCloudDiscoveryengineV1alphaConversation[];
|
|
572
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
573
|
+
nextPageToken?:
|
|
574
|
+
string;
|
|
575
|
+
}
|
|
346
576
|
interface GoogleCloudDiscoveryengineV1alphaListDocumentsResponse {
|
|
347
577
|
/** The Documents. */
|
|
348
578
|
documents?:
|
|
@@ -351,6 +581,14 @@ declare namespace gapi.client {
|
|
|
351
581
|
nextPageToken?:
|
|
352
582
|
string;
|
|
353
583
|
}
|
|
584
|
+
interface GoogleCloudDiscoveryengineV1alphaListSchemasResponse {
|
|
585
|
+
/** A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
586
|
+
nextPageToken?:
|
|
587
|
+
string;
|
|
588
|
+
/** The Schemas. */
|
|
589
|
+
schemas?:
|
|
590
|
+
GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
591
|
+
}
|
|
354
592
|
interface GoogleCloudDiscoveryengineV1alphaMediaInfo {
|
|
355
593
|
/**
|
|
356
594
|
* The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be
|
|
@@ -548,7 +786,35 @@ declare namespace gapi.client {
|
|
|
548
786
|
metadata?:
|
|
549
787
|
{ [P in string]: any };
|
|
550
788
|
}
|
|
789
|
+
interface GoogleCloudDiscoveryengineV1alphaReply {
|
|
790
|
+
/** References in the reply. */
|
|
791
|
+
references?:
|
|
792
|
+
GoogleCloudDiscoveryengineV1alphaReplyReference[];
|
|
793
|
+
/** DEPRECATED: use `summary` instead. Text reply. */
|
|
794
|
+
reply?:
|
|
795
|
+
string;
|
|
796
|
+
/** Summary based on search results. */
|
|
797
|
+
summary?:
|
|
798
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseSummary;
|
|
799
|
+
}
|
|
800
|
+
interface GoogleCloudDiscoveryengineV1alphaReplyReference {
|
|
801
|
+
/** Anchor text. */
|
|
802
|
+
anchorText?:
|
|
803
|
+
string;
|
|
804
|
+
/** Anchor text end index. */
|
|
805
|
+
end?:
|
|
806
|
+
number;
|
|
807
|
+
/** Anchor text start index. */
|
|
808
|
+
start?:
|
|
809
|
+
number;
|
|
810
|
+
/** URI link reference. */
|
|
811
|
+
uri?:
|
|
812
|
+
string;
|
|
813
|
+
}
|
|
551
814
|
interface GoogleCloudDiscoveryengineV1alphaSchema {
|
|
815
|
+
/** Output only. Configurations for fields of the schema. */
|
|
816
|
+
fieldConfigs?:
|
|
817
|
+
GoogleCloudDiscoveryengineV1alphaFieldConfig[];
|
|
552
818
|
/** The JSON representation of the schema. */
|
|
553
819
|
jsonSchema?:
|
|
554
820
|
string;
|
|
@@ -585,133 +851,578 @@ declare namespace gapi.client {
|
|
|
585
851
|
searchQuery?:
|
|
586
852
|
string;
|
|
587
853
|
}
|
|
588
|
-
interface
|
|
589
|
-
/**
|
|
590
|
-
|
|
854
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
855
|
+
/** Boost specification to boost certain documents. */
|
|
856
|
+
boostSpec?:
|
|
857
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
858
|
+
/**
|
|
859
|
+
* The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or
|
|
860
|
+
* leave this field empty, to search documents under the default branch.
|
|
861
|
+
*/
|
|
862
|
+
branch?:
|
|
591
863
|
string;
|
|
592
|
-
/**
|
|
593
|
-
|
|
864
|
+
/** A specification for configuring the behavior of content search. */
|
|
865
|
+
contentSearchSpec?:
|
|
866
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
867
|
+
/**
|
|
868
|
+
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.embedding_spec.embedding_vectors.vector and the
|
|
869
|
+
* document embedding that is provided in SearchRequest.embedding_spec.embedding_vectors.field_path. If SearchRequest.embedding_spec.embedding_vectors.field_path is not provided, it
|
|
870
|
+
* will use ServingConfig.embedding_config.field_paths.
|
|
871
|
+
*/
|
|
872
|
+
embeddingSpec?:
|
|
873
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
874
|
+
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
875
|
+
facetSpecs?:
|
|
876
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
877
|
+
/**
|
|
878
|
+
* 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. If
|
|
879
|
+
* this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
880
|
+
*/
|
|
881
|
+
filter?:
|
|
594
882
|
string;
|
|
595
|
-
|
|
596
|
-
|
|
883
|
+
/** Raw image query. */
|
|
884
|
+
imageQuery?:
|
|
885
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery;
|
|
597
886
|
/**
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
* pattern to be used by the search engine.
|
|
887
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only
|
|
888
|
+
* considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
601
889
|
*/
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
/**
|
|
605
|
-
|
|
890
|
+
offset?:
|
|
891
|
+
number;
|
|
892
|
+
/**
|
|
893
|
+
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is
|
|
894
|
+
* case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
895
|
+
*/
|
|
896
|
+
orderBy?:
|
|
606
897
|
string;
|
|
607
898
|
/**
|
|
608
|
-
*
|
|
609
|
-
*
|
|
899
|
+
* Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is
|
|
900
|
+
* negative, an `INVALID_ARGUMENT` is returned.
|
|
610
901
|
*/
|
|
611
|
-
|
|
902
|
+
pageSize?:
|
|
903
|
+
number;
|
|
904
|
+
/**
|
|
905
|
+
* A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search
|
|
906
|
+
* must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
907
|
+
*/
|
|
908
|
+
pageToken?:
|
|
612
909
|
string;
|
|
613
|
-
/**
|
|
614
|
-
|
|
910
|
+
/**
|
|
911
|
+
* Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or
|
|
912
|
+
* boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which
|
|
913
|
+
* enables image searching.
|
|
914
|
+
*/
|
|
915
|
+
params?:
|
|
916
|
+
{ [P in string]: any };
|
|
917
|
+
/** Raw search query. */
|
|
918
|
+
query?:
|
|
615
919
|
string;
|
|
616
|
-
/**
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
/**
|
|
620
|
-
|
|
920
|
+
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
921
|
+
queryExpansionSpec?:
|
|
922
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
923
|
+
/**
|
|
924
|
+
* The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or
|
|
925
|
+
* multiple functions that are joint by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double *
|
|
926
|
+
* dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the
|
|
927
|
+
* document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If
|
|
928
|
+
* document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
|
929
|
+
*/
|
|
930
|
+
rankingExpression?:
|
|
621
931
|
string;
|
|
622
|
-
/**
|
|
623
|
-
|
|
932
|
+
/** Whether to turn on safe search. This is only supported for website search. */
|
|
933
|
+
safeSearch?:
|
|
934
|
+
boolean;
|
|
935
|
+
/** The spell correction specification that specifies the mode under which spell correction takes effect. */
|
|
936
|
+
spellCorrectionSpec?:
|
|
937
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec;
|
|
938
|
+
/** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
|
|
939
|
+
userInfo?:
|
|
940
|
+
GoogleCloudDiscoveryengineV1alphaUserInfo;
|
|
941
|
+
/**
|
|
942
|
+
* 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. *
|
|
943
|
+
* 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
|
|
944
|
+
* 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
|
|
945
|
+
* 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
|
|
946
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
947
|
+
*/
|
|
948
|
+
userLabels?:
|
|
949
|
+
{ [P in string]: string };
|
|
950
|
+
/**
|
|
951
|
+
* 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
|
|
952
|
+
* 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`. This should be the same
|
|
953
|
+
* identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
|
|
954
|
+
* `INVALID_ARGUMENT` error is returned.
|
|
955
|
+
*/
|
|
956
|
+
userPseudoId?:
|
|
624
957
|
string;
|
|
625
958
|
}
|
|
626
|
-
interface
|
|
959
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec {
|
|
627
960
|
/**
|
|
628
|
-
*
|
|
629
|
-
*
|
|
961
|
+
* Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear
|
|
962
|
+
* way. Maximum number of specifications is 20.
|
|
630
963
|
*/
|
|
631
|
-
|
|
964
|
+
conditionBoostSpecs?:
|
|
965
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[];
|
|
966
|
+
}
|
|
967
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
968
|
+
/**
|
|
969
|
+
* Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not
|
|
970
|
+
* necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them
|
|
971
|
+
* matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the
|
|
972
|
+
* document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not
|
|
973
|
+
* blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
|
|
974
|
+
*/
|
|
975
|
+
boost?:
|
|
632
976
|
number;
|
|
633
|
-
/**
|
|
634
|
-
|
|
977
|
+
/**
|
|
978
|
+
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.
|
|
979
|
+
* Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
|
|
980
|
+
*/
|
|
981
|
+
condition?:
|
|
635
982
|
string;
|
|
983
|
+
}
|
|
984
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
985
|
+
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
986
|
+
extractiveContentSpec?:
|
|
987
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
988
|
+
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
989
|
+
snippetSpec?:
|
|
990
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
991
|
+
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
992
|
+
summarySpec?:
|
|
993
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
994
|
+
}
|
|
995
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
636
996
|
/**
|
|
637
|
-
* The
|
|
638
|
-
*
|
|
639
|
-
*
|
|
997
|
+
* The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and
|
|
998
|
+
* contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the
|
|
999
|
+
* `max_extractive_answer_count`. At most one answer is returned for each SearchResult.
|
|
640
1000
|
*/
|
|
641
|
-
|
|
642
|
-
number;
|
|
643
|
-
/** All the taxes associated with the transaction. */
|
|
644
|
-
tax?:
|
|
1001
|
+
maxExtractiveAnswerCount?:
|
|
645
1002
|
number;
|
|
646
|
-
/**
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
1003
|
+
/**
|
|
1004
|
+
* The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is
|
|
1005
|
+
* SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an
|
|
1006
|
+
* extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than
|
|
1007
|
+
* `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
|
|
1008
|
+
*/
|
|
1009
|
+
maxExtractiveSegmentCount?:
|
|
651
1010
|
number;
|
|
1011
|
+
/** Specifies whether to return the confidence score from the extractive segments in each search result. The default value is `false`. */
|
|
1012
|
+
returnExtractiveSegmentScore?:
|
|
1013
|
+
boolean;
|
|
652
1014
|
}
|
|
653
|
-
interface
|
|
1015
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec {
|
|
1016
|
+
/** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
|
|
1017
|
+
maxSnippetCount?:
|
|
1018
|
+
number;
|
|
1019
|
+
/** [DEPRECATED] This field is deprecated and will have no affect on the snippet. */
|
|
1020
|
+
referenceOnly?:
|
|
1021
|
+
boolean;
|
|
654
1022
|
/**
|
|
655
|
-
*
|
|
656
|
-
*
|
|
657
|
-
* consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving
|
|
658
|
-
* predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8
|
|
659
|
-
* encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded
|
|
660
|
-
* string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is
|
|
661
|
-
* `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
|
|
1023
|
+
* If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will
|
|
1024
|
+
* also be returned.
|
|
662
1025
|
*/
|
|
663
|
-
|
|
664
|
-
|
|
1026
|
+
returnSnippet?:
|
|
1027
|
+
boolean;
|
|
1028
|
+
}
|
|
1029
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
665
1030
|
/**
|
|
666
|
-
*
|
|
667
|
-
*
|
|
668
|
-
*
|
|
669
|
-
* or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results,
|
|
670
|
-
* pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this
|
|
671
|
-
* field.
|
|
1031
|
+
* Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned
|
|
1032
|
+
* 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
|
|
1033
|
+
* generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
|
|
672
1034
|
*/
|
|
673
|
-
|
|
674
|
-
|
|
1035
|
+
ignoreAdversarialQuery?:
|
|
1036
|
+
boolean;
|
|
675
1037
|
/**
|
|
676
|
-
*
|
|
677
|
-
* search.
|
|
1038
|
+
* Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No
|
|
1039
|
+
* summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are
|
|
1040
|
+
* summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for
|
|
1041
|
+
* non-summary seeking queries and return fallback messages instead.
|
|
678
1042
|
*/
|
|
679
|
-
|
|
680
|
-
|
|
1043
|
+
ignoreNonSummarySeekingQuery?:
|
|
1044
|
+
boolean;
|
|
681
1045
|
/**
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
1046
|
+
* Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary
|
|
1047
|
+
* including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has
|
|
1048
|
+
* built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example,
|
|
1049
|
+
* [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
|
|
685
1050
|
*/
|
|
686
|
-
|
|
1051
|
+
includeCitations?:
|
|
687
1052
|
boolean;
|
|
1053
|
+
/** Language code for Summary. Use language tags defined by BCP47. */
|
|
1054
|
+
languageCode?:
|
|
1055
|
+
string;
|
|
688
1056
|
/**
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
* 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.
|
|
1057
|
+
* The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At
|
|
1058
|
+
* most five results can be used to generate a summary.
|
|
692
1059
|
*/
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
1060
|
+
summaryResultCount?:
|
|
1061
|
+
number;
|
|
1062
|
+
}
|
|
1063
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
|
|
1064
|
+
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1065
|
+
embeddingVectors?:
|
|
1066
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
1067
|
+
}
|
|
1068
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector {
|
|
1069
|
+
/** Embedding field path in schema. */
|
|
1070
|
+
fieldPath?:
|
|
697
1071
|
string;
|
|
1072
|
+
/** Query embedding vector. */
|
|
1073
|
+
vector?:
|
|
1074
|
+
number[];
|
|
1075
|
+
}
|
|
1076
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec {
|
|
698
1077
|
/**
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
702
|
-
*
|
|
1078
|
+
* Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it
|
|
1079
|
+
* is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and
|
|
1080
|
+
* all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that
|
|
1081
|
+
* case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following
|
|
1082
|
+
* facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic
|
|
1083
|
+
* facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
|
|
1084
|
+
* "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their
|
|
1085
|
+
* enable_dynamic_position is false.
|
|
703
1086
|
*/
|
|
704
|
-
|
|
705
|
-
|
|
1087
|
+
enableDynamicPosition?:
|
|
1088
|
+
boolean;
|
|
706
1089
|
/**
|
|
707
|
-
*
|
|
708
|
-
*
|
|
709
|
-
*
|
|
710
|
-
*
|
|
1090
|
+
* List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its
|
|
1091
|
+
* values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there
|
|
1092
|
+
* are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would
|
|
1093
|
+
* by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue"
|
|
1094
|
+
* would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200,
|
|
1095
|
+
* because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red"
|
|
1096
|
+
* documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
711
1097
|
*/
|
|
712
|
-
|
|
713
|
-
string;
|
|
714
|
-
/**
|
|
1098
|
+
excludedFilterKeys?:
|
|
1099
|
+
string[];
|
|
1100
|
+
/** Required. The facet key specification. */
|
|
1101
|
+
facetKey?:
|
|
1102
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey;
|
|
1103
|
+
/**
|
|
1104
|
+
* Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field
|
|
1105
|
+
* is negative, an `INVALID_ARGUMENT` is returned.
|
|
1106
|
+
*/
|
|
1107
|
+
limit?:
|
|
1108
|
+
number;
|
|
1109
|
+
}
|
|
1110
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey {
|
|
1111
|
+
/** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
|
|
1112
|
+
caseInsensitive?:
|
|
1113
|
+
boolean;
|
|
1114
|
+
/**
|
|
1115
|
+
* Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to
|
|
1116
|
+
* "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
|
|
1117
|
+
*/
|
|
1118
|
+
contains?:
|
|
1119
|
+
string[];
|
|
1120
|
+
/** Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */
|
|
1121
|
+
intervals?:
|
|
1122
|
+
GoogleCloudDiscoveryengineV1alphaInterval[];
|
|
1123
|
+
/** Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */
|
|
1124
|
+
key?:
|
|
1125
|
+
string;
|
|
1126
|
+
/**
|
|
1127
|
+
* The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order
|
|
1128
|
+
* by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural
|
|
1129
|
+
* order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
|
|
1130
|
+
*/
|
|
1131
|
+
orderBy?:
|
|
1132
|
+
string;
|
|
1133
|
+
/**
|
|
1134
|
+
* Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
|
|
1135
|
+
* "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
|
|
1136
|
+
*/
|
|
1137
|
+
prefixes?:
|
|
1138
|
+
string[];
|
|
1139
|
+
/**
|
|
1140
|
+
* Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi >
|
|
1141
|
+
* 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
|
|
1142
|
+
*/
|
|
1143
|
+
restrictedValues?:
|
|
1144
|
+
string[];
|
|
1145
|
+
}
|
|
1146
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery {
|
|
1147
|
+
/** Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */
|
|
1148
|
+
imageBytes?:
|
|
1149
|
+
string;
|
|
1150
|
+
}
|
|
1151
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec {
|
|
1152
|
+
/** The condition under which query expansion should occur. Default to Condition.DISABLED. */
|
|
1153
|
+
condition?:
|
|
1154
|
+
string;
|
|
1155
|
+
/** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
|
|
1156
|
+
pinUnexpandedResults?:
|
|
1157
|
+
boolean;
|
|
1158
|
+
}
|
|
1159
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec {
|
|
1160
|
+
/** The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. */
|
|
1161
|
+
mode?:
|
|
1162
|
+
string;
|
|
1163
|
+
}
|
|
1164
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponse {
|
|
1165
|
+
/** Controls applied as part of the Control service. */
|
|
1166
|
+
appliedControls?:
|
|
1167
|
+
string[];
|
|
1168
|
+
/** A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */
|
|
1169
|
+
attributionToken?:
|
|
1170
|
+
string;
|
|
1171
|
+
/**
|
|
1172
|
+
* Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used
|
|
1173
|
+
* for search.
|
|
1174
|
+
*/
|
|
1175
|
+
correctedQuery?:
|
|
1176
|
+
string;
|
|
1177
|
+
/** Results of facets requested by user. */
|
|
1178
|
+
facets?:
|
|
1179
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
|
|
1180
|
+
/** Guided search result. */
|
|
1181
|
+
guidedSearchResult?:
|
|
1182
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
|
|
1183
|
+
/** A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
1184
|
+
nextPageToken?:
|
|
1185
|
+
string;
|
|
1186
|
+
/** Query expansion information for the returned results. */
|
|
1187
|
+
queryExpansionInfo?:
|
|
1188
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo;
|
|
1189
|
+
/** The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. */
|
|
1190
|
+
redirectUri?:
|
|
1191
|
+
string;
|
|
1192
|
+
/** A list of matched documents. The order represents the ranking. */
|
|
1193
|
+
results?:
|
|
1194
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
|
|
1195
|
+
/** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
|
|
1196
|
+
summary?:
|
|
1197
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseSummary;
|
|
1198
|
+
/** The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */
|
|
1199
|
+
totalSize?:
|
|
1200
|
+
number;
|
|
1201
|
+
}
|
|
1202
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseFacet {
|
|
1203
|
+
/** Whether the facet is dynamically generated. */
|
|
1204
|
+
dynamicFacet?:
|
|
1205
|
+
boolean;
|
|
1206
|
+
/** The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. */
|
|
1207
|
+
key?:
|
|
1208
|
+
string;
|
|
1209
|
+
/** The facet values for this field. */
|
|
1210
|
+
values?:
|
|
1211
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue[];
|
|
1212
|
+
}
|
|
1213
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue {
|
|
1214
|
+
/** Number of items that have this facet value. */
|
|
1215
|
+
count?:
|
|
1216
|
+
string;
|
|
1217
|
+
/** Interval value for a facet, such as 10, 20) for facet "price". It matches [SearchRequest.FacetSpec.FacetKey.intervals. */
|
|
1218
|
+
interval?:
|
|
1219
|
+
GoogleCloudDiscoveryengineV1alphaInterval;
|
|
1220
|
+
/** Text value of a facet, such as "Black" for facet "colors". */
|
|
1221
|
+
value?:
|
|
1222
|
+
string;
|
|
1223
|
+
}
|
|
1224
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult {
|
|
1225
|
+
/** Suggested follow-up questions. */
|
|
1226
|
+
followUpQuestions?:
|
|
1227
|
+
string[];
|
|
1228
|
+
/** A list of ranked refinement attributes. */
|
|
1229
|
+
refinementAttributes?:
|
|
1230
|
+
GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute[];
|
|
1231
|
+
}
|
|
1232
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute {
|
|
1233
|
+
/** Attribute key used to refine the results e.g. 'movie_type'. */
|
|
1234
|
+
attributeKey?:
|
|
1235
|
+
string;
|
|
1236
|
+
/** Attribute value used to refine the results e.g. 'drama'. */
|
|
1237
|
+
attributeValue?:
|
|
1238
|
+
string;
|
|
1239
|
+
}
|
|
1240
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo {
|
|
1241
|
+
/** Bool describing whether query expansion has occurred. */
|
|
1242
|
+
expandedQuery?:
|
|
1243
|
+
boolean;
|
|
1244
|
+
/** Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. */
|
|
1245
|
+
pinnedResultCount?:
|
|
1246
|
+
string;
|
|
1247
|
+
}
|
|
1248
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
|
|
1249
|
+
/** The document data snippet in the search response. Only fields that are marked as retrievable are populated. */
|
|
1250
|
+
document?:
|
|
1251
|
+
GoogleCloudDiscoveryengineV1alphaDocument;
|
|
1252
|
+
/** Document.id of the searched Document. */
|
|
1253
|
+
id?:
|
|
1254
|
+
string;
|
|
1255
|
+
/** Google provided available scores. */
|
|
1256
|
+
modelScores?:
|
|
1257
|
+
{ [P in string]: GoogleCloudDiscoveryengineV1alphaDoubleList };
|
|
1258
|
+
}
|
|
1259
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummary {
|
|
1260
|
+
/** Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
1261
|
+
summarySkippedReasons?:
|
|
1262
|
+
string[];
|
|
1263
|
+
/** The summary content. */
|
|
1264
|
+
summaryText?:
|
|
1265
|
+
string;
|
|
1266
|
+
}
|
|
1267
|
+
interface GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo {
|
|
1268
|
+
/** Site verification state indicating the ownership and validity. */
|
|
1269
|
+
siteVerificationState?:
|
|
1270
|
+
string;
|
|
1271
|
+
/** Latest site verification time. */
|
|
1272
|
+
verifyTime?:
|
|
1273
|
+
string;
|
|
1274
|
+
}
|
|
1275
|
+
interface GoogleCloudDiscoveryengineV1alphaTargetSite {
|
|
1276
|
+
/**
|
|
1277
|
+
* Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to
|
|
1278
|
+
* be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI
|
|
1279
|
+
* pattern to be used by the search engine.
|
|
1280
|
+
*/
|
|
1281
|
+
exactMatch?:
|
|
1282
|
+
boolean;
|
|
1283
|
+
/** Output only. Failure reason. */
|
|
1284
|
+
failureReason?:
|
|
1285
|
+
GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason;
|
|
1286
|
+
/** Output only. This is system-generated based on the provided_uri_pattern. */
|
|
1287
|
+
generatedUriPattern?:
|
|
1288
|
+
string;
|
|
1289
|
+
/** Output only. Indexing status. */
|
|
1290
|
+
indexingStatus?:
|
|
1291
|
+
string;
|
|
1292
|
+
/**
|
|
1293
|
+
* Output only. The fully qualified resource name of the target site.
|
|
1294
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
|
|
1295
|
+
*/
|
|
1296
|
+
name?:
|
|
1297
|
+
string;
|
|
1298
|
+
/** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
|
|
1299
|
+
providedUriPattern?:
|
|
1300
|
+
string;
|
|
1301
|
+
/** Output only. Site ownership and validity verification status. */
|
|
1302
|
+
siteVerificationInfo?:
|
|
1303
|
+
GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
1304
|
+
/** The type of the target site, e.g. whether the site is to be included or excluded. */
|
|
1305
|
+
type?:
|
|
1306
|
+
string;
|
|
1307
|
+
/** Output only. The target site's last updated time. */
|
|
1308
|
+
updateTime?:
|
|
1309
|
+
string;
|
|
1310
|
+
}
|
|
1311
|
+
interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason {
|
|
1312
|
+
/** Failed due to insufficient quota. */
|
|
1313
|
+
quotaFailure?:
|
|
1314
|
+
GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
1315
|
+
}
|
|
1316
|
+
interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
1317
|
+
/** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
|
|
1318
|
+
totalRequiredQuota?:
|
|
1319
|
+
string;
|
|
1320
|
+
}
|
|
1321
|
+
interface GoogleCloudDiscoveryengineV1alphaTextInput {
|
|
1322
|
+
/** Conversation context of the input. */
|
|
1323
|
+
context?:
|
|
1324
|
+
GoogleCloudDiscoveryengineV1alphaConversationContext;
|
|
1325
|
+
/** Text input. */
|
|
1326
|
+
input?:
|
|
1327
|
+
string;
|
|
1328
|
+
}
|
|
1329
|
+
interface GoogleCloudDiscoveryengineV1alphaTransactionInfo {
|
|
1330
|
+
/**
|
|
1331
|
+
* All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax -
|
|
1332
|
+
* cost
|
|
1333
|
+
*/
|
|
1334
|
+
cost?:
|
|
1335
|
+
number;
|
|
1336
|
+
/** Required. Currency code. Use three-character ISO-4217 code. */
|
|
1337
|
+
currency?:
|
|
1338
|
+
string;
|
|
1339
|
+
/**
|
|
1340
|
+
* The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then
|
|
1341
|
+
* nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless
|
|
1342
|
+
* of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost
|
|
1343
|
+
*/
|
|
1344
|
+
discountValue?:
|
|
1345
|
+
number;
|
|
1346
|
+
/** All the taxes associated with the transaction. */
|
|
1347
|
+
tax?:
|
|
1348
|
+
number;
|
|
1349
|
+
/** The transaction ID with a length limit of 128 characters. */
|
|
1350
|
+
transactionId?:
|
|
1351
|
+
string;
|
|
1352
|
+
/** Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. */
|
|
1353
|
+
value?:
|
|
1354
|
+
number;
|
|
1355
|
+
}
|
|
1356
|
+
interface GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata {
|
|
1357
|
+
/** Operation create time. */
|
|
1358
|
+
createTime?:
|
|
1359
|
+
string;
|
|
1360
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1361
|
+
updateTime?:
|
|
1362
|
+
string;
|
|
1363
|
+
}
|
|
1364
|
+
interface GoogleCloudDiscoveryengineV1alphaUserEvent {
|
|
1365
|
+
/**
|
|
1366
|
+
* Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.
|
|
1367
|
+
* If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be
|
|
1368
|
+
* consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving
|
|
1369
|
+
* predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8
|
|
1370
|
+
* encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded
|
|
1371
|
+
* string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is
|
|
1372
|
+
* `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
|
|
1373
|
+
*/
|
|
1374
|
+
attributes?:
|
|
1375
|
+
{ [P in string]: GoogleCloudDiscoveryengineV1alphaCustomAttribute };
|
|
1376
|
+
/**
|
|
1377
|
+
* Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field
|
|
1378
|
+
* enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of
|
|
1379
|
+
* RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view
|
|
1380
|
+
* or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results,
|
|
1381
|
+
* pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this
|
|
1382
|
+
* field.
|
|
1383
|
+
*/
|
|
1384
|
+
attributionToken?:
|
|
1385
|
+
string;
|
|
1386
|
+
/**
|
|
1387
|
+
* 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
|
|
1388
|
+
* search.
|
|
1389
|
+
*/
|
|
1390
|
+
completionInfo?:
|
|
1391
|
+
GoogleCloudDiscoveryengineV1alphaCompletionInfo;
|
|
1392
|
+
/**
|
|
1393
|
+
* 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
|
|
1394
|
+
* 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
|
|
1395
|
+
* set when using the JavaScript tag in UserEventService.CollectUserEvent.
|
|
1396
|
+
*/
|
|
1397
|
+
directUserRequest?:
|
|
1398
|
+
boolean;
|
|
1399
|
+
/**
|
|
1400
|
+
* 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` *
|
|
1401
|
+
* `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
|
|
1402
|
+
* 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.
|
|
1403
|
+
*/
|
|
1404
|
+
documents?:
|
|
1405
|
+
GoogleCloudDiscoveryengineV1alphaDocumentInfo[];
|
|
1406
|
+
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
1407
|
+
eventTime?:
|
|
1408
|
+
string;
|
|
1409
|
+
/**
|
|
1410
|
+
* 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
|
|
1411
|
+
* 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: *
|
|
1412
|
+
* `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
|
|
1413
|
+
* a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.
|
|
1414
|
+
*/
|
|
1415
|
+
eventType?:
|
|
1416
|
+
string;
|
|
1417
|
+
/**
|
|
1418
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the
|
|
1419
|
+
* associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are
|
|
1420
|
+
* generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to
|
|
1421
|
+
* https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
1422
|
+
*/
|
|
1423
|
+
filter?:
|
|
1424
|
+
string;
|
|
1425
|
+
/** Media-specific info. */
|
|
715
1426
|
mediaInfo?:
|
|
716
1427
|
GoogleCloudDiscoveryengineV1alphaMediaInfo;
|
|
717
1428
|
/** Page metadata such as categories and other critical information for certain event types such as `view-category-page`. */
|
|
@@ -770,6 +1481,22 @@ declare namespace gapi.client {
|
|
|
770
1481
|
userId?:
|
|
771
1482
|
string;
|
|
772
1483
|
}
|
|
1484
|
+
interface GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
1485
|
+
/** Operation create time. */
|
|
1486
|
+
createTime?:
|
|
1487
|
+
string;
|
|
1488
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1489
|
+
updateTime?:
|
|
1490
|
+
string;
|
|
1491
|
+
}
|
|
1492
|
+
interface GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
|
|
1493
|
+
/** Operation create time. */
|
|
1494
|
+
createTime?:
|
|
1495
|
+
string;
|
|
1496
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1497
|
+
updateTime?:
|
|
1498
|
+
string;
|
|
1499
|
+
}
|
|
773
1500
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
774
1501
|
/** Operation create time. */
|
|
775
1502
|
createTime?:
|
|
@@ -864,6 +1591,30 @@ declare namespace gapi.client {
|
|
|
864
1591
|
structSchema?:
|
|
865
1592
|
{ [P in string]: any };
|
|
866
1593
|
}
|
|
1594
|
+
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
1595
|
+
/** Operation create time. */
|
|
1596
|
+
createTime?:
|
|
1597
|
+
string;
|
|
1598
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1599
|
+
updateTime?:
|
|
1600
|
+
string;
|
|
1601
|
+
}
|
|
1602
|
+
interface GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
|
|
1603
|
+
/** Operation create time. */
|
|
1604
|
+
createTime?:
|
|
1605
|
+
string;
|
|
1606
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1607
|
+
updateTime?:
|
|
1608
|
+
string;
|
|
1609
|
+
}
|
|
1610
|
+
interface GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
1611
|
+
/** Operation create time. */
|
|
1612
|
+
createTime?:
|
|
1613
|
+
string;
|
|
1614
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1615
|
+
updateTime?:
|
|
1616
|
+
string;
|
|
1617
|
+
}
|
|
867
1618
|
interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
|
|
868
1619
|
/** Operation create time. */
|
|
869
1620
|
createTime?:
|
|
@@ -958,6 +1709,14 @@ declare namespace gapi.client {
|
|
|
958
1709
|
structSchema?:
|
|
959
1710
|
{ [P in string]: any };
|
|
960
1711
|
}
|
|
1712
|
+
interface GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
|
|
1713
|
+
/** Operation create time. */
|
|
1714
|
+
createTime?:
|
|
1715
|
+
string;
|
|
1716
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1717
|
+
updateTime?:
|
|
1718
|
+
string;
|
|
1719
|
+
}
|
|
961
1720
|
interface GoogleLongrunningListOperationsResponse {
|
|
962
1721
|
/** The standard List next-page token. */
|
|
963
1722
|
nextPageToken?:
|
|
@@ -1626,9 +2385,9 @@ declare namespace gapi.client {
|
|
|
1626
2385
|
operations:
|
|
1627
2386
|
OperationsResource;
|
|
1628
2387
|
}
|
|
1629
|
-
interface
|
|
1630
|
-
/**
|
|
1631
|
-
|
|
2388
|
+
interface ConversationsResource {
|
|
2389
|
+
/** Converses a conversation. */
|
|
2390
|
+
converse(request: {
|
|
1632
2391
|
/** V1 error format. */
|
|
1633
2392
|
"$.xgafv"?:
|
|
1634
2393
|
string;
|
|
@@ -1647,7 +2406,12 @@ declare namespace gapi.client {
|
|
|
1647
2406
|
/** 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. */
|
|
1648
2407
|
key?:
|
|
1649
2408
|
string;
|
|
1650
|
-
/**
|
|
2409
|
+
/**
|
|
2410
|
+
* Required. The resource name of the Conversation to get. Format:
|
|
2411
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
|
|
2412
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
|
|
2413
|
+
* creates a new conversation inside a ConverseConversation session.
|
|
2414
|
+
*/
|
|
1651
2415
|
name:
|
|
1652
2416
|
string;
|
|
1653
2417
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -1665,10 +2429,12 @@ declare namespace gapi.client {
|
|
|
1665
2429
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1666
2430
|
uploadType?:
|
|
1667
2431
|
string;
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
2432
|
+
/** Request body */
|
|
2433
|
+
resource:
|
|
2434
|
+
GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
|
|
2435
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
|
|
2436
|
+
converse(request: {
|
|
2437
|
+
/** V1 error format. */
|
|
1672
2438
|
"$.xgafv"?:
|
|
1673
2439
|
string;
|
|
1674
2440
|
/** OAuth access token. */
|
|
@@ -1683,24 +2449,20 @@ declare namespace gapi.client {
|
|
|
1683
2449
|
/** Selector specifying which fields to include in a partial response. */
|
|
1684
2450
|
fields?:
|
|
1685
2451
|
string;
|
|
1686
|
-
/** The standard list filter. */
|
|
1687
|
-
filter?:
|
|
1688
|
-
string;
|
|
1689
2452
|
/** 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. */
|
|
1690
2453
|
key?:
|
|
1691
2454
|
string;
|
|
1692
|
-
/**
|
|
2455
|
+
/**
|
|
2456
|
+
* Required. The resource name of the Conversation to get. Format:
|
|
2457
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
|
|
2458
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
|
|
2459
|
+
* creates a new conversation inside a ConverseConversation session.
|
|
2460
|
+
*/
|
|
1693
2461
|
name:
|
|
1694
2462
|
string;
|
|
1695
2463
|
/** OAuth 2.0 token for the current user. */
|
|
1696
2464
|
oauth_token?:
|
|
1697
2465
|
string;
|
|
1698
|
-
/** The standard list page size. */
|
|
1699
|
-
pageSize?:
|
|
1700
|
-
number;
|
|
1701
|
-
/** The standard list page token. */
|
|
1702
|
-
pageToken?:
|
|
1703
|
-
string;
|
|
1704
2466
|
/** Returns response with indentations and line breaks. */
|
|
1705
2467
|
prettyPrint?:
|
|
1706
2468
|
boolean;
|
|
@@ -1713,15 +2475,10 @@ declare namespace gapi.client {
|
|
|
1713
2475
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1714
2476
|
uploadType?:
|
|
1715
2477
|
string;
|
|
1716
|
-
}
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
OperationsResource;
|
|
1721
|
-
}
|
|
1722
|
-
interface OperationsResource {
|
|
1723
|
-
/** 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. */
|
|
1724
|
-
get(request?: {
|
|
2478
|
+
},
|
|
2479
|
+
body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
|
|
2480
|
+
/** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
|
|
2481
|
+
create(request: {
|
|
1725
2482
|
/** V1 error format. */
|
|
1726
2483
|
"$.xgafv"?:
|
|
1727
2484
|
string;
|
|
@@ -1740,12 +2497,12 @@ declare namespace gapi.client {
|
|
|
1740
2497
|
/** 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. */
|
|
1741
2498
|
key?:
|
|
1742
2499
|
string;
|
|
1743
|
-
/** The name of the operation resource. */
|
|
1744
|
-
name:
|
|
1745
|
-
string;
|
|
1746
2500
|
/** OAuth 2.0 token for the current user. */
|
|
1747
2501
|
oauth_token?:
|
|
1748
2502
|
string;
|
|
2503
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
2504
|
+
parent:
|
|
2505
|
+
string;
|
|
1749
2506
|
/** Returns response with indentations and line breaks. */
|
|
1750
2507
|
prettyPrint?:
|
|
1751
2508
|
boolean;
|
|
@@ -1758,9 +2515,11 @@ declare namespace gapi.client {
|
|
|
1758
2515
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1759
2516
|
uploadType?:
|
|
1760
2517
|
string;
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
2518
|
+
/** Request body */
|
|
2519
|
+
resource:
|
|
2520
|
+
GoogleCloudDiscoveryengineV1alphaConversation;
|
|
2521
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
2522
|
+
create(request: {
|
|
1764
2523
|
/** V1 error format. */
|
|
1765
2524
|
"$.xgafv"?:
|
|
1766
2525
|
string;
|
|
@@ -1776,24 +2535,58 @@ declare namespace gapi.client {
|
|
|
1776
2535
|
/** Selector specifying which fields to include in a partial response. */
|
|
1777
2536
|
fields?:
|
|
1778
2537
|
string;
|
|
1779
|
-
/**
|
|
1780
|
-
|
|
2538
|
+
/** 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. */
|
|
2539
|
+
key?:
|
|
2540
|
+
string;
|
|
2541
|
+
/** OAuth 2.0 token for the current user. */
|
|
2542
|
+
oauth_token?:
|
|
2543
|
+
string;
|
|
2544
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
2545
|
+
parent:
|
|
2546
|
+
string;
|
|
2547
|
+
/** Returns response with indentations and line breaks. */
|
|
2548
|
+
prettyPrint?:
|
|
2549
|
+
boolean;
|
|
2550
|
+
/** 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. */
|
|
2551
|
+
quotaUser?:
|
|
2552
|
+
string;
|
|
2553
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2554
|
+
upload_protocol?:
|
|
2555
|
+
string;
|
|
2556
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2557
|
+
uploadType?:
|
|
2558
|
+
string;
|
|
2559
|
+
},
|
|
2560
|
+
body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
2561
|
+
/** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
|
|
2562
|
+
delete(request?: {
|
|
2563
|
+
/** V1 error format. */
|
|
2564
|
+
"$.xgafv"?:
|
|
2565
|
+
string;
|
|
2566
|
+
/** OAuth access token. */
|
|
2567
|
+
access_token?:
|
|
2568
|
+
string;
|
|
2569
|
+
/** Data format for response. */
|
|
2570
|
+
alt?:
|
|
2571
|
+
string;
|
|
2572
|
+
/** JSONP */
|
|
2573
|
+
callback?:
|
|
2574
|
+
string;
|
|
2575
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2576
|
+
fields?:
|
|
1781
2577
|
string;
|
|
1782
2578
|
/** 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. */
|
|
1783
2579
|
key?:
|
|
1784
2580
|
string;
|
|
1785
|
-
/**
|
|
2581
|
+
/**
|
|
2582
|
+
* Required. The resource name of the Conversation to delete. Format:
|
|
2583
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
|
2584
|
+
*/
|
|
1786
2585
|
name:
|
|
1787
2586
|
string;
|
|
1788
2587
|
/** OAuth 2.0 token for the current user. */
|
|
1789
2588
|
oauth_token?:
|
|
1790
2589
|
string;
|
|
1791
|
-
/** The standard list page size. */
|
|
1792
|
-
pageSize?:
|
|
1793
|
-
number;
|
|
1794
|
-
/** The standard list page token. */
|
|
1795
|
-
pageToken?:
|
|
1796
|
-
string;
|
|
1797
2590
|
/** Returns response with indentations and line breaks. */
|
|
1798
2591
|
prettyPrint?:
|
|
1799
2592
|
boolean;
|
|
@@ -1806,10 +2599,8 @@ declare namespace gapi.client {
|
|
|
1806
2599
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1807
2600
|
uploadType?:
|
|
1808
2601
|
string;
|
|
1809
|
-
}): Request<
|
|
1810
|
-
|
|
1811
|
-
interface OperationsResource {
|
|
1812
|
-
/** 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. */
|
|
2602
|
+
}): Request<{}>;
|
|
2603
|
+
/** Gets a Conversation. */
|
|
1813
2604
|
get(request?: {
|
|
1814
2605
|
/** V1 error format. */
|
|
1815
2606
|
"$.xgafv"?:
|
|
@@ -1829,7 +2620,10 @@ declare namespace gapi.client {
|
|
|
1829
2620
|
/** 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. */
|
|
1830
2621
|
key?:
|
|
1831
2622
|
string;
|
|
1832
|
-
/**
|
|
2623
|
+
/**
|
|
2624
|
+
* Required. The resource name of the Conversation to get. Format:
|
|
2625
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
|
2626
|
+
*/
|
|
1833
2627
|
name:
|
|
1834
2628
|
string;
|
|
1835
2629
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -1847,8 +2641,8 @@ declare namespace gapi.client {
|
|
|
1847
2641
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1848
2642
|
uploadType?:
|
|
1849
2643
|
string;
|
|
1850
|
-
}): Request<
|
|
1851
|
-
/** Lists
|
|
2644
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
2645
|
+
/** Lists all Conversations by their parent DataStore. */
|
|
1852
2646
|
list(request?: {
|
|
1853
2647
|
/** V1 error format. */
|
|
1854
2648
|
"$.xgafv"?:
|
|
@@ -1865,24 +2659,30 @@ declare namespace gapi.client {
|
|
|
1865
2659
|
/** Selector specifying which fields to include in a partial response. */
|
|
1866
2660
|
fields?:
|
|
1867
2661
|
string;
|
|
1868
|
-
/**
|
|
2662
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
1869
2663
|
filter?:
|
|
1870
2664
|
string;
|
|
1871
2665
|
/** 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. */
|
|
1872
2666
|
key?:
|
|
1873
2667
|
string;
|
|
1874
|
-
/** The name of the operation's parent resource. */
|
|
1875
|
-
name:
|
|
1876
|
-
string;
|
|
1877
2668
|
/** OAuth 2.0 token for the current user. */
|
|
1878
2669
|
oauth_token?:
|
|
1879
2670
|
string;
|
|
1880
|
-
/**
|
|
2671
|
+
/**
|
|
2672
|
+
* 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` *
|
|
2673
|
+
* `conversation_name` Example: "update_time desc" "create_time"
|
|
2674
|
+
*/
|
|
2675
|
+
orderBy?:
|
|
2676
|
+
string;
|
|
2677
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
1881
2678
|
pageSize?:
|
|
1882
2679
|
number;
|
|
1883
|
-
/**
|
|
2680
|
+
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
1884
2681
|
pageToken?:
|
|
1885
2682
|
string;
|
|
2683
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
2684
|
+
parent:
|
|
2685
|
+
string;
|
|
1886
2686
|
/** Returns response with indentations and line breaks. */
|
|
1887
2687
|
prettyPrint?:
|
|
1888
2688
|
boolean;
|
|
@@ -1895,15 +2695,9 @@ declare namespace gapi.client {
|
|
|
1895
2695
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1896
2696
|
uploadType?:
|
|
1897
2697
|
string;
|
|
1898
|
-
}): Request<
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
operations:
|
|
1902
|
-
OperationsResource;
|
|
1903
|
-
}
|
|
1904
|
-
interface ServingConfigsResource {
|
|
1905
|
-
/** Makes a recommendation, which requires a contextual user event. */
|
|
1906
|
-
recommend(request: {
|
|
2698
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
|
|
2699
|
+
/** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
|
|
2700
|
+
patch(request: {
|
|
1907
2701
|
/** V1 error format. */
|
|
1908
2702
|
"$.xgafv"?:
|
|
1909
2703
|
string;
|
|
@@ -1922,6 +2716,9 @@ declare namespace gapi.client {
|
|
|
1922
2716
|
/** 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. */
|
|
1923
2717
|
key?:
|
|
1924
2718
|
string;
|
|
2719
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` */
|
|
2720
|
+
name:
|
|
2721
|
+
string;
|
|
1925
2722
|
/** OAuth 2.0 token for the current user. */
|
|
1926
2723
|
oauth_token?:
|
|
1927
2724
|
string;
|
|
@@ -1931,11 +2728,8 @@ declare namespace gapi.client {
|
|
|
1931
2728
|
/** 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. */
|
|
1932
2729
|
quotaUser?:
|
|
1933
2730
|
string;
|
|
1934
|
-
/**
|
|
1935
|
-
|
|
1936
|
-
* you must create at least one serving config for it.
|
|
1937
|
-
*/
|
|
1938
|
-
servingConfig:
|
|
2731
|
+
/** 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. */
|
|
2732
|
+
updateMask?:
|
|
1939
2733
|
string;
|
|
1940
2734
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1941
2735
|
upload_protocol?:
|
|
@@ -1945,9 +2739,9 @@ declare namespace gapi.client {
|
|
|
1945
2739
|
string;
|
|
1946
2740
|
/** Request body */
|
|
1947
2741
|
resource:
|
|
1948
|
-
|
|
1949
|
-
}): Request<
|
|
1950
|
-
|
|
2742
|
+
GoogleCloudDiscoveryengineV1alphaConversation;
|
|
2743
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
2744
|
+
patch(request: {
|
|
1951
2745
|
/** V1 error format. */
|
|
1952
2746
|
"$.xgafv"?:
|
|
1953
2747
|
string;
|
|
@@ -1966,6 +2760,9 @@ declare namespace gapi.client {
|
|
|
1966
2760
|
/** 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. */
|
|
1967
2761
|
key?:
|
|
1968
2762
|
string;
|
|
2763
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` */
|
|
2764
|
+
name:
|
|
2765
|
+
string;
|
|
1969
2766
|
/** OAuth 2.0 token for the current user. */
|
|
1970
2767
|
oauth_token?:
|
|
1971
2768
|
string;
|
|
@@ -1975,11 +2772,8 @@ declare namespace gapi.client {
|
|
|
1975
2772
|
/** 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. */
|
|
1976
2773
|
quotaUser?:
|
|
1977
2774
|
string;
|
|
1978
|
-
/**
|
|
1979
|
-
|
|
1980
|
-
* you must create at least one serving config for it.
|
|
1981
|
-
*/
|
|
1982
|
-
servingConfig:
|
|
2775
|
+
/** 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. */
|
|
2776
|
+
updateMask?:
|
|
1983
2777
|
string;
|
|
1984
2778
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1985
2779
|
upload_protocol?:
|
|
@@ -1988,7 +2782,7 @@ declare namespace gapi.client {
|
|
|
1988
2782
|
uploadType?:
|
|
1989
2783
|
string;
|
|
1990
2784
|
},
|
|
1991
|
-
body:
|
|
2785
|
+
body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
1992
2786
|
}
|
|
1993
2787
|
interface OperationsResource {
|
|
1994
2788
|
/** 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. */
|
|
@@ -2079,6 +2873,10 @@ declare namespace gapi.client {
|
|
|
2079
2873
|
string;
|
|
2080
2874
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
2081
2875
|
}
|
|
2876
|
+
interface ModelsResource {
|
|
2877
|
+
operations:
|
|
2878
|
+
OperationsResource;
|
|
2879
|
+
}
|
|
2082
2880
|
interface OperationsResource {
|
|
2083
2881
|
/** 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. */
|
|
2084
2882
|
get(request?: {
|
|
@@ -2168,22 +2966,9 @@ declare namespace gapi.client {
|
|
|
2168
2966
|
string;
|
|
2169
2967
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
2170
2968
|
}
|
|
2171
|
-
interface
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
}
|
|
2175
|
-
interface SiteSearchEngineResource {
|
|
2176
|
-
operations:
|
|
2177
|
-
OperationsResource;
|
|
2178
|
-
targetSites:
|
|
2179
|
-
TargetSitesResource;
|
|
2180
|
-
}
|
|
2181
|
-
interface UserEventsResource {
|
|
2182
|
-
/**
|
|
2183
|
-
* Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
|
|
2184
|
-
* Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
|
2185
|
-
*/
|
|
2186
|
-
collect(request?: {
|
|
2969
|
+
interface OperationsResource {
|
|
2970
|
+
/** 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. */
|
|
2971
|
+
get(request?: {
|
|
2187
2972
|
/** V1 error format. */
|
|
2188
2973
|
"$.xgafv"?:
|
|
2189
2974
|
string;
|
|
@@ -2196,21 +2981,18 @@ declare namespace gapi.client {
|
|
|
2196
2981
|
/** JSONP */
|
|
2197
2982
|
callback?:
|
|
2198
2983
|
string;
|
|
2199
|
-
/** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
|
|
2200
|
-
ets?:
|
|
2201
|
-
string;
|
|
2202
2984
|
/** Selector specifying which fields to include in a partial response. */
|
|
2203
2985
|
fields?:
|
|
2204
2986
|
string;
|
|
2205
2987
|
/** 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. */
|
|
2206
2988
|
key?:
|
|
2207
2989
|
string;
|
|
2990
|
+
/** The name of the operation resource. */
|
|
2991
|
+
name:
|
|
2992
|
+
string;
|
|
2208
2993
|
/** OAuth 2.0 token for the current user. */
|
|
2209
2994
|
oauth_token?:
|
|
2210
2995
|
string;
|
|
2211
|
-
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
2212
|
-
parent:
|
|
2213
|
-
string;
|
|
2214
2996
|
/** Returns response with indentations and line breaks. */
|
|
2215
2997
|
prettyPrint?:
|
|
2216
2998
|
boolean;
|
|
@@ -2223,21 +3005,9 @@ declare namespace gapi.client {
|
|
|
2223
3005
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2224
3006
|
uploadType?:
|
|
2225
3007
|
string;
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
*/
|
|
2230
|
-
uri?:
|
|
2231
|
-
string;
|
|
2232
|
-
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
2233
|
-
userEvent?:
|
|
2234
|
-
string;
|
|
2235
|
-
}): Request<GoogleApiHttpBody>;
|
|
2236
|
-
/**
|
|
2237
|
-
* Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
|
|
2238
|
-
* Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
|
|
2239
|
-
*/
|
|
2240
|
-
import(request: {
|
|
3008
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3009
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
3010
|
+
list(request?: {
|
|
2241
3011
|
/** V1 error format. */
|
|
2242
3012
|
"$.xgafv"?:
|
|
2243
3013
|
string;
|
|
@@ -2253,14 +3023,23 @@ declare namespace gapi.client {
|
|
|
2253
3023
|
/** Selector specifying which fields to include in a partial response. */
|
|
2254
3024
|
fields?:
|
|
2255
3025
|
string;
|
|
3026
|
+
/** The standard list filter. */
|
|
3027
|
+
filter?:
|
|
3028
|
+
string;
|
|
2256
3029
|
/** 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. */
|
|
2257
3030
|
key?:
|
|
2258
3031
|
string;
|
|
3032
|
+
/** The name of the operation's parent resource. */
|
|
3033
|
+
name:
|
|
3034
|
+
string;
|
|
2259
3035
|
/** OAuth 2.0 token for the current user. */
|
|
2260
3036
|
oauth_token?:
|
|
2261
3037
|
string;
|
|
2262
|
-
/**
|
|
2263
|
-
|
|
3038
|
+
/** The standard list page size. */
|
|
3039
|
+
pageSize?:
|
|
3040
|
+
number;
|
|
3041
|
+
/** The standard list page token. */
|
|
3042
|
+
pageToken?:
|
|
2264
3043
|
string;
|
|
2265
3044
|
/** Returns response with indentations and line breaks. */
|
|
2266
3045
|
prettyPrint?:
|
|
@@ -2274,11 +3053,11 @@ declare namespace gapi.client {
|
|
|
2274
3053
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2275
3054
|
uploadType?:
|
|
2276
3055
|
string;
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
3056
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
3057
|
+
}
|
|
3058
|
+
interface SchemasResource {
|
|
3059
|
+
/** Creates a Schema. */
|
|
3060
|
+
create(request: {
|
|
2282
3061
|
/** V1 error format. */
|
|
2283
3062
|
"$.xgafv"?:
|
|
2284
3063
|
string;
|
|
@@ -2300,7 +3079,7 @@ declare namespace gapi.client {
|
|
|
2300
3079
|
/** OAuth 2.0 token for the current user. */
|
|
2301
3080
|
oauth_token?:
|
|
2302
3081
|
string;
|
|
2303
|
-
/** Required.
|
|
3082
|
+
/** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
2304
3083
|
parent:
|
|
2305
3084
|
string;
|
|
2306
3085
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2309,19 +3088,23 @@ declare namespace gapi.client {
|
|
|
2309
3088
|
/** 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. */
|
|
2310
3089
|
quotaUser?:
|
|
2311
3090
|
string;
|
|
3091
|
+
/**
|
|
3092
|
+
* Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
3093
|
+
* standard with a length limit of 63 characters.
|
|
3094
|
+
*/
|
|
3095
|
+
schemaId?:
|
|
3096
|
+
string;
|
|
2312
3097
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2313
3098
|
upload_protocol?:
|
|
2314
3099
|
string;
|
|
2315
3100
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2316
3101
|
uploadType?:
|
|
2317
3102
|
string;
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
*/
|
|
2324
|
-
purge(request: {
|
|
3103
|
+
/** Request body */
|
|
3104
|
+
resource:
|
|
3105
|
+
GoogleCloudDiscoveryengineV1alphaSchema;
|
|
3106
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3107
|
+
create(request: {
|
|
2325
3108
|
/** V1 error format. */
|
|
2326
3109
|
"$.xgafv"?:
|
|
2327
3110
|
string;
|
|
@@ -2343,10 +3126,7 @@ declare namespace gapi.client {
|
|
|
2343
3126
|
/** OAuth 2.0 token for the current user. */
|
|
2344
3127
|
oauth_token?:
|
|
2345
3128
|
string;
|
|
2346
|
-
/**
|
|
2347
|
-
* Required. The resource name of the catalog under which the events are created. The format is
|
|
2348
|
-
* `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
|
|
2349
|
-
*/
|
|
3129
|
+
/** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
2350
3130
|
parent:
|
|
2351
3131
|
string;
|
|
2352
3132
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2355,17 +3135,22 @@ declare namespace gapi.client {
|
|
|
2355
3135
|
/** 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. */
|
|
2356
3136
|
quotaUser?:
|
|
2357
3137
|
string;
|
|
3138
|
+
/**
|
|
3139
|
+
* Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
3140
|
+
* standard with a length limit of 63 characters.
|
|
3141
|
+
*/
|
|
3142
|
+
schemaId?:
|
|
3143
|
+
string;
|
|
2358
3144
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2359
3145
|
upload_protocol?:
|
|
2360
3146
|
string;
|
|
2361
3147
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2362
3148
|
uploadType?:
|
|
2363
3149
|
string;
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
purge(request: {
|
|
3150
|
+
},
|
|
3151
|
+
body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
|
|
3152
|
+
/** Deletes a Schema. */
|
|
3153
|
+
delete(request?: {
|
|
2369
3154
|
/** V1 error format. */
|
|
2370
3155
|
"$.xgafv"?:
|
|
2371
3156
|
string;
|
|
@@ -2384,15 +3169,12 @@ declare namespace gapi.client {
|
|
|
2384
3169
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2385
3170
|
key?:
|
|
2386
3171
|
string;
|
|
3172
|
+
/** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
|
|
3173
|
+
name:
|
|
3174
|
+
string;
|
|
2387
3175
|
/** OAuth 2.0 token for the current user. */
|
|
2388
3176
|
oauth_token?:
|
|
2389
3177
|
string;
|
|
2390
|
-
/**
|
|
2391
|
-
* Required. The resource name of the catalog under which the events are created. The format is
|
|
2392
|
-
* `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
|
|
2393
|
-
*/
|
|
2394
|
-
parent:
|
|
2395
|
-
string;
|
|
2396
3178
|
/** Returns response with indentations and line breaks. */
|
|
2397
3179
|
prettyPrint?:
|
|
2398
3180
|
boolean;
|
|
@@ -2405,10 +3187,9 @@ declare namespace gapi.client {
|
|
|
2405
3187
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2406
3188
|
uploadType?:
|
|
2407
3189
|
string;
|
|
2408
|
-
}
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
write(request: {
|
|
3190
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3191
|
+
/** Gets a Schema. */
|
|
3192
|
+
get(request?: {
|
|
2412
3193
|
/** V1 error format. */
|
|
2413
3194
|
"$.xgafv"?:
|
|
2414
3195
|
string;
|
|
@@ -2427,12 +3208,12 @@ declare namespace gapi.client {
|
|
|
2427
3208
|
/** 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. */
|
|
2428
3209
|
key?:
|
|
2429
3210
|
string;
|
|
3211
|
+
/** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
|
|
3212
|
+
name:
|
|
3213
|
+
string;
|
|
2430
3214
|
/** OAuth 2.0 token for the current user. */
|
|
2431
3215
|
oauth_token?:
|
|
2432
3216
|
string;
|
|
2433
|
-
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
2434
|
-
parent:
|
|
2435
|
-
string;
|
|
2436
3217
|
/** Returns response with indentations and line breaks. */
|
|
2437
3218
|
prettyPrint?:
|
|
2438
3219
|
boolean;
|
|
@@ -2445,8 +3226,789 @@ declare namespace gapi.client {
|
|
|
2445
3226
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2446
3227
|
uploadType?:
|
|
2447
3228
|
string;
|
|
2448
|
-
|
|
2449
|
-
|
|
3229
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSchema>;
|
|
3230
|
+
/** Gets a list of Schemas. */
|
|
3231
|
+
list(request?: {
|
|
3232
|
+
/** V1 error format. */
|
|
3233
|
+
"$.xgafv"?:
|
|
3234
|
+
string;
|
|
3235
|
+
/** OAuth access token. */
|
|
3236
|
+
access_token?:
|
|
3237
|
+
string;
|
|
3238
|
+
/** Data format for response. */
|
|
3239
|
+
alt?:
|
|
3240
|
+
string;
|
|
3241
|
+
/** JSONP */
|
|
3242
|
+
callback?:
|
|
3243
|
+
string;
|
|
3244
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3245
|
+
fields?:
|
|
3246
|
+
string;
|
|
3247
|
+
/** 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. */
|
|
3248
|
+
key?:
|
|
3249
|
+
string;
|
|
3250
|
+
/** OAuth 2.0 token for the current user. */
|
|
3251
|
+
oauth_token?:
|
|
3252
|
+
string;
|
|
3253
|
+
/**
|
|
3254
|
+
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values
|
|
3255
|
+
* above 1000 will be coerced to 1000.
|
|
3256
|
+
*/
|
|
3257
|
+
pageSize?:
|
|
3258
|
+
number;
|
|
3259
|
+
/**
|
|
3260
|
+
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
3261
|
+
* SchemaService.ListSchemas must match the call that provided the page token.
|
|
3262
|
+
*/
|
|
3263
|
+
pageToken?:
|
|
3264
|
+
string;
|
|
3265
|
+
/** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
3266
|
+
parent:
|
|
3267
|
+
string;
|
|
3268
|
+
/** Returns response with indentations and line breaks. */
|
|
3269
|
+
prettyPrint?:
|
|
3270
|
+
boolean;
|
|
3271
|
+
/** 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. */
|
|
3272
|
+
quotaUser?:
|
|
3273
|
+
string;
|
|
3274
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3275
|
+
upload_protocol?:
|
|
3276
|
+
string;
|
|
3277
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3278
|
+
uploadType?:
|
|
3279
|
+
string;
|
|
3280
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSchemasResponse>;
|
|
3281
|
+
/** Updates a Schema. */
|
|
3282
|
+
patch(request: {
|
|
3283
|
+
/** V1 error format. */
|
|
3284
|
+
"$.xgafv"?:
|
|
3285
|
+
string;
|
|
3286
|
+
/** OAuth access token. */
|
|
3287
|
+
access_token?:
|
|
3288
|
+
string;
|
|
3289
|
+
/** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
|
|
3290
|
+
allowMissing?:
|
|
3291
|
+
boolean;
|
|
3292
|
+
/** Data format for response. */
|
|
3293
|
+
alt?:
|
|
3294
|
+
string;
|
|
3295
|
+
/** JSONP */
|
|
3296
|
+
callback?:
|
|
3297
|
+
string;
|
|
3298
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3299
|
+
fields?:
|
|
3300
|
+
string;
|
|
3301
|
+
/** 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. */
|
|
3302
|
+
key?:
|
|
3303
|
+
string;
|
|
3304
|
+
/**
|
|
3305
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
|
3306
|
+
* This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3307
|
+
*/
|
|
3308
|
+
name:
|
|
3309
|
+
string;
|
|
3310
|
+
/** OAuth 2.0 token for the current user. */
|
|
3311
|
+
oauth_token?:
|
|
3312
|
+
string;
|
|
3313
|
+
/** Returns response with indentations and line breaks. */
|
|
3314
|
+
prettyPrint?:
|
|
3315
|
+
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?:
|
|
3318
|
+
string;
|
|
3319
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3320
|
+
upload_protocol?:
|
|
3321
|
+
string;
|
|
3322
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3323
|
+
uploadType?:
|
|
3324
|
+
string;
|
|
3325
|
+
/** Request body */
|
|
3326
|
+
resource:
|
|
3327
|
+
GoogleCloudDiscoveryengineV1alphaSchema;
|
|
3328
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3329
|
+
patch(request: {
|
|
3330
|
+
/** V1 error format. */
|
|
3331
|
+
"$.xgafv"?:
|
|
3332
|
+
string;
|
|
3333
|
+
/** OAuth access token. */
|
|
3334
|
+
access_token?:
|
|
3335
|
+
string;
|
|
3336
|
+
/** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
|
|
3337
|
+
allowMissing?:
|
|
3338
|
+
boolean;
|
|
3339
|
+
/** Data format for response. */
|
|
3340
|
+
alt?:
|
|
3341
|
+
string;
|
|
3342
|
+
/** JSONP */
|
|
3343
|
+
callback?:
|
|
3344
|
+
string;
|
|
3345
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3346
|
+
fields?:
|
|
3347
|
+
string;
|
|
3348
|
+
/** 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. */
|
|
3349
|
+
key?:
|
|
3350
|
+
string;
|
|
3351
|
+
/**
|
|
3352
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
|
3353
|
+
* This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3354
|
+
*/
|
|
3355
|
+
name:
|
|
3356
|
+
string;
|
|
3357
|
+
/** OAuth 2.0 token for the current user. */
|
|
3358
|
+
oauth_token?:
|
|
3359
|
+
string;
|
|
3360
|
+
/** Returns response with indentations and line breaks. */
|
|
3361
|
+
prettyPrint?:
|
|
3362
|
+
boolean;
|
|
3363
|
+
/** 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. */
|
|
3364
|
+
quotaUser?:
|
|
3365
|
+
string;
|
|
3366
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3367
|
+
upload_protocol?:
|
|
3368
|
+
string;
|
|
3369
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3370
|
+
uploadType?:
|
|
3371
|
+
string;
|
|
3372
|
+
},
|
|
3373
|
+
body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
|
|
3374
|
+
operations:
|
|
3375
|
+
OperationsResource;
|
|
3376
|
+
}
|
|
3377
|
+
interface ServingConfigsResource {
|
|
3378
|
+
/** Makes a recommendation, which requires a contextual user event. */
|
|
3379
|
+
recommend(request: {
|
|
3380
|
+
/** V1 error format. */
|
|
3381
|
+
"$.xgafv"?:
|
|
3382
|
+
string;
|
|
3383
|
+
/** OAuth access token. */
|
|
3384
|
+
access_token?:
|
|
3385
|
+
string;
|
|
3386
|
+
/** Data format for response. */
|
|
3387
|
+
alt?:
|
|
3388
|
+
string;
|
|
3389
|
+
/** JSONP */
|
|
3390
|
+
callback?:
|
|
3391
|
+
string;
|
|
3392
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3393
|
+
fields?:
|
|
3394
|
+
string;
|
|
3395
|
+
/** 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
|
+
key?:
|
|
3397
|
+
string;
|
|
3398
|
+
/** OAuth 2.0 token for the current user. */
|
|
3399
|
+
oauth_token?:
|
|
3400
|
+
string;
|
|
3401
|
+
/** Returns response with indentations and line breaks. */
|
|
3402
|
+
prettyPrint?:
|
|
3403
|
+
boolean;
|
|
3404
|
+
/** 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. */
|
|
3405
|
+
quotaUser?:
|
|
3406
|
+
string;
|
|
3407
|
+
/**
|
|
3408
|
+
* Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model,
|
|
3409
|
+
* you must create at least one serving config for it.
|
|
3410
|
+
*/
|
|
3411
|
+
servingConfig:
|
|
3412
|
+
string;
|
|
3413
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3414
|
+
upload_protocol?:
|
|
3415
|
+
string;
|
|
3416
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3417
|
+
uploadType?:
|
|
3418
|
+
string;
|
|
3419
|
+
/** Request body */
|
|
3420
|
+
resource:
|
|
3421
|
+
GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
3422
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
3423
|
+
recommend(request: {
|
|
3424
|
+
/** V1 error format. */
|
|
3425
|
+
"$.xgafv"?:
|
|
3426
|
+
string;
|
|
3427
|
+
/** OAuth access token. */
|
|
3428
|
+
access_token?:
|
|
3429
|
+
string;
|
|
3430
|
+
/** Data format for response. */
|
|
3431
|
+
alt?:
|
|
3432
|
+
string;
|
|
3433
|
+
/** JSONP */
|
|
3434
|
+
callback?:
|
|
3435
|
+
string;
|
|
3436
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3437
|
+
fields?:
|
|
3438
|
+
string;
|
|
3439
|
+
/** 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. */
|
|
3440
|
+
key?:
|
|
3441
|
+
string;
|
|
3442
|
+
/** OAuth 2.0 token for the current user. */
|
|
3443
|
+
oauth_token?:
|
|
3444
|
+
string;
|
|
3445
|
+
/** Returns response with indentations and line breaks. */
|
|
3446
|
+
prettyPrint?:
|
|
3447
|
+
boolean;
|
|
3448
|
+
/** 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. */
|
|
3449
|
+
quotaUser?:
|
|
3450
|
+
string;
|
|
3451
|
+
/**
|
|
3452
|
+
* Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model,
|
|
3453
|
+
* you must create at least one serving config for it.
|
|
3454
|
+
*/
|
|
3455
|
+
servingConfig:
|
|
3456
|
+
string;
|
|
3457
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3458
|
+
upload_protocol?:
|
|
3459
|
+
string;
|
|
3460
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3461
|
+
uploadType?:
|
|
3462
|
+
string;
|
|
3463
|
+
},
|
|
3464
|
+
body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
3465
|
+
/** Performs a search. */
|
|
3466
|
+
search(request: {
|
|
3467
|
+
/** V1 error format. */
|
|
3468
|
+
"$.xgafv"?:
|
|
3469
|
+
string;
|
|
3470
|
+
/** OAuth access token. */
|
|
3471
|
+
access_token?:
|
|
3472
|
+
string;
|
|
3473
|
+
/** Data format for response. */
|
|
3474
|
+
alt?:
|
|
3475
|
+
string;
|
|
3476
|
+
/** JSONP */
|
|
3477
|
+
callback?:
|
|
3478
|
+
string;
|
|
3479
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3480
|
+
fields?:
|
|
3481
|
+
string;
|
|
3482
|
+
/** 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. */
|
|
3483
|
+
key?:
|
|
3484
|
+
string;
|
|
3485
|
+
/** OAuth 2.0 token for the current user. */
|
|
3486
|
+
oauth_token?:
|
|
3487
|
+
string;
|
|
3488
|
+
/** Returns response with indentations and line breaks. */
|
|
3489
|
+
prettyPrint?:
|
|
3490
|
+
boolean;
|
|
3491
|
+
/** 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. */
|
|
3492
|
+
quotaUser?:
|
|
3493
|
+
string;
|
|
3494
|
+
/**
|
|
3495
|
+
* Required. The resource name of the Search serving config, such as
|
|
3496
|
+
* `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
|
|
3497
|
+
* configuration name, set of models used to make the search.
|
|
3498
|
+
*/
|
|
3499
|
+
servingConfig:
|
|
3500
|
+
string;
|
|
3501
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3502
|
+
upload_protocol?:
|
|
3503
|
+
string;
|
|
3504
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3505
|
+
uploadType?:
|
|
3506
|
+
string;
|
|
3507
|
+
/** Request body */
|
|
3508
|
+
resource:
|
|
3509
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
3510
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
3511
|
+
search(request: {
|
|
3512
|
+
/** V1 error format. */
|
|
3513
|
+
"$.xgafv"?:
|
|
3514
|
+
string;
|
|
3515
|
+
/** OAuth access token. */
|
|
3516
|
+
access_token?:
|
|
3517
|
+
string;
|
|
3518
|
+
/** Data format for response. */
|
|
3519
|
+
alt?:
|
|
3520
|
+
string;
|
|
3521
|
+
/** JSONP */
|
|
3522
|
+
callback?:
|
|
3523
|
+
string;
|
|
3524
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3525
|
+
fields?:
|
|
3526
|
+
string;
|
|
3527
|
+
/** 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. */
|
|
3528
|
+
key?:
|
|
3529
|
+
string;
|
|
3530
|
+
/** OAuth 2.0 token for the current user. */
|
|
3531
|
+
oauth_token?:
|
|
3532
|
+
string;
|
|
3533
|
+
/** Returns response with indentations and line breaks. */
|
|
3534
|
+
prettyPrint?:
|
|
3535
|
+
boolean;
|
|
3536
|
+
/** 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. */
|
|
3537
|
+
quotaUser?:
|
|
3538
|
+
string;
|
|
3539
|
+
/**
|
|
3540
|
+
* Required. The resource name of the Search serving config, such as
|
|
3541
|
+
* `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
|
|
3542
|
+
* configuration name, set of models used to make the search.
|
|
3543
|
+
*/
|
|
3544
|
+
servingConfig:
|
|
3545
|
+
string;
|
|
3546
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3547
|
+
upload_protocol?:
|
|
3548
|
+
string;
|
|
3549
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3550
|
+
uploadType?:
|
|
3551
|
+
string;
|
|
3552
|
+
},
|
|
3553
|
+
body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
3554
|
+
}
|
|
3555
|
+
interface OperationsResource {
|
|
3556
|
+
/** 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. */
|
|
3557
|
+
get(request?: {
|
|
3558
|
+
/** V1 error format. */
|
|
3559
|
+
"$.xgafv"?:
|
|
3560
|
+
string;
|
|
3561
|
+
/** OAuth access token. */
|
|
3562
|
+
access_token?:
|
|
3563
|
+
string;
|
|
3564
|
+
/** Data format for response. */
|
|
3565
|
+
alt?:
|
|
3566
|
+
string;
|
|
3567
|
+
/** JSONP */
|
|
3568
|
+
callback?:
|
|
3569
|
+
string;
|
|
3570
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3571
|
+
fields?:
|
|
3572
|
+
string;
|
|
3573
|
+
/** 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. */
|
|
3574
|
+
key?:
|
|
3575
|
+
string;
|
|
3576
|
+
/** The name of the operation resource. */
|
|
3577
|
+
name:
|
|
3578
|
+
string;
|
|
3579
|
+
/** OAuth 2.0 token for the current user. */
|
|
3580
|
+
oauth_token?:
|
|
3581
|
+
string;
|
|
3582
|
+
/** Returns response with indentations and line breaks. */
|
|
3583
|
+
prettyPrint?:
|
|
3584
|
+
boolean;
|
|
3585
|
+
/** 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. */
|
|
3586
|
+
quotaUser?:
|
|
3587
|
+
string;
|
|
3588
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3589
|
+
upload_protocol?:
|
|
3590
|
+
string;
|
|
3591
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3592
|
+
uploadType?:
|
|
3593
|
+
string;
|
|
3594
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3595
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
3596
|
+
list(request?: {
|
|
3597
|
+
/** V1 error format. */
|
|
3598
|
+
"$.xgafv"?:
|
|
3599
|
+
string;
|
|
3600
|
+
/** OAuth access token. */
|
|
3601
|
+
access_token?:
|
|
3602
|
+
string;
|
|
3603
|
+
/** Data format for response. */
|
|
3604
|
+
alt?:
|
|
3605
|
+
string;
|
|
3606
|
+
/** JSONP */
|
|
3607
|
+
callback?:
|
|
3608
|
+
string;
|
|
3609
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3610
|
+
fields?:
|
|
3611
|
+
string;
|
|
3612
|
+
/** The standard list filter. */
|
|
3613
|
+
filter?:
|
|
3614
|
+
string;
|
|
3615
|
+
/** 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. */
|
|
3616
|
+
key?:
|
|
3617
|
+
string;
|
|
3618
|
+
/** The name of the operation's parent resource. */
|
|
3619
|
+
name:
|
|
3620
|
+
string;
|
|
3621
|
+
/** OAuth 2.0 token for the current user. */
|
|
3622
|
+
oauth_token?:
|
|
3623
|
+
string;
|
|
3624
|
+
/** The standard list page size. */
|
|
3625
|
+
pageSize?:
|
|
3626
|
+
number;
|
|
3627
|
+
/** The standard list page token. */
|
|
3628
|
+
pageToken?:
|
|
3629
|
+
string;
|
|
3630
|
+
/** Returns response with indentations and line breaks. */
|
|
3631
|
+
prettyPrint?:
|
|
3632
|
+
boolean;
|
|
3633
|
+
/** 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. */
|
|
3634
|
+
quotaUser?:
|
|
3635
|
+
string;
|
|
3636
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3637
|
+
upload_protocol?:
|
|
3638
|
+
string;
|
|
3639
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3640
|
+
uploadType?:
|
|
3641
|
+
string;
|
|
3642
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
3643
|
+
}
|
|
3644
|
+
interface OperationsResource {
|
|
3645
|
+
/** 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. */
|
|
3646
|
+
get(request?: {
|
|
3647
|
+
/** V1 error format. */
|
|
3648
|
+
"$.xgafv"?:
|
|
3649
|
+
string;
|
|
3650
|
+
/** OAuth access token. */
|
|
3651
|
+
access_token?:
|
|
3652
|
+
string;
|
|
3653
|
+
/** Data format for response. */
|
|
3654
|
+
alt?:
|
|
3655
|
+
string;
|
|
3656
|
+
/** JSONP */
|
|
3657
|
+
callback?:
|
|
3658
|
+
string;
|
|
3659
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3660
|
+
fields?:
|
|
3661
|
+
string;
|
|
3662
|
+
/** 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. */
|
|
3663
|
+
key?:
|
|
3664
|
+
string;
|
|
3665
|
+
/** The name of the operation resource. */
|
|
3666
|
+
name:
|
|
3667
|
+
string;
|
|
3668
|
+
/** OAuth 2.0 token for the current user. */
|
|
3669
|
+
oauth_token?:
|
|
3670
|
+
string;
|
|
3671
|
+
/** Returns response with indentations and line breaks. */
|
|
3672
|
+
prettyPrint?:
|
|
3673
|
+
boolean;
|
|
3674
|
+
/** 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. */
|
|
3675
|
+
quotaUser?:
|
|
3676
|
+
string;
|
|
3677
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3678
|
+
upload_protocol?:
|
|
3679
|
+
string;
|
|
3680
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3681
|
+
uploadType?:
|
|
3682
|
+
string;
|
|
3683
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3684
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
3685
|
+
list(request?: {
|
|
3686
|
+
/** V1 error format. */
|
|
3687
|
+
"$.xgafv"?:
|
|
3688
|
+
string;
|
|
3689
|
+
/** OAuth access token. */
|
|
3690
|
+
access_token?:
|
|
3691
|
+
string;
|
|
3692
|
+
/** Data format for response. */
|
|
3693
|
+
alt?:
|
|
3694
|
+
string;
|
|
3695
|
+
/** JSONP */
|
|
3696
|
+
callback?:
|
|
3697
|
+
string;
|
|
3698
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3699
|
+
fields?:
|
|
3700
|
+
string;
|
|
3701
|
+
/** The standard list filter. */
|
|
3702
|
+
filter?:
|
|
3703
|
+
string;
|
|
3704
|
+
/** 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. */
|
|
3705
|
+
key?:
|
|
3706
|
+
string;
|
|
3707
|
+
/** The name of the operation's parent resource. */
|
|
3708
|
+
name:
|
|
3709
|
+
string;
|
|
3710
|
+
/** OAuth 2.0 token for the current user. */
|
|
3711
|
+
oauth_token?:
|
|
3712
|
+
string;
|
|
3713
|
+
/** The standard list page size. */
|
|
3714
|
+
pageSize?:
|
|
3715
|
+
number;
|
|
3716
|
+
/** The standard list page token. */
|
|
3717
|
+
pageToken?:
|
|
3718
|
+
string;
|
|
3719
|
+
/** Returns response with indentations and line breaks. */
|
|
3720
|
+
prettyPrint?:
|
|
3721
|
+
boolean;
|
|
3722
|
+
/** 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. */
|
|
3723
|
+
quotaUser?:
|
|
3724
|
+
string;
|
|
3725
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3726
|
+
upload_protocol?:
|
|
3727
|
+
string;
|
|
3728
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3729
|
+
uploadType?:
|
|
3730
|
+
string;
|
|
3731
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
3732
|
+
}
|
|
3733
|
+
interface TargetSitesResource {
|
|
3734
|
+
operations:
|
|
3735
|
+
OperationsResource;
|
|
3736
|
+
}
|
|
3737
|
+
interface SiteSearchEngineResource {
|
|
3738
|
+
operations:
|
|
3739
|
+
OperationsResource;
|
|
3740
|
+
targetSites:
|
|
3741
|
+
TargetSitesResource;
|
|
3742
|
+
}
|
|
3743
|
+
interface UserEventsResource {
|
|
3744
|
+
/**
|
|
3745
|
+
* Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
|
|
3746
|
+
* Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
|
3747
|
+
*/
|
|
3748
|
+
collect(request?: {
|
|
3749
|
+
/** V1 error format. */
|
|
3750
|
+
"$.xgafv"?:
|
|
3751
|
+
string;
|
|
3752
|
+
/** OAuth access token. */
|
|
3753
|
+
access_token?:
|
|
3754
|
+
string;
|
|
3755
|
+
/** Data format for response. */
|
|
3756
|
+
alt?:
|
|
3757
|
+
string;
|
|
3758
|
+
/** JSONP */
|
|
3759
|
+
callback?:
|
|
3760
|
+
string;
|
|
3761
|
+
/** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
|
|
3762
|
+
ets?:
|
|
3763
|
+
string;
|
|
3764
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3765
|
+
fields?:
|
|
3766
|
+
string;
|
|
3767
|
+
/** 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. */
|
|
3768
|
+
key?:
|
|
3769
|
+
string;
|
|
3770
|
+
/** OAuth 2.0 token for the current user. */
|
|
3771
|
+
oauth_token?:
|
|
3772
|
+
string;
|
|
3773
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
3774
|
+
parent:
|
|
3775
|
+
string;
|
|
3776
|
+
/** Returns response with indentations and line breaks. */
|
|
3777
|
+
prettyPrint?:
|
|
3778
|
+
boolean;
|
|
3779
|
+
/** 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. */
|
|
3780
|
+
quotaUser?:
|
|
3781
|
+
string;
|
|
3782
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3783
|
+
upload_protocol?:
|
|
3784
|
+
string;
|
|
3785
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3786
|
+
uploadType?:
|
|
3787
|
+
string;
|
|
3788
|
+
/**
|
|
3789
|
+
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
|
|
3790
|
+
* only send the domain for third-party requests.
|
|
3791
|
+
*/
|
|
3792
|
+
uri?:
|
|
3793
|
+
string;
|
|
3794
|
+
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
3795
|
+
userEvent?:
|
|
3796
|
+
string;
|
|
3797
|
+
}): Request<GoogleApiHttpBody>;
|
|
3798
|
+
/**
|
|
3799
|
+
* Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
|
|
3800
|
+
* Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
|
|
3801
|
+
*/
|
|
3802
|
+
import(request: {
|
|
3803
|
+
/** V1 error format. */
|
|
3804
|
+
"$.xgafv"?:
|
|
3805
|
+
string;
|
|
3806
|
+
/** OAuth access token. */
|
|
3807
|
+
access_token?:
|
|
3808
|
+
string;
|
|
3809
|
+
/** Data format for response. */
|
|
3810
|
+
alt?:
|
|
3811
|
+
string;
|
|
3812
|
+
/** JSONP */
|
|
3813
|
+
callback?:
|
|
3814
|
+
string;
|
|
3815
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3816
|
+
fields?:
|
|
3817
|
+
string;
|
|
3818
|
+
/** 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. */
|
|
3819
|
+
key?:
|
|
3820
|
+
string;
|
|
3821
|
+
/** OAuth 2.0 token for the current user. */
|
|
3822
|
+
oauth_token?:
|
|
3823
|
+
string;
|
|
3824
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
3825
|
+
parent:
|
|
3826
|
+
string;
|
|
3827
|
+
/** Returns response with indentations and line breaks. */
|
|
3828
|
+
prettyPrint?:
|
|
3829
|
+
boolean;
|
|
3830
|
+
/** 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. */
|
|
3831
|
+
quotaUser?:
|
|
3832
|
+
string;
|
|
3833
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3834
|
+
upload_protocol?:
|
|
3835
|
+
string;
|
|
3836
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3837
|
+
uploadType?:
|
|
3838
|
+
string;
|
|
3839
|
+
/** Request body */
|
|
3840
|
+
resource:
|
|
3841
|
+
GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
|
|
3842
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3843
|
+
import(request: {
|
|
3844
|
+
/** V1 error format. */
|
|
3845
|
+
"$.xgafv"?:
|
|
3846
|
+
string;
|
|
3847
|
+
/** OAuth access token. */
|
|
3848
|
+
access_token?:
|
|
3849
|
+
string;
|
|
3850
|
+
/** Data format for response. */
|
|
3851
|
+
alt?:
|
|
3852
|
+
string;
|
|
3853
|
+
/** JSONP */
|
|
3854
|
+
callback?:
|
|
3855
|
+
string;
|
|
3856
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3857
|
+
fields?:
|
|
3858
|
+
string;
|
|
3859
|
+
/** 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. */
|
|
3860
|
+
key?:
|
|
3861
|
+
string;
|
|
3862
|
+
/** OAuth 2.0 token for the current user. */
|
|
3863
|
+
oauth_token?:
|
|
3864
|
+
string;
|
|
3865
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
3866
|
+
parent:
|
|
3867
|
+
string;
|
|
3868
|
+
/** Returns response with indentations and line breaks. */
|
|
3869
|
+
prettyPrint?:
|
|
3870
|
+
boolean;
|
|
3871
|
+
/** 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. */
|
|
3872
|
+
quotaUser?:
|
|
3873
|
+
string;
|
|
3874
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3875
|
+
upload_protocol?:
|
|
3876
|
+
string;
|
|
3877
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3878
|
+
uploadType?:
|
|
3879
|
+
string;
|
|
3880
|
+
},
|
|
3881
|
+
body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
|
|
3882
|
+
/**
|
|
3883
|
+
* Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete.
|
|
3884
|
+
* To test a filter, use the list command first.
|
|
3885
|
+
*/
|
|
3886
|
+
purge(request: {
|
|
3887
|
+
/** V1 error format. */
|
|
3888
|
+
"$.xgafv"?:
|
|
3889
|
+
string;
|
|
3890
|
+
/** OAuth access token. */
|
|
3891
|
+
access_token?:
|
|
3892
|
+
string;
|
|
3893
|
+
/** Data format for response. */
|
|
3894
|
+
alt?:
|
|
3895
|
+
string;
|
|
3896
|
+
/** JSONP */
|
|
3897
|
+
callback?:
|
|
3898
|
+
string;
|
|
3899
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3900
|
+
fields?:
|
|
3901
|
+
string;
|
|
3902
|
+
/** 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. */
|
|
3903
|
+
key?:
|
|
3904
|
+
string;
|
|
3905
|
+
/** OAuth 2.0 token for the current user. */
|
|
3906
|
+
oauth_token?:
|
|
3907
|
+
string;
|
|
3908
|
+
/**
|
|
3909
|
+
* Required. The resource name of the catalog under which the events are created. The format is
|
|
3910
|
+
* `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
|
|
3911
|
+
*/
|
|
3912
|
+
parent:
|
|
3913
|
+
string;
|
|
3914
|
+
/** Returns response with indentations and line breaks. */
|
|
3915
|
+
prettyPrint?:
|
|
3916
|
+
boolean;
|
|
3917
|
+
/** 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. */
|
|
3918
|
+
quotaUser?:
|
|
3919
|
+
string;
|
|
3920
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3921
|
+
upload_protocol?:
|
|
3922
|
+
string;
|
|
3923
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3924
|
+
uploadType?:
|
|
3925
|
+
string;
|
|
3926
|
+
/** Request body */
|
|
3927
|
+
resource:
|
|
3928
|
+
GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
|
|
3929
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3930
|
+
purge(request: {
|
|
3931
|
+
/** V1 error format. */
|
|
3932
|
+
"$.xgafv"?:
|
|
3933
|
+
string;
|
|
3934
|
+
/** OAuth access token. */
|
|
3935
|
+
access_token?:
|
|
3936
|
+
string;
|
|
3937
|
+
/** Data format for response. */
|
|
3938
|
+
alt?:
|
|
3939
|
+
string;
|
|
3940
|
+
/** JSONP */
|
|
3941
|
+
callback?:
|
|
3942
|
+
string;
|
|
3943
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3944
|
+
fields?:
|
|
3945
|
+
string;
|
|
3946
|
+
/** 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. */
|
|
3947
|
+
key?:
|
|
3948
|
+
string;
|
|
3949
|
+
/** OAuth 2.0 token for the current user. */
|
|
3950
|
+
oauth_token?:
|
|
3951
|
+
string;
|
|
3952
|
+
/**
|
|
3953
|
+
* Required. The resource name of the catalog under which the events are created. The format is
|
|
3954
|
+
* `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
|
|
3955
|
+
*/
|
|
3956
|
+
parent:
|
|
3957
|
+
string;
|
|
3958
|
+
/** Returns response with indentations and line breaks. */
|
|
3959
|
+
prettyPrint?:
|
|
3960
|
+
boolean;
|
|
3961
|
+
/** 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. */
|
|
3962
|
+
quotaUser?:
|
|
3963
|
+
string;
|
|
3964
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3965
|
+
upload_protocol?:
|
|
3966
|
+
string;
|
|
3967
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3968
|
+
uploadType?:
|
|
3969
|
+
string;
|
|
3970
|
+
},
|
|
3971
|
+
body: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
|
|
3972
|
+
/** Writes a single user event. */
|
|
3973
|
+
write(request: {
|
|
3974
|
+
/** V1 error format. */
|
|
3975
|
+
"$.xgafv"?:
|
|
3976
|
+
string;
|
|
3977
|
+
/** OAuth access token. */
|
|
3978
|
+
access_token?:
|
|
3979
|
+
string;
|
|
3980
|
+
/** Data format for response. */
|
|
3981
|
+
alt?:
|
|
3982
|
+
string;
|
|
3983
|
+
/** JSONP */
|
|
3984
|
+
callback?:
|
|
3985
|
+
string;
|
|
3986
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3987
|
+
fields?:
|
|
3988
|
+
string;
|
|
3989
|
+
/** 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. */
|
|
3990
|
+
key?:
|
|
3991
|
+
string;
|
|
3992
|
+
/** OAuth 2.0 token for the current user. */
|
|
3993
|
+
oauth_token?:
|
|
3994
|
+
string;
|
|
3995
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
3996
|
+
parent:
|
|
3997
|
+
string;
|
|
3998
|
+
/** Returns response with indentations and line breaks. */
|
|
3999
|
+
prettyPrint?:
|
|
4000
|
+
boolean;
|
|
4001
|
+
/** 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. */
|
|
4002
|
+
quotaUser?:
|
|
4003
|
+
string;
|
|
4004
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4005
|
+
upload_protocol?:
|
|
4006
|
+
string;
|
|
4007
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4008
|
+
uploadType?:
|
|
4009
|
+
string;
|
|
4010
|
+
/** Request body */
|
|
4011
|
+
resource:
|
|
2450
4012
|
GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
2451
4013
|
}): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
2452
4014
|
write(request: {
|
|
@@ -2471,7 +4033,792 @@ declare namespace gapi.client {
|
|
|
2471
4033
|
/** OAuth 2.0 token for the current user. */
|
|
2472
4034
|
oauth_token?:
|
|
2473
4035
|
string;
|
|
2474
|
-
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
4036
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
4037
|
+
parent:
|
|
4038
|
+
string;
|
|
4039
|
+
/** Returns response with indentations and line breaks. */
|
|
4040
|
+
prettyPrint?:
|
|
4041
|
+
boolean;
|
|
4042
|
+
/** 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. */
|
|
4043
|
+
quotaUser?:
|
|
4044
|
+
string;
|
|
4045
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4046
|
+
upload_protocol?:
|
|
4047
|
+
string;
|
|
4048
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4049
|
+
uploadType?:
|
|
4050
|
+
string;
|
|
4051
|
+
},
|
|
4052
|
+
body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
4053
|
+
}
|
|
4054
|
+
interface DataStoresResource {
|
|
4055
|
+
/** Completes the specified user input with keyword suggestions. */
|
|
4056
|
+
completeQuery(request?: {
|
|
4057
|
+
/** V1 error format. */
|
|
4058
|
+
"$.xgafv"?:
|
|
4059
|
+
string;
|
|
4060
|
+
/** OAuth access token. */
|
|
4061
|
+
access_token?:
|
|
4062
|
+
string;
|
|
4063
|
+
/** Data format for response. */
|
|
4064
|
+
alt?:
|
|
4065
|
+
string;
|
|
4066
|
+
/** JSONP */
|
|
4067
|
+
callback?:
|
|
4068
|
+
string;
|
|
4069
|
+
/**
|
|
4070
|
+
* Required. The parent data store resource name for which the completion is performed, such as
|
|
4071
|
+
* `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
|
|
4072
|
+
*/
|
|
4073
|
+
dataStore:
|
|
4074
|
+
string;
|
|
4075
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4076
|
+
fields?:
|
|
4077
|
+
string;
|
|
4078
|
+
/**
|
|
4079
|
+
* Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query,
|
|
4080
|
+
* those are returned and no tail suggestions are returned.
|
|
4081
|
+
*/
|
|
4082
|
+
includeTailSuggestions?:
|
|
4083
|
+
boolean;
|
|
4084
|
+
/** 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. */
|
|
4085
|
+
key?:
|
|
4086
|
+
string;
|
|
4087
|
+
/** OAuth 2.0 token for the current user. */
|
|
4088
|
+
oauth_token?:
|
|
4089
|
+
string;
|
|
4090
|
+
/** Returns response with indentations and line breaks. */
|
|
4091
|
+
prettyPrint?:
|
|
4092
|
+
boolean;
|
|
4093
|
+
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
4094
|
+
query?:
|
|
4095
|
+
string;
|
|
4096
|
+
/**
|
|
4097
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` -
|
|
4098
|
+
* Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions
|
|
4099
|
+
* generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:
|
|
4100
|
+
* * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
|
|
4101
|
+
*/
|
|
4102
|
+
queryModel?:
|
|
4103
|
+
string;
|
|
4104
|
+
/** 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. */
|
|
4105
|
+
quotaUser?:
|
|
4106
|
+
string;
|
|
4107
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4108
|
+
upload_protocol?:
|
|
4109
|
+
string;
|
|
4110
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4111
|
+
uploadType?:
|
|
4112
|
+
string;
|
|
4113
|
+
/**
|
|
4114
|
+
* 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.
|
|
4115
|
+
* 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`. This should be the
|
|
4116
|
+
* same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
|
|
4117
|
+
* `INVALID_ARGUMENT` error is returned.
|
|
4118
|
+
*/
|
|
4119
|
+
userPseudoId?:
|
|
4120
|
+
string;
|
|
4121
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
|
|
4122
|
+
branches:
|
|
4123
|
+
BranchesResource;
|
|
4124
|
+
conversations:
|
|
4125
|
+
ConversationsResource;
|
|
4126
|
+
models:
|
|
4127
|
+
ModelsResource;
|
|
4128
|
+
operations:
|
|
4129
|
+
OperationsResource;
|
|
4130
|
+
schemas:
|
|
4131
|
+
SchemasResource;
|
|
4132
|
+
servingConfigs:
|
|
4133
|
+
ServingConfigsResource;
|
|
4134
|
+
siteSearchEngine:
|
|
4135
|
+
SiteSearchEngineResource;
|
|
4136
|
+
userEvents:
|
|
4137
|
+
UserEventsResource;
|
|
4138
|
+
}
|
|
4139
|
+
interface OperationsResource {
|
|
4140
|
+
/** 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. */
|
|
4141
|
+
get(request?: {
|
|
4142
|
+
/** V1 error format. */
|
|
4143
|
+
"$.xgafv"?:
|
|
4144
|
+
string;
|
|
4145
|
+
/** OAuth access token. */
|
|
4146
|
+
access_token?:
|
|
4147
|
+
string;
|
|
4148
|
+
/** Data format for response. */
|
|
4149
|
+
alt?:
|
|
4150
|
+
string;
|
|
4151
|
+
/** JSONP */
|
|
4152
|
+
callback?:
|
|
4153
|
+
string;
|
|
4154
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4155
|
+
fields?:
|
|
4156
|
+
string;
|
|
4157
|
+
/** 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. */
|
|
4158
|
+
key?:
|
|
4159
|
+
string;
|
|
4160
|
+
/** The name of the operation resource. */
|
|
4161
|
+
name:
|
|
4162
|
+
string;
|
|
4163
|
+
/** OAuth 2.0 token for the current user. */
|
|
4164
|
+
oauth_token?:
|
|
4165
|
+
string;
|
|
4166
|
+
/** Returns response with indentations and line breaks. */
|
|
4167
|
+
prettyPrint?:
|
|
4168
|
+
boolean;
|
|
4169
|
+
/** 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. */
|
|
4170
|
+
quotaUser?:
|
|
4171
|
+
string;
|
|
4172
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4173
|
+
upload_protocol?:
|
|
4174
|
+
string;
|
|
4175
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4176
|
+
uploadType?:
|
|
4177
|
+
string;
|
|
4178
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4179
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4180
|
+
list(request?: {
|
|
4181
|
+
/** V1 error format. */
|
|
4182
|
+
"$.xgafv"?:
|
|
4183
|
+
string;
|
|
4184
|
+
/** OAuth access token. */
|
|
4185
|
+
access_token?:
|
|
4186
|
+
string;
|
|
4187
|
+
/** Data format for response. */
|
|
4188
|
+
alt?:
|
|
4189
|
+
string;
|
|
4190
|
+
/** JSONP */
|
|
4191
|
+
callback?:
|
|
4192
|
+
string;
|
|
4193
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4194
|
+
fields?:
|
|
4195
|
+
string;
|
|
4196
|
+
/** The standard list filter. */
|
|
4197
|
+
filter?:
|
|
4198
|
+
string;
|
|
4199
|
+
/** 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. */
|
|
4200
|
+
key?:
|
|
4201
|
+
string;
|
|
4202
|
+
/** The name of the operation's parent resource. */
|
|
4203
|
+
name:
|
|
4204
|
+
string;
|
|
4205
|
+
/** OAuth 2.0 token for the current user. */
|
|
4206
|
+
oauth_token?:
|
|
4207
|
+
string;
|
|
4208
|
+
/** The standard list page size. */
|
|
4209
|
+
pageSize?:
|
|
4210
|
+
number;
|
|
4211
|
+
/** The standard list page token. */
|
|
4212
|
+
pageToken?:
|
|
4213
|
+
string;
|
|
4214
|
+
/** Returns response with indentations and line breaks. */
|
|
4215
|
+
prettyPrint?:
|
|
4216
|
+
boolean;
|
|
4217
|
+
/** 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. */
|
|
4218
|
+
quotaUser?:
|
|
4219
|
+
string;
|
|
4220
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4221
|
+
upload_protocol?:
|
|
4222
|
+
string;
|
|
4223
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4224
|
+
uploadType?:
|
|
4225
|
+
string;
|
|
4226
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
4227
|
+
}
|
|
4228
|
+
interface EnginesResource {
|
|
4229
|
+
operations:
|
|
4230
|
+
OperationsResource;
|
|
4231
|
+
}
|
|
4232
|
+
interface OperationsResource {
|
|
4233
|
+
/** 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. */
|
|
4234
|
+
get(request?: {
|
|
4235
|
+
/** V1 error format. */
|
|
4236
|
+
"$.xgafv"?:
|
|
4237
|
+
string;
|
|
4238
|
+
/** OAuth access token. */
|
|
4239
|
+
access_token?:
|
|
4240
|
+
string;
|
|
4241
|
+
/** Data format for response. */
|
|
4242
|
+
alt?:
|
|
4243
|
+
string;
|
|
4244
|
+
/** JSONP */
|
|
4245
|
+
callback?:
|
|
4246
|
+
string;
|
|
4247
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4248
|
+
fields?:
|
|
4249
|
+
string;
|
|
4250
|
+
/** 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. */
|
|
4251
|
+
key?:
|
|
4252
|
+
string;
|
|
4253
|
+
/** The name of the operation resource. */
|
|
4254
|
+
name:
|
|
4255
|
+
string;
|
|
4256
|
+
/** OAuth 2.0 token for the current user. */
|
|
4257
|
+
oauth_token?:
|
|
4258
|
+
string;
|
|
4259
|
+
/** Returns response with indentations and line breaks. */
|
|
4260
|
+
prettyPrint?:
|
|
4261
|
+
boolean;
|
|
4262
|
+
/** 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. */
|
|
4263
|
+
quotaUser?:
|
|
4264
|
+
string;
|
|
4265
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4266
|
+
upload_protocol?:
|
|
4267
|
+
string;
|
|
4268
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4269
|
+
uploadType?:
|
|
4270
|
+
string;
|
|
4271
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4272
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4273
|
+
list(request?: {
|
|
4274
|
+
/** V1 error format. */
|
|
4275
|
+
"$.xgafv"?:
|
|
4276
|
+
string;
|
|
4277
|
+
/** OAuth access token. */
|
|
4278
|
+
access_token?:
|
|
4279
|
+
string;
|
|
4280
|
+
/** Data format for response. */
|
|
4281
|
+
alt?:
|
|
4282
|
+
string;
|
|
4283
|
+
/** JSONP */
|
|
4284
|
+
callback?:
|
|
4285
|
+
string;
|
|
4286
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4287
|
+
fields?:
|
|
4288
|
+
string;
|
|
4289
|
+
/** The standard list filter. */
|
|
4290
|
+
filter?:
|
|
4291
|
+
string;
|
|
4292
|
+
/** 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. */
|
|
4293
|
+
key?:
|
|
4294
|
+
string;
|
|
4295
|
+
/** The name of the operation's parent resource. */
|
|
4296
|
+
name:
|
|
4297
|
+
string;
|
|
4298
|
+
/** OAuth 2.0 token for the current user. */
|
|
4299
|
+
oauth_token?:
|
|
4300
|
+
string;
|
|
4301
|
+
/** The standard list page size. */
|
|
4302
|
+
pageSize?:
|
|
4303
|
+
number;
|
|
4304
|
+
/** The standard list page token. */
|
|
4305
|
+
pageToken?:
|
|
4306
|
+
string;
|
|
4307
|
+
/** Returns response with indentations and line breaks. */
|
|
4308
|
+
prettyPrint?:
|
|
4309
|
+
boolean;
|
|
4310
|
+
/** 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. */
|
|
4311
|
+
quotaUser?:
|
|
4312
|
+
string;
|
|
4313
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4314
|
+
upload_protocol?:
|
|
4315
|
+
string;
|
|
4316
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4317
|
+
uploadType?:
|
|
4318
|
+
string;
|
|
4319
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
4320
|
+
}
|
|
4321
|
+
interface CollectionsResource {
|
|
4322
|
+
dataStores:
|
|
4323
|
+
DataStoresResource;
|
|
4324
|
+
engines:
|
|
4325
|
+
EnginesResource;
|
|
4326
|
+
operations:
|
|
4327
|
+
OperationsResource;
|
|
4328
|
+
}
|
|
4329
|
+
interface DocumentsResource {
|
|
4330
|
+
/** Creates a Document. */
|
|
4331
|
+
create(request: {
|
|
4332
|
+
/** V1 error format. */
|
|
4333
|
+
"$.xgafv"?:
|
|
4334
|
+
string;
|
|
4335
|
+
/** OAuth access token. */
|
|
4336
|
+
access_token?:
|
|
4337
|
+
string;
|
|
4338
|
+
/** Data format for response. */
|
|
4339
|
+
alt?:
|
|
4340
|
+
string;
|
|
4341
|
+
/** JSONP */
|
|
4342
|
+
callback?:
|
|
4343
|
+
string;
|
|
4344
|
+
/**
|
|
4345
|
+
* Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
|
|
4346
|
+
* of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
|
4347
|
+
* returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
4348
|
+
* returned.
|
|
4349
|
+
*/
|
|
4350
|
+
documentId?:
|
|
4351
|
+
string;
|
|
4352
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4353
|
+
fields?:
|
|
4354
|
+
string;
|
|
4355
|
+
/** 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. */
|
|
4356
|
+
key?:
|
|
4357
|
+
string;
|
|
4358
|
+
/** OAuth 2.0 token for the current user. */
|
|
4359
|
+
oauth_token?:
|
|
4360
|
+
string;
|
|
4361
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
4362
|
+
parent:
|
|
4363
|
+
string;
|
|
4364
|
+
/** Returns response with indentations and line breaks. */
|
|
4365
|
+
prettyPrint?:
|
|
4366
|
+
boolean;
|
|
4367
|
+
/** 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. */
|
|
4368
|
+
quotaUser?:
|
|
4369
|
+
string;
|
|
4370
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4371
|
+
upload_protocol?:
|
|
4372
|
+
string;
|
|
4373
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4374
|
+
uploadType?:
|
|
4375
|
+
string;
|
|
4376
|
+
/** Request body */
|
|
4377
|
+
resource:
|
|
4378
|
+
GoogleCloudDiscoveryengineV1alphaDocument;
|
|
4379
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
4380
|
+
create(request: {
|
|
4381
|
+
/** V1 error format. */
|
|
4382
|
+
"$.xgafv"?:
|
|
4383
|
+
string;
|
|
4384
|
+
/** OAuth access token. */
|
|
4385
|
+
access_token?:
|
|
4386
|
+
string;
|
|
4387
|
+
/** Data format for response. */
|
|
4388
|
+
alt?:
|
|
4389
|
+
string;
|
|
4390
|
+
/** JSONP */
|
|
4391
|
+
callback?:
|
|
4392
|
+
string;
|
|
4393
|
+
/**
|
|
4394
|
+
* Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
|
|
4395
|
+
* of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
|
4396
|
+
* returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
4397
|
+
* returned.
|
|
4398
|
+
*/
|
|
4399
|
+
documentId?:
|
|
4400
|
+
string;
|
|
4401
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4402
|
+
fields?:
|
|
4403
|
+
string;
|
|
4404
|
+
/** 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. */
|
|
4405
|
+
key?:
|
|
4406
|
+
string;
|
|
4407
|
+
/** OAuth 2.0 token for the current user. */
|
|
4408
|
+
oauth_token?:
|
|
4409
|
+
string;
|
|
4410
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
4411
|
+
parent:
|
|
4412
|
+
string;
|
|
4413
|
+
/** Returns response with indentations and line breaks. */
|
|
4414
|
+
prettyPrint?:
|
|
4415
|
+
boolean;
|
|
4416
|
+
/** 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. */
|
|
4417
|
+
quotaUser?:
|
|
4418
|
+
string;
|
|
4419
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4420
|
+
upload_protocol?:
|
|
4421
|
+
string;
|
|
4422
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4423
|
+
uploadType?:
|
|
4424
|
+
string;
|
|
4425
|
+
},
|
|
4426
|
+
body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
4427
|
+
/** Deletes a Document. */
|
|
4428
|
+
delete(request?: {
|
|
4429
|
+
/** V1 error format. */
|
|
4430
|
+
"$.xgafv"?:
|
|
4431
|
+
string;
|
|
4432
|
+
/** OAuth access token. */
|
|
4433
|
+
access_token?:
|
|
4434
|
+
string;
|
|
4435
|
+
/** Data format for response. */
|
|
4436
|
+
alt?:
|
|
4437
|
+
string;
|
|
4438
|
+
/** JSONP */
|
|
4439
|
+
callback?:
|
|
4440
|
+
string;
|
|
4441
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4442
|
+
fields?:
|
|
4443
|
+
string;
|
|
4444
|
+
/** 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. */
|
|
4445
|
+
key?:
|
|
4446
|
+
string;
|
|
4447
|
+
/**
|
|
4448
|
+
* Required. Full resource name of Document, such as
|
|
4449
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
|
|
4450
|
+
* delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.
|
|
4451
|
+
*/
|
|
4452
|
+
name:
|
|
4453
|
+
string;
|
|
4454
|
+
/** OAuth 2.0 token for the current user. */
|
|
4455
|
+
oauth_token?:
|
|
4456
|
+
string;
|
|
4457
|
+
/** Returns response with indentations and line breaks. */
|
|
4458
|
+
prettyPrint?:
|
|
4459
|
+
boolean;
|
|
4460
|
+
/** 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. */
|
|
4461
|
+
quotaUser?:
|
|
4462
|
+
string;
|
|
4463
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4464
|
+
upload_protocol?:
|
|
4465
|
+
string;
|
|
4466
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4467
|
+
uploadType?:
|
|
4468
|
+
string;
|
|
4469
|
+
}): Request<{}>;
|
|
4470
|
+
/** Gets a Document. */
|
|
4471
|
+
get(request?: {
|
|
4472
|
+
/** V1 error format. */
|
|
4473
|
+
"$.xgafv"?:
|
|
4474
|
+
string;
|
|
4475
|
+
/** OAuth access token. */
|
|
4476
|
+
access_token?:
|
|
4477
|
+
string;
|
|
4478
|
+
/** Data format for response. */
|
|
4479
|
+
alt?:
|
|
4480
|
+
string;
|
|
4481
|
+
/** JSONP */
|
|
4482
|
+
callback?:
|
|
4483
|
+
string;
|
|
4484
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4485
|
+
fields?:
|
|
4486
|
+
string;
|
|
4487
|
+
/** 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. */
|
|
4488
|
+
key?:
|
|
4489
|
+
string;
|
|
4490
|
+
/**
|
|
4491
|
+
* Required. Full resource name of Document, such as
|
|
4492
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
|
|
4493
|
+
* access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
|
|
4494
|
+
*/
|
|
4495
|
+
name:
|
|
4496
|
+
string;
|
|
4497
|
+
/** OAuth 2.0 token for the current user. */
|
|
4498
|
+
oauth_token?:
|
|
4499
|
+
string;
|
|
4500
|
+
/** Returns response with indentations and line breaks. */
|
|
4501
|
+
prettyPrint?:
|
|
4502
|
+
boolean;
|
|
4503
|
+
/** 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. */
|
|
4504
|
+
quotaUser?:
|
|
4505
|
+
string;
|
|
4506
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4507
|
+
upload_protocol?:
|
|
4508
|
+
string;
|
|
4509
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4510
|
+
uploadType?:
|
|
4511
|
+
string;
|
|
4512
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
4513
|
+
/**
|
|
4514
|
+
* Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully
|
|
4515
|
+
* updated.
|
|
4516
|
+
*/
|
|
4517
|
+
import(request: {
|
|
4518
|
+
/** V1 error format. */
|
|
4519
|
+
"$.xgafv"?:
|
|
4520
|
+
string;
|
|
4521
|
+
/** OAuth access token. */
|
|
4522
|
+
access_token?:
|
|
4523
|
+
string;
|
|
4524
|
+
/** Data format for response. */
|
|
4525
|
+
alt?:
|
|
4526
|
+
string;
|
|
4527
|
+
/** JSONP */
|
|
4528
|
+
callback?:
|
|
4529
|
+
string;
|
|
4530
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4531
|
+
fields?:
|
|
4532
|
+
string;
|
|
4533
|
+
/** 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. */
|
|
4534
|
+
key?:
|
|
4535
|
+
string;
|
|
4536
|
+
/** OAuth 2.0 token for the current user. */
|
|
4537
|
+
oauth_token?:
|
|
4538
|
+
string;
|
|
4539
|
+
/**
|
|
4540
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
4541
|
+
* create/update permission.
|
|
4542
|
+
*/
|
|
4543
|
+
parent:
|
|
4544
|
+
string;
|
|
4545
|
+
/** Returns response with indentations and line breaks. */
|
|
4546
|
+
prettyPrint?:
|
|
4547
|
+
boolean;
|
|
4548
|
+
/** 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. */
|
|
4549
|
+
quotaUser?:
|
|
4550
|
+
string;
|
|
4551
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4552
|
+
upload_protocol?:
|
|
4553
|
+
string;
|
|
4554
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4555
|
+
uploadType?:
|
|
4556
|
+
string;
|
|
4557
|
+
/** Request body */
|
|
4558
|
+
resource:
|
|
4559
|
+
GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
|
|
4560
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4561
|
+
import(request: {
|
|
4562
|
+
/** V1 error format. */
|
|
4563
|
+
"$.xgafv"?:
|
|
4564
|
+
string;
|
|
4565
|
+
/** OAuth access token. */
|
|
4566
|
+
access_token?:
|
|
4567
|
+
string;
|
|
4568
|
+
/** Data format for response. */
|
|
4569
|
+
alt?:
|
|
4570
|
+
string;
|
|
4571
|
+
/** JSONP */
|
|
4572
|
+
callback?:
|
|
4573
|
+
string;
|
|
4574
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4575
|
+
fields?:
|
|
4576
|
+
string;
|
|
4577
|
+
/** 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. */
|
|
4578
|
+
key?:
|
|
4579
|
+
string;
|
|
4580
|
+
/** OAuth 2.0 token for the current user. */
|
|
4581
|
+
oauth_token?:
|
|
4582
|
+
string;
|
|
4583
|
+
/**
|
|
4584
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
4585
|
+
* create/update permission.
|
|
4586
|
+
*/
|
|
4587
|
+
parent:
|
|
4588
|
+
string;
|
|
4589
|
+
/** Returns response with indentations and line breaks. */
|
|
4590
|
+
prettyPrint?:
|
|
4591
|
+
boolean;
|
|
4592
|
+
/** 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. */
|
|
4593
|
+
quotaUser?:
|
|
4594
|
+
string;
|
|
4595
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4596
|
+
upload_protocol?:
|
|
4597
|
+
string;
|
|
4598
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4599
|
+
uploadType?:
|
|
4600
|
+
string;
|
|
4601
|
+
},
|
|
4602
|
+
body: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
|
|
4603
|
+
/** Gets a list of Documents. */
|
|
4604
|
+
list(request?: {
|
|
4605
|
+
/** V1 error format. */
|
|
4606
|
+
"$.xgafv"?:
|
|
4607
|
+
string;
|
|
4608
|
+
/** OAuth access token. */
|
|
4609
|
+
access_token?:
|
|
4610
|
+
string;
|
|
4611
|
+
/** Data format for response. */
|
|
4612
|
+
alt?:
|
|
4613
|
+
string;
|
|
4614
|
+
/** JSONP */
|
|
4615
|
+
callback?:
|
|
4616
|
+
string;
|
|
4617
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4618
|
+
fields?:
|
|
4619
|
+
string;
|
|
4620
|
+
/** 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. */
|
|
4621
|
+
key?:
|
|
4622
|
+
string;
|
|
4623
|
+
/** OAuth 2.0 token for the current user. */
|
|
4624
|
+
oauth_token?:
|
|
4625
|
+
string;
|
|
4626
|
+
/**
|
|
4627
|
+
* Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative,
|
|
4628
|
+
* an `INVALID_ARGUMENT` error is returned.
|
|
4629
|
+
*/
|
|
4630
|
+
pageSize?:
|
|
4631
|
+
number;
|
|
4632
|
+
/**
|
|
4633
|
+
* A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
|
|
4634
|
+
* all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
4635
|
+
*/
|
|
4636
|
+
pageToken?:
|
|
4637
|
+
string;
|
|
4638
|
+
/**
|
|
4639
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
|
|
4640
|
+
* `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
|
|
4641
|
+
* or not this branch exists, a `PERMISSION_DENIED` error is returned.
|
|
4642
|
+
*/
|
|
4643
|
+
parent:
|
|
4644
|
+
string;
|
|
4645
|
+
/** Returns response with indentations and line breaks. */
|
|
4646
|
+
prettyPrint?:
|
|
4647
|
+
boolean;
|
|
4648
|
+
/** 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. */
|
|
4649
|
+
quotaUser?:
|
|
4650
|
+
string;
|
|
4651
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4652
|
+
upload_protocol?:
|
|
4653
|
+
string;
|
|
4654
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4655
|
+
uploadType?:
|
|
4656
|
+
string;
|
|
4657
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
|
|
4658
|
+
/** Updates a Document. */
|
|
4659
|
+
patch(request: {
|
|
4660
|
+
/** V1 error format. */
|
|
4661
|
+
"$.xgafv"?:
|
|
4662
|
+
string;
|
|
4663
|
+
/** OAuth access token. */
|
|
4664
|
+
access_token?:
|
|
4665
|
+
string;
|
|
4666
|
+
/** If set to true, and the Document is not found, a new Document will be created. */
|
|
4667
|
+
allowMissing?:
|
|
4668
|
+
boolean;
|
|
4669
|
+
/** Data format for response. */
|
|
4670
|
+
alt?:
|
|
4671
|
+
string;
|
|
4672
|
+
/** JSONP */
|
|
4673
|
+
callback?:
|
|
4674
|
+
string;
|
|
4675
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4676
|
+
fields?:
|
|
4677
|
+
string;
|
|
4678
|
+
/** 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. */
|
|
4679
|
+
key?:
|
|
4680
|
+
string;
|
|
4681
|
+
/**
|
|
4682
|
+
* Immutable. The full resource name of the document. Format:
|
|
4683
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
4684
|
+
* with a length limit of 1024 characters.
|
|
4685
|
+
*/
|
|
4686
|
+
name:
|
|
4687
|
+
string;
|
|
4688
|
+
/** OAuth 2.0 token for the current user. */
|
|
4689
|
+
oauth_token?:
|
|
4690
|
+
string;
|
|
4691
|
+
/** Returns response with indentations and line breaks. */
|
|
4692
|
+
prettyPrint?:
|
|
4693
|
+
boolean;
|
|
4694
|
+
/** 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. */
|
|
4695
|
+
quotaUser?:
|
|
4696
|
+
string;
|
|
4697
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4698
|
+
upload_protocol?:
|
|
4699
|
+
string;
|
|
4700
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4701
|
+
uploadType?:
|
|
4702
|
+
string;
|
|
4703
|
+
/** Request body */
|
|
4704
|
+
resource:
|
|
4705
|
+
GoogleCloudDiscoveryengineV1alphaDocument;
|
|
4706
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
4707
|
+
patch(request: {
|
|
4708
|
+
/** V1 error format. */
|
|
4709
|
+
"$.xgafv"?:
|
|
4710
|
+
string;
|
|
4711
|
+
/** OAuth access token. */
|
|
4712
|
+
access_token?:
|
|
4713
|
+
string;
|
|
4714
|
+
/** If set to true, and the Document is not found, a new Document will be created. */
|
|
4715
|
+
allowMissing?:
|
|
4716
|
+
boolean;
|
|
4717
|
+
/** Data format for response. */
|
|
4718
|
+
alt?:
|
|
4719
|
+
string;
|
|
4720
|
+
/** JSONP */
|
|
4721
|
+
callback?:
|
|
4722
|
+
string;
|
|
4723
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4724
|
+
fields?:
|
|
4725
|
+
string;
|
|
4726
|
+
/** 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. */
|
|
4727
|
+
key?:
|
|
4728
|
+
string;
|
|
4729
|
+
/**
|
|
4730
|
+
* Immutable. The full resource name of the document. Format:
|
|
4731
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
4732
|
+
* with a length limit of 1024 characters.
|
|
4733
|
+
*/
|
|
4734
|
+
name:
|
|
4735
|
+
string;
|
|
4736
|
+
/** OAuth 2.0 token for the current user. */
|
|
4737
|
+
oauth_token?:
|
|
4738
|
+
string;
|
|
4739
|
+
/** Returns response with indentations and line breaks. */
|
|
4740
|
+
prettyPrint?:
|
|
4741
|
+
boolean;
|
|
4742
|
+
/** 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. */
|
|
4743
|
+
quotaUser?:
|
|
4744
|
+
string;
|
|
4745
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4746
|
+
upload_protocol?:
|
|
4747
|
+
string;
|
|
4748
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4749
|
+
uploadType?:
|
|
4750
|
+
string;
|
|
4751
|
+
},
|
|
4752
|
+
body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
4753
|
+
/**
|
|
4754
|
+
* Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete.
|
|
4755
|
+
* Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be
|
|
4756
|
+
* deleted, set PurgeDocumentsRequest.force to false.
|
|
4757
|
+
*/
|
|
4758
|
+
purge(request: {
|
|
4759
|
+
/** V1 error format. */
|
|
4760
|
+
"$.xgafv"?:
|
|
4761
|
+
string;
|
|
4762
|
+
/** OAuth access token. */
|
|
4763
|
+
access_token?:
|
|
4764
|
+
string;
|
|
4765
|
+
/** Data format for response. */
|
|
4766
|
+
alt?:
|
|
4767
|
+
string;
|
|
4768
|
+
/** JSONP */
|
|
4769
|
+
callback?:
|
|
4770
|
+
string;
|
|
4771
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4772
|
+
fields?:
|
|
4773
|
+
string;
|
|
4774
|
+
/** 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. */
|
|
4775
|
+
key?:
|
|
4776
|
+
string;
|
|
4777
|
+
/** OAuth 2.0 token for the current user. */
|
|
4778
|
+
oauth_token?:
|
|
4779
|
+
string;
|
|
4780
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
4781
|
+
parent:
|
|
4782
|
+
string;
|
|
4783
|
+
/** Returns response with indentations and line breaks. */
|
|
4784
|
+
prettyPrint?:
|
|
4785
|
+
boolean;
|
|
4786
|
+
/** 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. */
|
|
4787
|
+
quotaUser?:
|
|
4788
|
+
string;
|
|
4789
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4790
|
+
upload_protocol?:
|
|
4791
|
+
string;
|
|
4792
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4793
|
+
uploadType?:
|
|
4794
|
+
string;
|
|
4795
|
+
/** Request body */
|
|
4796
|
+
resource:
|
|
4797
|
+
GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
4798
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4799
|
+
purge(request: {
|
|
4800
|
+
/** V1 error format. */
|
|
4801
|
+
"$.xgafv"?:
|
|
4802
|
+
string;
|
|
4803
|
+
/** OAuth access token. */
|
|
4804
|
+
access_token?:
|
|
4805
|
+
string;
|
|
4806
|
+
/** Data format for response. */
|
|
4807
|
+
alt?:
|
|
4808
|
+
string;
|
|
4809
|
+
/** JSONP */
|
|
4810
|
+
callback?:
|
|
4811
|
+
string;
|
|
4812
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4813
|
+
fields?:
|
|
4814
|
+
string;
|
|
4815
|
+
/** 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. */
|
|
4816
|
+
key?:
|
|
4817
|
+
string;
|
|
4818
|
+
/** OAuth 2.0 token for the current user. */
|
|
4819
|
+
oauth_token?:
|
|
4820
|
+
string;
|
|
4821
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
2475
4822
|
parent:
|
|
2476
4823
|
string;
|
|
2477
4824
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2487,23 +4834,7 @@ declare namespace gapi.client {
|
|
|
2487
4834
|
uploadType?:
|
|
2488
4835
|
string;
|
|
2489
4836
|
},
|
|
2490
|
-
body:
|
|
2491
|
-
}
|
|
2492
|
-
interface DataStoresResource {
|
|
2493
|
-
branches:
|
|
2494
|
-
BranchesResource;
|
|
2495
|
-
models:
|
|
2496
|
-
ModelsResource;
|
|
2497
|
-
operations:
|
|
2498
|
-
OperationsResource;
|
|
2499
|
-
schemas:
|
|
2500
|
-
SchemasResource;
|
|
2501
|
-
servingConfigs:
|
|
2502
|
-
ServingConfigsResource;
|
|
2503
|
-
siteSearchEngine:
|
|
2504
|
-
SiteSearchEngineResource;
|
|
2505
|
-
userEvents:
|
|
2506
|
-
UserEventsResource;
|
|
4837
|
+
body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest): Request<GoogleLongrunningOperation>;
|
|
2507
4838
|
}
|
|
2508
4839
|
interface OperationsResource {
|
|
2509
4840
|
/** 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. */
|
|
@@ -2594,13 +4925,15 @@ declare namespace gapi.client {
|
|
|
2594
4925
|
string;
|
|
2595
4926
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
2596
4927
|
}
|
|
2597
|
-
interface
|
|
4928
|
+
interface BranchesResource {
|
|
4929
|
+
documents:
|
|
4930
|
+
DocumentsResource;
|
|
2598
4931
|
operations:
|
|
2599
4932
|
OperationsResource;
|
|
2600
4933
|
}
|
|
2601
|
-
interface
|
|
2602
|
-
/**
|
|
2603
|
-
|
|
4934
|
+
interface ConversationsResource {
|
|
4935
|
+
/** Converses a conversation. */
|
|
4936
|
+
converse(request: {
|
|
2604
4937
|
/** V1 error format. */
|
|
2605
4938
|
"$.xgafv"?:
|
|
2606
4939
|
string;
|
|
@@ -2619,7 +4952,12 @@ declare namespace gapi.client {
|
|
|
2619
4952
|
/** 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. */
|
|
2620
4953
|
key?:
|
|
2621
4954
|
string;
|
|
2622
|
-
/**
|
|
4955
|
+
/**
|
|
4956
|
+
* Required. The resource name of the Conversation to get. Format:
|
|
4957
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
|
|
4958
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
|
|
4959
|
+
* creates a new conversation inside a ConverseConversation session.
|
|
4960
|
+
*/
|
|
2623
4961
|
name:
|
|
2624
4962
|
string;
|
|
2625
4963
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -2637,9 +4975,11 @@ declare namespace gapi.client {
|
|
|
2637
4975
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2638
4976
|
uploadType?:
|
|
2639
4977
|
string;
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
4978
|
+
/** Request body */
|
|
4979
|
+
resource:
|
|
4980
|
+
GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
|
|
4981
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
|
|
4982
|
+
converse(request: {
|
|
2643
4983
|
/** V1 error format. */
|
|
2644
4984
|
"$.xgafv"?:
|
|
2645
4985
|
string;
|
|
@@ -2655,24 +4995,20 @@ declare namespace gapi.client {
|
|
|
2655
4995
|
/** Selector specifying which fields to include in a partial response. */
|
|
2656
4996
|
fields?:
|
|
2657
4997
|
string;
|
|
2658
|
-
/** The standard list filter. */
|
|
2659
|
-
filter?:
|
|
2660
|
-
string;
|
|
2661
4998
|
/** 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. */
|
|
2662
4999
|
key?:
|
|
2663
5000
|
string;
|
|
2664
|
-
/**
|
|
5001
|
+
/**
|
|
5002
|
+
* Required. The resource name of the Conversation to get. Format:
|
|
5003
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
|
|
5004
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
|
|
5005
|
+
* creates a new conversation inside a ConverseConversation session.
|
|
5006
|
+
*/
|
|
2665
5007
|
name:
|
|
2666
5008
|
string;
|
|
2667
5009
|
/** OAuth 2.0 token for the current user. */
|
|
2668
5010
|
oauth_token?:
|
|
2669
5011
|
string;
|
|
2670
|
-
/** The standard list page size. */
|
|
2671
|
-
pageSize?:
|
|
2672
|
-
number;
|
|
2673
|
-
/** The standard list page token. */
|
|
2674
|
-
pageToken?:
|
|
2675
|
-
string;
|
|
2676
5012
|
/** Returns response with indentations and line breaks. */
|
|
2677
5013
|
prettyPrint?:
|
|
2678
5014
|
boolean;
|
|
@@ -2685,18 +5021,9 @@ declare namespace gapi.client {
|
|
|
2685
5021
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2686
5022
|
uploadType?:
|
|
2687
5023
|
string;
|
|
2688
|
-
}
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
dataStores:
|
|
2692
|
-
DataStoresResource;
|
|
2693
|
-
engines:
|
|
2694
|
-
EnginesResource;
|
|
2695
|
-
operations:
|
|
2696
|
-
OperationsResource;
|
|
2697
|
-
}
|
|
2698
|
-
interface DocumentsResource {
|
|
2699
|
-
/** Creates a Document. */
|
|
5024
|
+
},
|
|
5025
|
+
body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
|
|
5026
|
+
/** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
|
|
2700
5027
|
create(request: {
|
|
2701
5028
|
/** V1 error format. */
|
|
2702
5029
|
"$.xgafv"?:
|
|
@@ -2710,14 +5037,6 @@ declare namespace gapi.client {
|
|
|
2710
5037
|
/** JSONP */
|
|
2711
5038
|
callback?:
|
|
2712
5039
|
string;
|
|
2713
|
-
/**
|
|
2714
|
-
* Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
|
|
2715
|
-
* of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
|
2716
|
-
* returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
2717
|
-
* returned.
|
|
2718
|
-
*/
|
|
2719
|
-
documentId?:
|
|
2720
|
-
string;
|
|
2721
5040
|
/** Selector specifying which fields to include in a partial response. */
|
|
2722
5041
|
fields?:
|
|
2723
5042
|
string;
|
|
@@ -2727,7 +5046,7 @@ declare namespace gapi.client {
|
|
|
2727
5046
|
/** OAuth 2.0 token for the current user. */
|
|
2728
5047
|
oauth_token?:
|
|
2729
5048
|
string;
|
|
2730
|
-
/** Required.
|
|
5049
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
2731
5050
|
parent:
|
|
2732
5051
|
string;
|
|
2733
5052
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2744,8 +5063,8 @@ declare namespace gapi.client {
|
|
|
2744
5063
|
string;
|
|
2745
5064
|
/** Request body */
|
|
2746
5065
|
resource:
|
|
2747
|
-
|
|
2748
|
-
}): Request<
|
|
5066
|
+
GoogleCloudDiscoveryengineV1alphaConversation;
|
|
5067
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
2749
5068
|
create(request: {
|
|
2750
5069
|
/** V1 error format. */
|
|
2751
5070
|
"$.xgafv"?:
|
|
@@ -2759,14 +5078,6 @@ declare namespace gapi.client {
|
|
|
2759
5078
|
/** JSONP */
|
|
2760
5079
|
callback?:
|
|
2761
5080
|
string;
|
|
2762
|
-
/**
|
|
2763
|
-
* Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
|
|
2764
|
-
* of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
|
2765
|
-
* returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
2766
|
-
* returned.
|
|
2767
|
-
*/
|
|
2768
|
-
documentId?:
|
|
2769
|
-
string;
|
|
2770
5081
|
/** Selector specifying which fields to include in a partial response. */
|
|
2771
5082
|
fields?:
|
|
2772
5083
|
string;
|
|
@@ -2776,7 +5087,7 @@ declare namespace gapi.client {
|
|
|
2776
5087
|
/** OAuth 2.0 token for the current user. */
|
|
2777
5088
|
oauth_token?:
|
|
2778
5089
|
string;
|
|
2779
|
-
/** Required.
|
|
5090
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
2780
5091
|
parent:
|
|
2781
5092
|
string;
|
|
2782
5093
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2792,8 +5103,8 @@ declare namespace gapi.client {
|
|
|
2792
5103
|
uploadType?:
|
|
2793
5104
|
string;
|
|
2794
5105
|
},
|
|
2795
|
-
body:
|
|
2796
|
-
/** Deletes a
|
|
5106
|
+
body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
5107
|
+
/** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
|
|
2797
5108
|
delete(request?: {
|
|
2798
5109
|
/** V1 error format. */
|
|
2799
5110
|
"$.xgafv"?:
|
|
@@ -2814,9 +5125,8 @@ declare namespace gapi.client {
|
|
|
2814
5125
|
key?:
|
|
2815
5126
|
string;
|
|
2816
5127
|
/**
|
|
2817
|
-
* Required.
|
|
2818
|
-
* `projects/{
|
|
2819
|
-
* delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.
|
|
5128
|
+
* Required. The resource name of the Conversation to delete. Format:
|
|
5129
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
|
2820
5130
|
*/
|
|
2821
5131
|
name:
|
|
2822
5132
|
string;
|
|
@@ -2836,7 +5146,7 @@ declare namespace gapi.client {
|
|
|
2836
5146
|
uploadType?:
|
|
2837
5147
|
string;
|
|
2838
5148
|
}): Request<{}>;
|
|
2839
|
-
/** Gets a
|
|
5149
|
+
/** Gets a Conversation. */
|
|
2840
5150
|
get(request?: {
|
|
2841
5151
|
/** V1 error format. */
|
|
2842
5152
|
"$.xgafv"?:
|
|
@@ -2857,9 +5167,8 @@ declare namespace gapi.client {
|
|
|
2857
5167
|
key?:
|
|
2858
5168
|
string;
|
|
2859
5169
|
/**
|
|
2860
|
-
* Required.
|
|
2861
|
-
* `projects/{
|
|
2862
|
-
* access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
|
|
5170
|
+
* Required. The resource name of the Conversation to get. Format:
|
|
5171
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
|
2863
5172
|
*/
|
|
2864
5173
|
name:
|
|
2865
5174
|
string;
|
|
@@ -2878,12 +5187,9 @@ declare namespace gapi.client {
|
|
|
2878
5187
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2879
5188
|
uploadType?:
|
|
2880
5189
|
string;
|
|
2881
|
-
}): Request<
|
|
2882
|
-
/**
|
|
2883
|
-
|
|
2884
|
-
* updated.
|
|
2885
|
-
*/
|
|
2886
|
-
import(request: {
|
|
5190
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
5191
|
+
/** Lists all Conversations by their parent DataStore. */
|
|
5192
|
+
list(request?: {
|
|
2887
5193
|
/** V1 error format. */
|
|
2888
5194
|
"$.xgafv"?:
|
|
2889
5195
|
string;
|
|
@@ -2899,6 +5205,9 @@ declare namespace gapi.client {
|
|
|
2899
5205
|
/** Selector specifying which fields to include in a partial response. */
|
|
2900
5206
|
fields?:
|
|
2901
5207
|
string;
|
|
5208
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
5209
|
+
filter?:
|
|
5210
|
+
string;
|
|
2902
5211
|
/** 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. */
|
|
2903
5212
|
key?:
|
|
2904
5213
|
string;
|
|
@@ -2906,9 +5215,18 @@ declare namespace gapi.client {
|
|
|
2906
5215
|
oauth_token?:
|
|
2907
5216
|
string;
|
|
2908
5217
|
/**
|
|
2909
|
-
*
|
|
2910
|
-
*
|
|
5218
|
+
* 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` *
|
|
5219
|
+
* `conversation_name` Example: "update_time desc" "create_time"
|
|
2911
5220
|
*/
|
|
5221
|
+
orderBy?:
|
|
5222
|
+
string;
|
|
5223
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
5224
|
+
pageSize?:
|
|
5225
|
+
number;
|
|
5226
|
+
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
5227
|
+
pageToken?:
|
|
5228
|
+
string;
|
|
5229
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
2912
5230
|
parent:
|
|
2913
5231
|
string;
|
|
2914
5232
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2923,11 +5241,53 @@ declare namespace gapi.client {
|
|
|
2923
5241
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2924
5242
|
uploadType?:
|
|
2925
5243
|
string;
|
|
5244
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
|
|
5245
|
+
/** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
|
|
5246
|
+
patch(request: {
|
|
5247
|
+
/** V1 error format. */
|
|
5248
|
+
"$.xgafv"?:
|
|
5249
|
+
string;
|
|
5250
|
+
/** OAuth access token. */
|
|
5251
|
+
access_token?:
|
|
5252
|
+
string;
|
|
5253
|
+
/** Data format for response. */
|
|
5254
|
+
alt?:
|
|
5255
|
+
string;
|
|
5256
|
+
/** JSONP */
|
|
5257
|
+
callback?:
|
|
5258
|
+
string;
|
|
5259
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5260
|
+
fields?:
|
|
5261
|
+
string;
|
|
5262
|
+
/** 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. */
|
|
5263
|
+
key?:
|
|
5264
|
+
string;
|
|
5265
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` */
|
|
5266
|
+
name:
|
|
5267
|
+
string;
|
|
5268
|
+
/** OAuth 2.0 token for the current user. */
|
|
5269
|
+
oauth_token?:
|
|
5270
|
+
string;
|
|
5271
|
+
/** Returns response with indentations and line breaks. */
|
|
5272
|
+
prettyPrint?:
|
|
5273
|
+
boolean;
|
|
5274
|
+
/** 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. */
|
|
5275
|
+
quotaUser?:
|
|
5276
|
+
string;
|
|
5277
|
+
/** 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. */
|
|
5278
|
+
updateMask?:
|
|
5279
|
+
string;
|
|
5280
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5281
|
+
upload_protocol?:
|
|
5282
|
+
string;
|
|
5283
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5284
|
+
uploadType?:
|
|
5285
|
+
string;
|
|
2926
5286
|
/** Request body */
|
|
2927
5287
|
resource:
|
|
2928
|
-
|
|
2929
|
-
}): Request<
|
|
2930
|
-
|
|
5288
|
+
GoogleCloudDiscoveryengineV1alphaConversation;
|
|
5289
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
5290
|
+
patch(request: {
|
|
2931
5291
|
/** V1 error format. */
|
|
2932
5292
|
"$.xgafv"?:
|
|
2933
5293
|
string;
|
|
@@ -2946,21 +5306,21 @@ declare namespace gapi.client {
|
|
|
2946
5306
|
/** 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. */
|
|
2947
5307
|
key?:
|
|
2948
5308
|
string;
|
|
5309
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` */
|
|
5310
|
+
name:
|
|
5311
|
+
string;
|
|
2949
5312
|
/** OAuth 2.0 token for the current user. */
|
|
2950
5313
|
oauth_token?:
|
|
2951
5314
|
string;
|
|
2952
|
-
/**
|
|
2953
|
-
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
2954
|
-
* create/update permission.
|
|
2955
|
-
*/
|
|
2956
|
-
parent:
|
|
2957
|
-
string;
|
|
2958
5315
|
/** Returns response with indentations and line breaks. */
|
|
2959
5316
|
prettyPrint?:
|
|
2960
5317
|
boolean;
|
|
2961
5318
|
/** 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. */
|
|
2962
5319
|
quotaUser?:
|
|
2963
5320
|
string;
|
|
5321
|
+
/** 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. */
|
|
5322
|
+
updateMask?:
|
|
5323
|
+
string;
|
|
2964
5324
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2965
5325
|
upload_protocol?:
|
|
2966
5326
|
string;
|
|
@@ -2968,8 +5328,49 @@ declare namespace gapi.client {
|
|
|
2968
5328
|
uploadType?:
|
|
2969
5329
|
string;
|
|
2970
5330
|
},
|
|
2971
|
-
body:
|
|
2972
|
-
|
|
5331
|
+
body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
|
|
5332
|
+
}
|
|
5333
|
+
interface OperationsResource {
|
|
5334
|
+
/** 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. */
|
|
5335
|
+
get(request?: {
|
|
5336
|
+
/** V1 error format. */
|
|
5337
|
+
"$.xgafv"?:
|
|
5338
|
+
string;
|
|
5339
|
+
/** OAuth access token. */
|
|
5340
|
+
access_token?:
|
|
5341
|
+
string;
|
|
5342
|
+
/** Data format for response. */
|
|
5343
|
+
alt?:
|
|
5344
|
+
string;
|
|
5345
|
+
/** JSONP */
|
|
5346
|
+
callback?:
|
|
5347
|
+
string;
|
|
5348
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5349
|
+
fields?:
|
|
5350
|
+
string;
|
|
5351
|
+
/** 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. */
|
|
5352
|
+
key?:
|
|
5353
|
+
string;
|
|
5354
|
+
/** The name of the operation resource. */
|
|
5355
|
+
name:
|
|
5356
|
+
string;
|
|
5357
|
+
/** OAuth 2.0 token for the current user. */
|
|
5358
|
+
oauth_token?:
|
|
5359
|
+
string;
|
|
5360
|
+
/** Returns response with indentations and line breaks. */
|
|
5361
|
+
prettyPrint?:
|
|
5362
|
+
boolean;
|
|
5363
|
+
/** 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. */
|
|
5364
|
+
quotaUser?:
|
|
5365
|
+
string;
|
|
5366
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5367
|
+
upload_protocol?:
|
|
5368
|
+
string;
|
|
5369
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5370
|
+
uploadType?:
|
|
5371
|
+
string;
|
|
5372
|
+
}): Request<GoogleLongrunningOperation>;
|
|
5373
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
2973
5374
|
list(request?: {
|
|
2974
5375
|
/** V1 error format. */
|
|
2975
5376
|
"$.xgafv"?:
|
|
@@ -2986,30 +5387,68 @@ declare namespace gapi.client {
|
|
|
2986
5387
|
/** Selector specifying which fields to include in a partial response. */
|
|
2987
5388
|
fields?:
|
|
2988
5389
|
string;
|
|
5390
|
+
/** The standard list filter. */
|
|
5391
|
+
filter?:
|
|
5392
|
+
string;
|
|
2989
5393
|
/** 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. */
|
|
2990
5394
|
key?:
|
|
2991
5395
|
string;
|
|
5396
|
+
/** The name of the operation's parent resource. */
|
|
5397
|
+
name:
|
|
5398
|
+
string;
|
|
2992
5399
|
/** OAuth 2.0 token for the current user. */
|
|
2993
5400
|
oauth_token?:
|
|
2994
5401
|
string;
|
|
2995
|
-
/**
|
|
2996
|
-
* Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative,
|
|
2997
|
-
* an `INVALID_ARGUMENT` error is returned.
|
|
2998
|
-
*/
|
|
5402
|
+
/** The standard list page size. */
|
|
2999
5403
|
pageSize?:
|
|
3000
5404
|
number;
|
|
3001
|
-
/**
|
|
3002
|
-
* A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
|
|
3003
|
-
* all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
3004
|
-
*/
|
|
5405
|
+
/** The standard list page token. */
|
|
3005
5406
|
pageToken?:
|
|
3006
5407
|
string;
|
|
3007
|
-
/**
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
5408
|
+
/** Returns response with indentations and line breaks. */
|
|
5409
|
+
prettyPrint?:
|
|
5410
|
+
boolean;
|
|
5411
|
+
/** 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. */
|
|
5412
|
+
quotaUser?:
|
|
5413
|
+
string;
|
|
5414
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5415
|
+
upload_protocol?:
|
|
5416
|
+
string;
|
|
5417
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5418
|
+
uploadType?:
|
|
5419
|
+
string;
|
|
5420
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
5421
|
+
}
|
|
5422
|
+
interface ModelsResource {
|
|
5423
|
+
operations:
|
|
5424
|
+
OperationsResource;
|
|
5425
|
+
}
|
|
5426
|
+
interface OperationsResource {
|
|
5427
|
+
/** 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. */
|
|
5428
|
+
get(request?: {
|
|
5429
|
+
/** V1 error format. */
|
|
5430
|
+
"$.xgafv"?:
|
|
5431
|
+
string;
|
|
5432
|
+
/** OAuth access token. */
|
|
5433
|
+
access_token?:
|
|
5434
|
+
string;
|
|
5435
|
+
/** Data format for response. */
|
|
5436
|
+
alt?:
|
|
5437
|
+
string;
|
|
5438
|
+
/** JSONP */
|
|
5439
|
+
callback?:
|
|
5440
|
+
string;
|
|
5441
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5442
|
+
fields?:
|
|
5443
|
+
string;
|
|
5444
|
+
/** 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. */
|
|
5445
|
+
key?:
|
|
5446
|
+
string;
|
|
5447
|
+
/** The name of the operation resource. */
|
|
5448
|
+
name:
|
|
5449
|
+
string;
|
|
5450
|
+
/** OAuth 2.0 token for the current user. */
|
|
5451
|
+
oauth_token?:
|
|
3013
5452
|
string;
|
|
3014
5453
|
/** Returns response with indentations and line breaks. */
|
|
3015
5454
|
prettyPrint?:
|
|
@@ -3023,18 +5462,15 @@ declare namespace gapi.client {
|
|
|
3023
5462
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3024
5463
|
uploadType?:
|
|
3025
5464
|
string;
|
|
3026
|
-
}): Request<
|
|
3027
|
-
/**
|
|
3028
|
-
|
|
5465
|
+
}): Request<GoogleLongrunningOperation>;
|
|
5466
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
5467
|
+
list(request?: {
|
|
3029
5468
|
/** V1 error format. */
|
|
3030
5469
|
"$.xgafv"?:
|
|
3031
5470
|
string;
|
|
3032
5471
|
/** OAuth access token. */
|
|
3033
5472
|
access_token?:
|
|
3034
5473
|
string;
|
|
3035
|
-
/** If set to true, and the Document is not found, a new Document will be created. */
|
|
3036
|
-
allowMissing?:
|
|
3037
|
-
boolean;
|
|
3038
5474
|
/** Data format for response. */
|
|
3039
5475
|
alt?:
|
|
3040
5476
|
string;
|
|
@@ -3044,19 +5480,24 @@ declare namespace gapi.client {
|
|
|
3044
5480
|
/** Selector specifying which fields to include in a partial response. */
|
|
3045
5481
|
fields?:
|
|
3046
5482
|
string;
|
|
5483
|
+
/** The standard list filter. */
|
|
5484
|
+
filter?:
|
|
5485
|
+
string;
|
|
3047
5486
|
/** 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. */
|
|
3048
5487
|
key?:
|
|
3049
5488
|
string;
|
|
3050
|
-
/**
|
|
3051
|
-
* Immutable. The full resource name of the document. Format:
|
|
3052
|
-
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
3053
|
-
* with a length limit of 1024 characters.
|
|
3054
|
-
*/
|
|
5489
|
+
/** The name of the operation's parent resource. */
|
|
3055
5490
|
name:
|
|
3056
5491
|
string;
|
|
3057
5492
|
/** OAuth 2.0 token for the current user. */
|
|
3058
5493
|
oauth_token?:
|
|
3059
5494
|
string;
|
|
5495
|
+
/** The standard list page size. */
|
|
5496
|
+
pageSize?:
|
|
5497
|
+
number;
|
|
5498
|
+
/** The standard list page token. */
|
|
5499
|
+
pageToken?:
|
|
5500
|
+
string;
|
|
3060
5501
|
/** Returns response with indentations and line breaks. */
|
|
3061
5502
|
prettyPrint?:
|
|
3062
5503
|
boolean;
|
|
@@ -3069,20 +5510,17 @@ declare namespace gapi.client {
|
|
|
3069
5510
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3070
5511
|
uploadType?:
|
|
3071
5512
|
string;
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
5513
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
5514
|
+
}
|
|
5515
|
+
interface SchemasResource {
|
|
5516
|
+
/** Creates a Schema. */
|
|
5517
|
+
create(request: {
|
|
3077
5518
|
/** V1 error format. */
|
|
3078
5519
|
"$.xgafv"?:
|
|
3079
5520
|
string;
|
|
3080
5521
|
/** OAuth access token. */
|
|
3081
5522
|
access_token?:
|
|
3082
5523
|
string;
|
|
3083
|
-
/** If set to true, and the Document is not found, a new Document will be created. */
|
|
3084
|
-
allowMissing?:
|
|
3085
|
-
boolean;
|
|
3086
5524
|
/** Data format for response. */
|
|
3087
5525
|
alt?:
|
|
3088
5526
|
string;
|
|
@@ -3095,36 +5533,35 @@ declare namespace gapi.client {
|
|
|
3095
5533
|
/** 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. */
|
|
3096
5534
|
key?:
|
|
3097
5535
|
string;
|
|
3098
|
-
/**
|
|
3099
|
-
* Immutable. The full resource name of the document. Format:
|
|
3100
|
-
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
3101
|
-
* with a length limit of 1024 characters.
|
|
3102
|
-
*/
|
|
3103
|
-
name:
|
|
3104
|
-
string;
|
|
3105
5536
|
/** OAuth 2.0 token for the current user. */
|
|
3106
5537
|
oauth_token?:
|
|
3107
5538
|
string;
|
|
5539
|
+
/** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
5540
|
+
parent:
|
|
5541
|
+
string;
|
|
3108
5542
|
/** Returns response with indentations and line breaks. */
|
|
3109
5543
|
prettyPrint?:
|
|
3110
5544
|
boolean;
|
|
3111
5545
|
/** 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. */
|
|
3112
5546
|
quotaUser?:
|
|
3113
5547
|
string;
|
|
5548
|
+
/**
|
|
5549
|
+
* Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
5550
|
+
* standard with a length limit of 63 characters.
|
|
5551
|
+
*/
|
|
5552
|
+
schemaId?:
|
|
5553
|
+
string;
|
|
3114
5554
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3115
5555
|
upload_protocol?:
|
|
3116
5556
|
string;
|
|
3117
5557
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3118
5558
|
uploadType?:
|
|
3119
5559
|
string;
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
* deleted, set PurgeDocumentsRequest.force to false.
|
|
3126
|
-
*/
|
|
3127
|
-
purge(request: {
|
|
5560
|
+
/** Request body */
|
|
5561
|
+
resource:
|
|
5562
|
+
GoogleCloudDiscoveryengineV1alphaSchema;
|
|
5563
|
+
}): Request<GoogleLongrunningOperation>;
|
|
5564
|
+
create(request: {
|
|
3128
5565
|
/** V1 error format. */
|
|
3129
5566
|
"$.xgafv"?:
|
|
3130
5567
|
string;
|
|
@@ -3146,7 +5583,7 @@ declare namespace gapi.client {
|
|
|
3146
5583
|
/** OAuth 2.0 token for the current user. */
|
|
3147
5584
|
oauth_token?:
|
|
3148
5585
|
string;
|
|
3149
|
-
/** Required. The parent resource name,
|
|
5586
|
+
/** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
3150
5587
|
parent:
|
|
3151
5588
|
string;
|
|
3152
5589
|
/** Returns response with indentations and line breaks. */
|
|
@@ -3155,17 +5592,22 @@ declare namespace gapi.client {
|
|
|
3155
5592
|
/** 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. */
|
|
3156
5593
|
quotaUser?:
|
|
3157
5594
|
string;
|
|
5595
|
+
/**
|
|
5596
|
+
* Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
5597
|
+
* standard with a length limit of 63 characters.
|
|
5598
|
+
*/
|
|
5599
|
+
schemaId?:
|
|
5600
|
+
string;
|
|
3158
5601
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3159
5602
|
upload_protocol?:
|
|
3160
5603
|
string;
|
|
3161
5604
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3162
5605
|
uploadType?:
|
|
3163
5606
|
string;
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
purge(request: {
|
|
5607
|
+
},
|
|
5608
|
+
body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
|
|
5609
|
+
/** Deletes a Schema. */
|
|
5610
|
+
delete(request?: {
|
|
3169
5611
|
/** V1 error format. */
|
|
3170
5612
|
"$.xgafv"?:
|
|
3171
5613
|
string;
|
|
@@ -3184,12 +5626,12 @@ declare namespace gapi.client {
|
|
|
3184
5626
|
/** 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. */
|
|
3185
5627
|
key?:
|
|
3186
5628
|
string;
|
|
5629
|
+
/** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
|
|
5630
|
+
name:
|
|
5631
|
+
string;
|
|
3187
5632
|
/** OAuth 2.0 token for the current user. */
|
|
3188
5633
|
oauth_token?:
|
|
3189
5634
|
string;
|
|
3190
|
-
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
3191
|
-
parent:
|
|
3192
|
-
string;
|
|
3193
5635
|
/** Returns response with indentations and line breaks. */
|
|
3194
5636
|
prettyPrint?:
|
|
3195
5637
|
boolean;
|
|
@@ -3202,11 +5644,8 @@ declare namespace gapi.client {
|
|
|
3202
5644
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3203
5645
|
uploadType?:
|
|
3204
5646
|
string;
|
|
3205
|
-
}
|
|
3206
|
-
|
|
3207
|
-
}
|
|
3208
|
-
interface OperationsResource {
|
|
3209
|
-
/** 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. */
|
|
5647
|
+
}): Request<GoogleLongrunningOperation>;
|
|
5648
|
+
/** Gets a Schema. */
|
|
3210
5649
|
get(request?: {
|
|
3211
5650
|
/** V1 error format. */
|
|
3212
5651
|
"$.xgafv"?:
|
|
@@ -3226,7 +5665,7 @@ declare namespace gapi.client {
|
|
|
3226
5665
|
/** 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. */
|
|
3227
5666
|
key?:
|
|
3228
5667
|
string;
|
|
3229
|
-
/** The name of the
|
|
5668
|
+
/** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
|
|
3230
5669
|
name:
|
|
3231
5670
|
string;
|
|
3232
5671
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -3244,8 +5683,8 @@ declare namespace gapi.client {
|
|
|
3244
5683
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3245
5684
|
uploadType?:
|
|
3246
5685
|
string;
|
|
3247
|
-
}): Request<
|
|
3248
|
-
/**
|
|
5686
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSchema>;
|
|
5687
|
+
/** Gets a list of Schemas. */
|
|
3249
5688
|
list(request?: {
|
|
3250
5689
|
/** V1 error format. */
|
|
3251
5690
|
"$.xgafv"?:
|
|
@@ -3262,24 +5701,27 @@ declare namespace gapi.client {
|
|
|
3262
5701
|
/** Selector specifying which fields to include in a partial response. */
|
|
3263
5702
|
fields?:
|
|
3264
5703
|
string;
|
|
3265
|
-
/** The standard list filter. */
|
|
3266
|
-
filter?:
|
|
3267
|
-
string;
|
|
3268
5704
|
/** 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. */
|
|
3269
5705
|
key?:
|
|
3270
5706
|
string;
|
|
3271
|
-
/** The name of the operation's parent resource. */
|
|
3272
|
-
name:
|
|
3273
|
-
string;
|
|
3274
5707
|
/** OAuth 2.0 token for the current user. */
|
|
3275
5708
|
oauth_token?:
|
|
3276
5709
|
string;
|
|
3277
|
-
/**
|
|
5710
|
+
/**
|
|
5711
|
+
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values
|
|
5712
|
+
* above 1000 will be coerced to 1000.
|
|
5713
|
+
*/
|
|
3278
5714
|
pageSize?:
|
|
3279
5715
|
number;
|
|
3280
|
-
/**
|
|
5716
|
+
/**
|
|
5717
|
+
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
5718
|
+
* SchemaService.ListSchemas must match the call that provided the page token.
|
|
5719
|
+
*/
|
|
3281
5720
|
pageToken?:
|
|
3282
5721
|
string;
|
|
5722
|
+
/** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
5723
|
+
parent:
|
|
5724
|
+
string;
|
|
3283
5725
|
/** Returns response with indentations and line breaks. */
|
|
3284
5726
|
prettyPrint?:
|
|
3285
5727
|
boolean;
|
|
@@ -3292,23 +5734,18 @@ declare namespace gapi.client {
|
|
|
3292
5734
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3293
5735
|
uploadType?:
|
|
3294
5736
|
string;
|
|
3295
|
-
}): Request<
|
|
3296
|
-
|
|
3297
|
-
|
|
3298
|
-
documents:
|
|
3299
|
-
DocumentsResource;
|
|
3300
|
-
operations:
|
|
3301
|
-
OperationsResource;
|
|
3302
|
-
}
|
|
3303
|
-
interface OperationsResource {
|
|
3304
|
-
/** 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. */
|
|
3305
|
-
get(request?: {
|
|
5737
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSchemasResponse>;
|
|
5738
|
+
/** Updates a Schema. */
|
|
5739
|
+
patch(request: {
|
|
3306
5740
|
/** V1 error format. */
|
|
3307
5741
|
"$.xgafv"?:
|
|
3308
5742
|
string;
|
|
3309
5743
|
/** OAuth access token. */
|
|
3310
5744
|
access_token?:
|
|
3311
5745
|
string;
|
|
5746
|
+
/** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
|
|
5747
|
+
allowMissing?:
|
|
5748
|
+
boolean;
|
|
3312
5749
|
/** Data format for response. */
|
|
3313
5750
|
alt?:
|
|
3314
5751
|
string;
|
|
@@ -3321,7 +5758,10 @@ declare namespace gapi.client {
|
|
|
3321
5758
|
/** 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. */
|
|
3322
5759
|
key?:
|
|
3323
5760
|
string;
|
|
3324
|
-
/**
|
|
5761
|
+
/**
|
|
5762
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
|
5763
|
+
* This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
5764
|
+
*/
|
|
3325
5765
|
name:
|
|
3326
5766
|
string;
|
|
3327
5767
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -3339,15 +5779,20 @@ declare namespace gapi.client {
|
|
|
3339
5779
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3340
5780
|
uploadType?:
|
|
3341
5781
|
string;
|
|
5782
|
+
/** Request body */
|
|
5783
|
+
resource:
|
|
5784
|
+
GoogleCloudDiscoveryengineV1alphaSchema;
|
|
3342
5785
|
}): Request<GoogleLongrunningOperation>;
|
|
3343
|
-
|
|
3344
|
-
list(request?: {
|
|
5786
|
+
patch(request: {
|
|
3345
5787
|
/** V1 error format. */
|
|
3346
5788
|
"$.xgafv"?:
|
|
3347
5789
|
string;
|
|
3348
5790
|
/** OAuth access token. */
|
|
3349
5791
|
access_token?:
|
|
3350
5792
|
string;
|
|
5793
|
+
/** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
|
|
5794
|
+
allowMissing?:
|
|
5795
|
+
boolean;
|
|
3351
5796
|
/** Data format for response. */
|
|
3352
5797
|
alt?:
|
|
3353
5798
|
string;
|
|
@@ -3357,24 +5802,18 @@ declare namespace gapi.client {
|
|
|
3357
5802
|
/** Selector specifying which fields to include in a partial response. */
|
|
3358
5803
|
fields?:
|
|
3359
5804
|
string;
|
|
3360
|
-
/** The standard list filter. */
|
|
3361
|
-
filter?:
|
|
3362
|
-
string;
|
|
3363
5805
|
/** 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. */
|
|
3364
5806
|
key?:
|
|
3365
5807
|
string;
|
|
3366
|
-
/**
|
|
5808
|
+
/**
|
|
5809
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
|
5810
|
+
* This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
5811
|
+
*/
|
|
3367
5812
|
name:
|
|
3368
5813
|
string;
|
|
3369
5814
|
/** OAuth 2.0 token for the current user. */
|
|
3370
5815
|
oauth_token?:
|
|
3371
5816
|
string;
|
|
3372
|
-
/** The standard list page size. */
|
|
3373
|
-
pageSize?:
|
|
3374
|
-
number;
|
|
3375
|
-
/** The standard list page token. */
|
|
3376
|
-
pageToken?:
|
|
3377
|
-
string;
|
|
3378
5817
|
/** Returns response with indentations and line breaks. */
|
|
3379
5818
|
prettyPrint?:
|
|
3380
5819
|
boolean;
|
|
@@ -3387,15 +5826,12 @@ declare namespace gapi.client {
|
|
|
3387
5826
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3388
5827
|
uploadType?:
|
|
3389
5828
|
string;
|
|
3390
|
-
}
|
|
3391
|
-
|
|
3392
|
-
interface ModelsResource {
|
|
3393
|
-
operations:
|
|
3394
|
-
OperationsResource;
|
|
5829
|
+
},
|
|
5830
|
+
body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
|
|
3395
5831
|
}
|
|
3396
|
-
interface
|
|
3397
|
-
/**
|
|
3398
|
-
|
|
5832
|
+
interface ServingConfigsResource {
|
|
5833
|
+
/** Makes a recommendation, which requires a contextual user event. */
|
|
5834
|
+
recommend(request: {
|
|
3399
5835
|
/** V1 error format. */
|
|
3400
5836
|
"$.xgafv"?:
|
|
3401
5837
|
string;
|
|
@@ -3414,9 +5850,6 @@ declare namespace gapi.client {
|
|
|
3414
5850
|
/** 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. */
|
|
3415
5851
|
key?:
|
|
3416
5852
|
string;
|
|
3417
|
-
/** The name of the operation resource. */
|
|
3418
|
-
name:
|
|
3419
|
-
string;
|
|
3420
5853
|
/** OAuth 2.0 token for the current user. */
|
|
3421
5854
|
oauth_token?:
|
|
3422
5855
|
string;
|
|
@@ -3426,15 +5859,23 @@ declare namespace gapi.client {
|
|
|
3426
5859
|
/** 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. */
|
|
3427
5860
|
quotaUser?:
|
|
3428
5861
|
string;
|
|
5862
|
+
/**
|
|
5863
|
+
* Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model,
|
|
5864
|
+
* you must create at least one serving config for it.
|
|
5865
|
+
*/
|
|
5866
|
+
servingConfig:
|
|
5867
|
+
string;
|
|
3429
5868
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3430
5869
|
upload_protocol?:
|
|
3431
5870
|
string;
|
|
3432
5871
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3433
5872
|
uploadType?:
|
|
3434
5873
|
string;
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
5874
|
+
/** Request body */
|
|
5875
|
+
resource:
|
|
5876
|
+
GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
5877
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
5878
|
+
recommend(request: {
|
|
3438
5879
|
/** V1 error format. */
|
|
3439
5880
|
"$.xgafv"?:
|
|
3440
5881
|
string;
|
|
@@ -3450,41 +5891,34 @@ declare namespace gapi.client {
|
|
|
3450
5891
|
/** Selector specifying which fields to include in a partial response. */
|
|
3451
5892
|
fields?:
|
|
3452
5893
|
string;
|
|
3453
|
-
/** The standard list filter. */
|
|
3454
|
-
filter?:
|
|
3455
|
-
string;
|
|
3456
5894
|
/** 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. */
|
|
3457
5895
|
key?:
|
|
3458
5896
|
string;
|
|
3459
|
-
/** The name of the operation's parent resource. */
|
|
3460
|
-
name:
|
|
3461
|
-
string;
|
|
3462
5897
|
/** OAuth 2.0 token for the current user. */
|
|
3463
5898
|
oauth_token?:
|
|
3464
5899
|
string;
|
|
3465
|
-
/** The standard list page size. */
|
|
3466
|
-
pageSize?:
|
|
3467
|
-
number;
|
|
3468
|
-
/** The standard list page token. */
|
|
3469
|
-
pageToken?:
|
|
3470
|
-
string;
|
|
3471
5900
|
/** Returns response with indentations and line breaks. */
|
|
3472
5901
|
prettyPrint?:
|
|
3473
5902
|
boolean;
|
|
3474
5903
|
/** 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. */
|
|
3475
5904
|
quotaUser?:
|
|
3476
5905
|
string;
|
|
5906
|
+
/**
|
|
5907
|
+
* Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model,
|
|
5908
|
+
* you must create at least one serving config for it.
|
|
5909
|
+
*/
|
|
5910
|
+
servingConfig:
|
|
5911
|
+
string;
|
|
3477
5912
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3478
5913
|
upload_protocol?:
|
|
3479
5914
|
string;
|
|
3480
5915
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3481
5916
|
uploadType?:
|
|
3482
5917
|
string;
|
|
3483
|
-
}
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
recommend(request: {
|
|
5918
|
+
},
|
|
5919
|
+
body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
5920
|
+
/** Performs a search. */
|
|
5921
|
+
search(request: {
|
|
3488
5922
|
/** V1 error format. */
|
|
3489
5923
|
"$.xgafv"?:
|
|
3490
5924
|
string;
|
|
@@ -3513,8 +5947,9 @@ declare namespace gapi.client {
|
|
|
3513
5947
|
quotaUser?:
|
|
3514
5948
|
string;
|
|
3515
5949
|
/**
|
|
3516
|
-
* Required.
|
|
3517
|
-
*
|
|
5950
|
+
* Required. The resource name of the Search serving config, such as
|
|
5951
|
+
* `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
|
|
5952
|
+
* configuration name, set of models used to make the search.
|
|
3518
5953
|
*/
|
|
3519
5954
|
servingConfig:
|
|
3520
5955
|
string;
|
|
@@ -3526,9 +5961,9 @@ declare namespace gapi.client {
|
|
|
3526
5961
|
string;
|
|
3527
5962
|
/** Request body */
|
|
3528
5963
|
resource:
|
|
3529
|
-
|
|
3530
|
-
}): Request<
|
|
3531
|
-
|
|
5964
|
+
GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
5965
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
5966
|
+
search(request: {
|
|
3532
5967
|
/** V1 error format. */
|
|
3533
5968
|
"$.xgafv"?:
|
|
3534
5969
|
string;
|
|
@@ -3557,8 +5992,9 @@ declare namespace gapi.client {
|
|
|
3557
5992
|
quotaUser?:
|
|
3558
5993
|
string;
|
|
3559
5994
|
/**
|
|
3560
|
-
* Required.
|
|
3561
|
-
*
|
|
5995
|
+
* Required. The resource name of the Search serving config, such as
|
|
5996
|
+
* `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
|
|
5997
|
+
* configuration name, set of models used to make the search.
|
|
3562
5998
|
*/
|
|
3563
5999
|
servingConfig:
|
|
3564
6000
|
string;
|
|
@@ -3569,7 +6005,7 @@ declare namespace gapi.client {
|
|
|
3569
6005
|
uploadType?:
|
|
3570
6006
|
string;
|
|
3571
6007
|
},
|
|
3572
|
-
body:
|
|
6008
|
+
body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
3573
6009
|
}
|
|
3574
6010
|
interface UserEventsResource {
|
|
3575
6011
|
/**
|
|
@@ -3883,12 +6319,83 @@ declare namespace gapi.client {
|
|
|
3883
6319
|
body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
3884
6320
|
}
|
|
3885
6321
|
interface DataStoresResource {
|
|
6322
|
+
/** Completes the specified user input with keyword suggestions. */
|
|
6323
|
+
completeQuery(request?: {
|
|
6324
|
+
/** V1 error format. */
|
|
6325
|
+
"$.xgafv"?:
|
|
6326
|
+
string;
|
|
6327
|
+
/** OAuth access token. */
|
|
6328
|
+
access_token?:
|
|
6329
|
+
string;
|
|
6330
|
+
/** Data format for response. */
|
|
6331
|
+
alt?:
|
|
6332
|
+
string;
|
|
6333
|
+
/** JSONP */
|
|
6334
|
+
callback?:
|
|
6335
|
+
string;
|
|
6336
|
+
/**
|
|
6337
|
+
* Required. The parent data store resource name for which the completion is performed, such as
|
|
6338
|
+
* `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
|
|
6339
|
+
*/
|
|
6340
|
+
dataStore:
|
|
6341
|
+
string;
|
|
6342
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6343
|
+
fields?:
|
|
6344
|
+
string;
|
|
6345
|
+
/**
|
|
6346
|
+
* Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query,
|
|
6347
|
+
* those are returned and no tail suggestions are returned.
|
|
6348
|
+
*/
|
|
6349
|
+
includeTailSuggestions?:
|
|
6350
|
+
boolean;
|
|
6351
|
+
/** 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. */
|
|
6352
|
+
key?:
|
|
6353
|
+
string;
|
|
6354
|
+
/** OAuth 2.0 token for the current user. */
|
|
6355
|
+
oauth_token?:
|
|
6356
|
+
string;
|
|
6357
|
+
/** Returns response with indentations and line breaks. */
|
|
6358
|
+
prettyPrint?:
|
|
6359
|
+
boolean;
|
|
6360
|
+
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
6361
|
+
query?:
|
|
6362
|
+
string;
|
|
6363
|
+
/**
|
|
6364
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` -
|
|
6365
|
+
* Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions
|
|
6366
|
+
* generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:
|
|
6367
|
+
* * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
|
|
6368
|
+
*/
|
|
6369
|
+
queryModel?:
|
|
6370
|
+
string;
|
|
6371
|
+
/** 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. */
|
|
6372
|
+
quotaUser?:
|
|
6373
|
+
string;
|
|
6374
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6375
|
+
upload_protocol?:
|
|
6376
|
+
string;
|
|
6377
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6378
|
+
uploadType?:
|
|
6379
|
+
string;
|
|
6380
|
+
/**
|
|
6381
|
+
* 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.
|
|
6382
|
+
* 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`. This should be the
|
|
6383
|
+
* same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
|
|
6384
|
+
* `INVALID_ARGUMENT` error is returned.
|
|
6385
|
+
*/
|
|
6386
|
+
userPseudoId?:
|
|
6387
|
+
string;
|
|
6388
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
|
|
3886
6389
|
branches:
|
|
3887
6390
|
BranchesResource;
|
|
6391
|
+
conversations:
|
|
6392
|
+
ConversationsResource;
|
|
3888
6393
|
models:
|
|
3889
6394
|
ModelsResource;
|
|
3890
6395
|
operations:
|
|
3891
6396
|
OperationsResource;
|
|
6397
|
+
schemas:
|
|
6398
|
+
SchemasResource;
|
|
3892
6399
|
servingConfigs:
|
|
3893
6400
|
ServingConfigsResource;
|
|
3894
6401
|
userEvents:
|