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/aiplatform_v1.projects.locations.customJobs.html
-4Lines changed: 0 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -173,7 +173,6 @@ <h3>Method Details</h3>
173
173
],
174
174
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
175
175
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
176
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
177
176
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
178
177
"timeout": "A String", # The maximum job running time. The default is 7 days.
179
178
},
@@ -287,7 +286,6 @@ <h3>Method Details</h3>
287
286
],
288
287
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
289
288
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
290
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
291
289
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
292
290
"timeout": "A String", # The maximum job running time. The default is 7 days.
293
291
},
@@ -443,7 +441,6 @@ <h3>Method Details</h3>
443
441
],
444
442
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
445
443
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
446
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
447
444
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
448
445
"timeout": "A String", # The maximum job running time. The default is 7 days.
449
446
},
@@ -570,7 +567,6 @@ <h3>Method Details</h3>
570
567
],
571
568
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
572
569
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
573
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
574
570
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
575
571
"timeout": "A String", # The maximum job running time. The default is 7 days.
<pclass="firstline">Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.</p>
<pre>Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.
477
+
478
+
Args:
479
+
featureView: string, Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
480
+
body: object, The request body.
481
+
The object takes the form of:
482
+
483
+
{ # The request message for FeatureOnlineStoreService.SearchNearestEntities.
484
+
"query": { # A query to find a number of similar entities. # Required. The query.
485
+
"embedding": { # The embedding vector. # Optional. The embedding vector that be used for similar search.
486
+
"value": [ # Optional. Individual value in the embedding.
487
+
3.14,
488
+
],
489
+
},
490
+
"entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.
491
+
"neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query.
492
+
"parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly.
493
+
"approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
494
+
"leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.
495
+
},
496
+
"perCrowdingAttributeNeighborCount": 42, # Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.
497
+
"stringFilters": [ # Optional. The list of string filters.
498
+
{ # String filter is used to search a subset of the entities by using boolean rules on string columns. For example: if a query specifies string filter with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}',' then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future.
499
+
"allowTokens": [ # Optional. The allowed tokens.
500
+
"A String",
501
+
],
502
+
"denyTokens": [ # Optional. The denied tokens.
503
+
"A String",
504
+
],
505
+
"name": "A String", # Required. Column names in BigQuery that used as filters.
506
+
},
507
+
],
508
+
},
509
+
"returnFullEntity": True or False, # Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.
510
+
}
511
+
512
+
x__xgafv: string, V1 error format.
513
+
Allowed values
514
+
1 - v1 error format
515
+
2 - v2 error format
516
+
517
+
Returns:
518
+
An object of the form:
519
+
520
+
{ # Response message for FeatureOnlineStoreService.SearchNearestEntities
521
+
"nearestNeighbors": { # Nearest neighbors for one query. # The nearest neighbors of the query entity.
522
+
"neighbors": [ # All its neighbors.
523
+
{ # A neighbor of the query vector.
524
+
"distance": 3.14, # The distance between the neighbor and the query vector.
525
+
"entityId": "A String", # The id of the similar entity.
526
+
"entityKeyValues": { # Response message for FeatureOnlineStoreService.FetchFeatureValues # The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.
527
+
"keyValues": { # Response structure in the format of key (feature name) and (feature) value pair. # Feature values in KeyValue format.
528
+
"features": [ # List of feature names and values.
529
+
{ # Feature name & value pair.
530
+
"name": "A String", # Feature short name.
531
+
"value": { # Value for a feature. # Feature value.
532
+
"boolArrayValue": { # A list of boolean values. # A list of bool type feature value.
533
+
"values": [ # A list of bool values.
534
+
True or False,
535
+
],
536
+
},
537
+
"boolValue": True or False, # Bool type feature value.
"metadata": { # Metadata of feature value. # Metadata of feature value.
552
+
"generateTime": "A String", # Feature generation timestamp. Typically, it is provided by user at feature ingestion time. If not, feature store will use the system timestamp when the data is ingested into feature store. For streaming ingestion, the time, aligned by days, must be no older than five years (1825 days) and no later than one year (366 days) in the future.
553
+
},
554
+
"stringArrayValue": { # A list of string values. # A list of string type feature value.
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -320,7 +320,7 @@ <h3>Method Details</h3>
320
320
"updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated.
321
321
}
322
322
323
-
updateMask: string, Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `labels` * `sync_config`
323
+
updateMask: string, Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config`
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
-4Lines changed: 0 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -274,7 +274,6 @@ <h3>Method Details</h3>
274
274
],
275
275
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
276
276
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
277
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
278
277
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
279
278
"timeout": "A String", # The maximum job running time. The default is 7 days.
280
279
},
@@ -523,7 +522,6 @@ <h3>Method Details</h3>
523
522
],
524
523
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
525
524
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
526
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
527
525
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
528
526
"timeout": "A String", # The maximum job running time. The default is 7 days.
529
527
},
@@ -814,7 +812,6 @@ <h3>Method Details</h3>
814
812
],
815
813
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
816
814
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
817
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
818
815
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
819
816
"timeout": "A String", # The maximum job running time. The default is 7 days.
820
817
},
@@ -1076,7 +1073,6 @@ <h3>Method Details</h3>
1076
1073
],
1077
1074
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
1078
1075
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
1079
-
"maxWaitDuration": "A String", # Optional. This is the maximum time a user will wait in the QRM queue for resources. Default is 1 day
1080
1076
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
1081
1077
"timeout": "A String", # The maximum job running time. The default is 7 days.
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.indexes.html
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -461,6 +461,7 @@ <h3>Method Details</h3>
461
461
],
462
462
},
463
463
],
464
+
"updateMask": "A String", # Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request. Updatable fields: * Use `all_restricts` to update both restricts and numeric_restricts.
0 commit comments