feat(aiplatform): update the api

#### aiplatform:v1 The following keys were deleted: - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.reportingMetrics.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingAttribution (Total Keys: 12) - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.groundingAttributions (Total Keys: 2) - schemas.IntelligenceCloudAutomlXpsMetricEntry (Total Keys: 14) - schemas.IntelligenceCloudAutomlXpsReportingMetrics (Total Keys: 7) The following keys were added: - resources.projects.resources.locations.resources.notebookExecutionJobs.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.notebookExecutionJobs.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.notebookExecutionJobs.methods.get (Total Keys: 13) - resources.projects.resources.locations.resources.notebookExecutionJobs.methods.list (Total Keys: 22) - resources.publishers.resources.models.methods.get.parameters.isHuggingFaceModel (Total Keys: 2) - schemas.GoogleCloudAiplatformV1Candidate.properties.score (Total Keys: 3) - schemas.GoogleCloudAiplatformV1CountTokensRequest.properties.systemInstruction.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1CountTokensRequest.properties.tools (Total Keys: 2) - schemas.GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1Endpoint.properties.dedicatedEndpointDns (Total Keys: 2) - schemas.GoogleCloudAiplatformV1Endpoint.properties.dedicatedEndpointEnabled.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1NearestNeighborQuery.properties.numericFilters (Total Keys: 2) - schemas.GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter (Total Keys: 10) - schemas.GoogleCloudAiplatformV1NotebookExecutionJob (Total Keys: 40) - schemas.GoogleCloudAiplatformV1PersistentResource.properties.pscInterfaceConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1PscInterfaceConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1RayLogsSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1RaySpec.properties.rayLogsSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Retrieval.properties.disableAttribution.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Scheduling.properties.strategy.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig.properties.disableAttribution.deprecated (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.reportingMetrics.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingAttribution (Total Keys: 17) - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.groundingAttributions (Total Keys: 2) - schemas.IntelligenceCloudAutomlXpsMetricEntry (Total Keys: 14) - schemas.IntelligenceCloudAutomlXpsReportingMetrics (Total Keys: 7) The following keys were added: - resources.publishers.resources.models.methods.get.parameters.isHuggingFaceModel (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.score (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1CountTokensRequest.properties.systemInstruction.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1CountTokensRequest.properties.tools (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.dedicatedEndpointDns (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.dedicatedEndpointEnabled.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ImportRagFilesConfig.properties.jiraSource.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ImportRagFilesConfig.properties.slackSource.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1JiraSource (Total Keys: 13) - schemas.GoogleCloudAiplatformV1beta1ModelMonitor.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ModelMonitor.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1NearestNeighborQuery.properties.numericFilters (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1PersistentResource.properties.pscInterfaceConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PipelineJob.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1PipelineJob.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1PscInterfaceConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1RagFile.properties.jiraSource.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagFile.properties.slackSource.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RayLogsSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1RaySpec.properties.rayLogsSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Retrieval.properties.disableAttribution.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Scheduling.properties.strategy.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SlackSource (Total Keys: 16)
googleapis · Jul 25, 2024 · 747f957 · 747f957
1 parent 3752c2e
commit 747f957
Show file tree

Hide file tree

Showing 29 changed files with 1,845 additions and 487 deletions.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html
@@ -175,6 +175,7 @@ <h3>Method Details</h3>
     &quot;scheduling&quot;: { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
       &quot;disableRetries&quot;: 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.
       &quot;restartJobOnWorkerRestart&quot;: 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.
+      &quot;strategy&quot;: &quot;A String&quot;, # Optional. This determines which type of scheduling strategy to use.
       &quot;timeout&quot;: &quot;A String&quot;, # The maximum job running time. The default is 7 days.
     },
     &quot;serviceAccount&quot;: &quot;A String&quot;, # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob&#x27;s project is used.
@@ -289,6 +290,7 @@ <h3>Method Details</h3>
     &quot;scheduling&quot;: { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
       &quot;disableRetries&quot;: 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.
       &quot;restartJobOnWorkerRestart&quot;: 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.
+      &quot;strategy&quot;: &quot;A String&quot;, # Optional. This determines which type of scheduling strategy to use.
       &quot;timeout&quot;: &quot;A String&quot;, # The maximum job running time. The default is 7 days.
     },
     &quot;serviceAccount&quot;: &quot;A String&quot;, # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob&#x27;s project is used.
@@ -445,6 +447,7 @@ <h3>Method Details</h3>
     &quot;scheduling&quot;: { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
       &quot;disableRetries&quot;: 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.
       &quot;restartJobOnWorkerRestart&quot;: 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.
+      &quot;strategy&quot;: &quot;A String&quot;, # Optional. This determines which type of scheduling strategy to use.
       &quot;timeout&quot;: &quot;A String&quot;, # The maximum job running time. The default is 7 days.
     },
     &quot;serviceAccount&quot;: &quot;A String&quot;, # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob&#x27;s project is used.
@@ -572,6 +575,7 @@ <h3>Method Details</h3>
         &quot;scheduling&quot;: { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
           &quot;disableRetries&quot;: 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.
           &quot;restartJobOnWorkerRestart&quot;: 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.
+          &quot;strategy&quot;: &quot;A String&quot;, # Optional. This determines which type of scheduling strategy to use.
           &quot;timeout&quot;: &quot;A String&quot;, # The maximum job running time. The default is 7 days.
         },
         &quot;serviceAccount&quot;: &quot;A String&quot;, # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob&#x27;s project is used.

diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html
@@ -120,7 +120,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
 }
 
@@ -210,7 +210,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
 }</pre>
 </div>
@@ -243,7 +243,7 @@ <h3>Method Details</h3>
       &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
       &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
       &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-      &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
+      &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
       &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
     },
   ],
@@ -270,7 +270,7 @@ <h3>Method Details</h3>
   <pre>Updates a DatasetVersion.
 
 Args:
-  name: string, Output only. The resource name of the DatasetVersion. (required)
+  name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -281,7 +281,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
 }
 
@@ -301,7 +301,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
 }</pre>
 </div>

diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.html
@@ -163,7 +163,7 @@ <h3>Method Details</h3>
   &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
   &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
   &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Dataset.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset.
   &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
     { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
       &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
@@ -336,7 +336,7 @@ <h3>Method Details</h3>
   &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
   &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
   &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Dataset.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset.
   &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
     { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
       &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
@@ -449,7 +449,7 @@ <h3>Method Details</h3>
       &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
       &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
       &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
-      &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Dataset.
+      &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset.
       &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
         { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
           &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
@@ -490,7 +490,7 @@ <h3>Method Details</h3>
   <pre>Updates a Dataset.
 
 Args:
-  name: string, Output only. The resource name of the Dataset. (required)
+  name: string, Output only. Identifier. The resource name of the Dataset. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -510,7 +510,7 @@ <h3>Method Details</h3>
   &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
   &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
   &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Dataset.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset.
   &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
     { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
       &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
@@ -553,7 +553,7 @@ <h3>Method Details</h3>
   &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
   &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
   &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Dataset.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset.
   &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
     { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
       &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.