You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.locations.html
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -174,6 +174,7 @@ <h3>Method Details</h3>
174
174
"field": "A String", # Required. Registered field name. The format is `field.abc`.
175
175
},
176
176
},
177
+
"industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
177
178
"llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
178
179
"minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
179
180
"name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
@@ -201,7 +202,7 @@ <h3>Method Details</h3>
201
202
"dataStore": "A String", # Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
202
203
"includeTailSuggestions": True or False, # 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, those are returned and no tail suggestions are returned.
203
204
"query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
204
-
"queryModel": "A String", # Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - 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 generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
205
+
"queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - 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 generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
205
206
"userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the 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 `INVALID_ARGUMENT` error is returned.
206
207
},
207
208
"configId": "A String", # Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -169,7 +169,7 @@ <h3>Method Details</h3>
169
169
dataStore: string, Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. (required)
170
170
includeTailSuggestions: boolean, 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, those are returned and no tail suggestions are returned.
171
171
query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
172
-
queryModel: string, Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - 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 generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
172
+
queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - 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 generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
173
173
userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the 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 `INVALID_ARGUMENT` error is returned.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -257,6 +257,7 @@ <h3>Method Details</h3>
257
257
"exactMatch": True or False, # 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 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 pattern to be used by the search engine.
"quotaFailure": { # Failed due to insufficient quota.
260
+
"totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
260
261
},
261
262
},
262
263
"generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
@@ -267,7 +268,7 @@ <h3>Method Details</h3>
267
268
"siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
268
269
"verifyTime": "A String", # Latest site verification time.
269
270
},
270
-
"type": "A String", # The type of the target site, e.g. whether the site is to be included or excluded.
271
+
"type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
271
272
"updateTime": "A String", # Output only. The target site's last updated time.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.html
+10-5Lines changed: 10 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,7 @@ <h3>Method Details</h3>
121
121
"exactMatch": True or False, # 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 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 pattern to be used by the search engine.
"quotaFailure": { # Failed due to insufficient quota.
124
+
"totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
124
125
},
125
126
},
126
127
"generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
@@ -131,7 +132,7 @@ <h3>Method Details</h3>
131
132
"siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
132
133
"verifyTime": "A String", # Latest site verification time.
133
134
},
134
-
"type": "A String", # The type of the target site, e.g. whether the site is to be included or excluded.
135
+
"type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
135
136
"updateTime": "A String", # Output only. The target site's last updated time.
136
137
},
137
138
},
@@ -185,6 +186,7 @@ <h3>Method Details</h3>
185
186
"exactMatch": True or False, # 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 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 pattern to be used by the search engine.
"quotaFailure": { # Failed due to insufficient quota.
189
+
"totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
188
190
},
189
191
},
190
192
"generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
@@ -195,7 +197,7 @@ <h3>Method Details</h3>
195
197
"siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
196
198
"verifyTime": "A String", # Latest site verification time.
197
199
},
198
-
"type": "A String", # The type of the target site, e.g. whether the site is to be included or excluded.
200
+
"type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
199
201
"updateTime": "A String", # Output only. The target site's last updated time.
200
202
}
201
203
@@ -281,6 +283,7 @@ <h3>Method Details</h3>
281
283
"exactMatch": True or False, # 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 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 pattern to be used by the search engine.
"quotaFailure": { # Failed due to insufficient quota.
286
+
"totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
284
287
},
285
288
},
286
289
"generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
@@ -291,7 +294,7 @@ <h3>Method Details</h3>
291
294
"siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
292
295
"verifyTime": "A String", # Latest site verification time.
293
296
},
294
-
"type": "A String", # The type of the target site, e.g. whether the site is to be included or excluded.
297
+
"type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
295
298
"updateTime": "A String", # Output only. The target site's last updated time.
296
299
}</pre>
297
300
</div>
@@ -319,6 +322,7 @@ <h3>Method Details</h3>
319
322
"exactMatch": True or False, # 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 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 pattern to be used by the search engine.
"quotaFailure": { # Failed due to insufficient quota.
325
+
"totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
322
326
},
323
327
},
324
328
"generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
@@ -329,7 +333,7 @@ <h3>Method Details</h3>
329
333
"siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
330
334
"verifyTime": "A String", # Latest site verification time.
331
335
},
332
-
"type": "A String", # The type of the target site, e.g. whether the site is to be included or excluded.
336
+
"type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
333
337
"updateTime": "A String", # Output only. The target site's last updated time.
334
338
},
335
339
],
@@ -364,6 +368,7 @@ <h3>Method Details</h3>
364
368
"exactMatch": True or False, # 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 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 pattern to be used by the search engine.
"quotaFailure": { # Failed due to insufficient quota.
371
+
"totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
367
372
},
368
373
},
369
374
"generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
@@ -374,7 +379,7 @@ <h3>Method Details</h3>
374
379
"siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
375
380
"verifyTime": "A String", # Latest site verification time.
376
381
},
377
-
"type": "A String", # The type of the target site, e.g. whether the site is to be included or excluded.
382
+
"type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
378
383
"updateTime": "A String", # Output only. The target site's last updated time.
0 commit comments