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: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -174,6 +174,7 @@ <h3>Method Details</h3>
174
174
],
175
175
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
176
176
"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.
177
+
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
177
178
"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
179
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
179
180
"timeout": "A String", # The maximum job running time. The default is 7 days.
@@ -298,6 +299,7 @@ <h3>Method Details</h3>
298
299
],
299
300
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
300
301
"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.
302
+
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
301
303
"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.
302
304
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
303
305
"timeout": "A String", # The maximum job running time. The default is 7 days.
@@ -464,6 +466,7 @@ <h3>Method Details</h3>
464
466
],
465
467
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
466
468
"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.
469
+
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
467
470
"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.
468
471
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
469
472
"timeout": "A String", # The maximum job running time. The default is 7 days.
@@ -601,6 +604,7 @@ <h3>Method Details</h3>
601
604
],
602
605
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
603
606
"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.
607
+
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
604
608
"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.
605
609
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
606
610
"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.endpoints.html
+57-12Lines changed: 57 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -341,8 +341,23 @@ <h3>Method Details</h3>
341
341
},
342
342
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
343
343
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
344
-
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
345
+
"datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
346
+
},
347
+
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
348
+
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
349
+
"A String",
350
+
],
351
+
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
"ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
355
+
"A String",
356
+
],
357
+
},
358
+
],
359
+
"similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
360
+
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
346
361
},
347
362
},
348
363
},
@@ -1195,7 +1210,7 @@ <h3>Method Details</h3>
1195
1210
<pre>Generate content with multimodal inputs.
1196
1211
1197
1212
Args:
1198
-
model: string, Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` (required)
1213
+
model: string, Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
1199
1214
body: object, The request body.
1200
1215
The object takes the form of:
1201
1216
@@ -1268,12 +1283,12 @@ <h3>Method Details</h3>
1268
1283
"title": "A String", # Optional. The title of the Schema.
1269
1284
"type": "A String", # Optional. The type of the data.
"routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
1272
1287
"autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
1273
1288
"modelRoutingPreference": "A String", # The model routing preference.
1274
1289
},
1275
1290
"manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
1276
-
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001.
1291
+
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.
1277
1292
},
1278
1293
},
1279
1294
"seed": 42, # Optional. Seed.
@@ -1371,8 +1386,23 @@ <h3>Method Details</h3>
1371
1386
},
1372
1387
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
1373
1388
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
1374
-
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
1390
+
"datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
1391
+
},
1392
+
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
1393
+
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
1394
+
"A String",
1395
+
],
1396
+
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
"ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
1400
+
"A String",
1401
+
],
1402
+
},
1403
+
],
1404
+
"similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
1405
+
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
1376
1406
},
1377
1407
},
1378
1408
},
@@ -2831,7 +2861,7 @@ <h3>Method Details</h3>
2831
2861
<pre>Generate content with multimodal inputs with streaming support.
2832
2862
2833
2863
Args:
2834
-
model: string, Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` (required)
2864
+
model: string, Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
2835
2865
body: object, The request body.
2836
2866
The object takes the form of:
2837
2867
@@ -2904,12 +2934,12 @@ <h3>Method Details</h3>
2904
2934
"title": "A String", # Optional. The title of the Schema.
2905
2935
"type": "A String", # Optional. The type of the data.
"routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
2908
2938
"autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
2909
2939
"modelRoutingPreference": "A String", # The model routing preference.
2910
2940
},
2911
2941
"manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
2912
-
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001.
2942
+
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.
2913
2943
},
2914
2944
},
2915
2945
"seed": 42, # Optional. Seed.
@@ -3007,8 +3037,23 @@ <h3>Method Details</h3>
3007
3037
},
3008
3038
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
3009
3039
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
3010
-
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
3041
+
"datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
3042
+
},
3043
+
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
3044
+
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
3045
+
"A String",
3046
+
],
3047
+
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
0 commit comments