Vertex AI API

Train high-quality custom machine learning models with minimal machine learning expertise and effort.

Service: aiplatform.googleapis.com

The Service name aiplatform.googleapis.com is needed to create RPC client stubs.

google.cloud.aiplatform.v1.DatasetService

Methods
CreateDataset Creates a Dataset.
DeleteDataset Deletes a Dataset.
ExportData Exports data from a Dataset.
GetAnnotationSpec Gets an AnnotationSpec.
GetDataset Gets a Dataset.
ImportData Imports data into a Dataset.
ListAnnotations Lists Annotations belongs to a dataitem
ListDataItems Lists DataItems in a Dataset.
ListDatasets Lists Datasets in a Location.
UpdateDataset Updates a Dataset.

google.cloud.aiplatform.v1.EndpointService

Methods
CreateEndpoint Creates an Endpoint.
DeleteEndpoint Deletes an Endpoint.
DeployModel Deploys a Model into this Endpoint, creating a DeployedModel within it.
GetEndpoint Gets an Endpoint.
ListEndpoints Lists Endpoints in a Location.
UndeployModel Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
UpdateEndpoint Updates an Endpoint.

google.cloud.aiplatform.v1.JobService

Methods
CancelBatchPredictionJob Cancels a BatchPredictionJob.
CancelCustomJob Cancels a CustomJob.
CancelDataLabelingJob Cancels a DataLabelingJob.
CancelHyperparameterTuningJob Cancels a HyperparameterTuningJob.
CreateBatchPredictionJob Creates a BatchPredictionJob.
CreateCustomJob Creates a CustomJob.
CreateDataLabelingJob Creates a DataLabelingJob.
CreateHyperparameterTuningJob Creates a HyperparameterTuningJob
DeleteBatchPredictionJob Deletes a BatchPredictionJob.
DeleteCustomJob Deletes a CustomJob.
DeleteDataLabelingJob Deletes a DataLabelingJob.
DeleteHyperparameterTuningJob Deletes a HyperparameterTuningJob.
GetBatchPredictionJob Gets a BatchPredictionJob
GetCustomJob Gets a CustomJob.
GetDataLabelingJob Gets a DataLabelingJob.
GetHyperparameterTuningJob Gets a HyperparameterTuningJob
ListBatchPredictionJobs Lists BatchPredictionJobs in a Location.
ListCustomJobs Lists CustomJobs in a Location.
ListDataLabelingJobs Lists DataLabelingJobs in a Location.
ListHyperparameterTuningJobs Lists HyperparameterTuningJobs in a Location.

google.cloud.aiplatform.v1.MigrationService

Methods
BatchMigrateResources Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
SearchMigratableResources Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

google.cloud.aiplatform.v1.ModelService

Methods
DeleteModel Deletes a Model.
ExportModel Exports a trained, exportable, Model to a location specified by the user.
GetModel Gets a Model.
GetModelEvaluation Gets a ModelEvaluation.
GetModelEvaluationSlice Gets a ModelEvaluationSlice.
ListModelEvaluationSlices Lists ModelEvaluationSlices in a ModelEvaluation.
ListModelEvaluations Lists ModelEvaluations in a Model.
ListModels Lists Models in a Location.
UpdateModel Updates a Model.
UploadModel Uploads a Model artifact into Vertex AI.

google.cloud.aiplatform.v1.PipelineService

Methods
CancelPipelineJob Cancels a PipelineJob.
CancelTrainingPipeline Cancels a TrainingPipeline.
CreatePipelineJob Creates a PipelineJob.
CreateTrainingPipeline Creates a TrainingPipeline.
DeletePipelineJob Deletes a PipelineJob.
DeleteTrainingPipeline Deletes a TrainingPipeline.
GetPipelineJob Gets a PipelineJob.
GetTrainingPipeline Gets a TrainingPipeline.
ListPipelineJobs Lists PipelineJobs in a Location.
ListTrainingPipelines Lists TrainingPipelines in a Location.

google.cloud.aiplatform.v1.PredictionService

Methods
Predict Perform an online prediction.

google.cloud.aiplatform.v1.SpecialistPoolService

Methods
CreateSpecialistPool Creates a SpecialistPool.
DeleteSpecialistPool Deletes a SpecialistPool as well as all Specialists in the pool.
GetSpecialistPool Gets a SpecialistPool.
ListSpecialistPools Lists SpecialistPools in a Location.
UpdateSpecialistPool Updates a SpecialistPool.

google.cloud.aiplatform.v1beta1.DatasetService

Methods
CreateDataset Creates a Dataset.
DeleteDataset Deletes a Dataset.
ExportData Exports data from a Dataset.
GetAnnotationSpec Gets an AnnotationSpec.
GetDataset Gets a Dataset.
ImportData Imports data into a Dataset.
ListAnnotations Lists Annotations belongs to a dataitem
ListDataItems Lists DataItems in a Dataset.
ListDatasets Lists Datasets in a Location.
UpdateDataset Updates a Dataset.

google.cloud.aiplatform.v1beta1.EndpointService

Methods
CreateEndpoint Creates an Endpoint.
DeleteEndpoint Deletes an Endpoint.
DeployModel Deploys a Model into this Endpoint, creating a DeployedModel within it.
GetEndpoint Gets an Endpoint.
ListEndpoints Lists Endpoints in a Location.
UndeployModel Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
UpdateEndpoint Updates an Endpoint.

google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService

Methods
ReadFeatureValues Reads Feature values of a specific entity of an EntityType.
StreamingReadFeatureValues Reads Feature values for multiple entities.

google.cloud.aiplatform.v1beta1.FeaturestoreService

Methods
BatchCreateFeatures Creates a batch of Features in a given EntityType.
BatchReadFeatureValues Batch reads Feature values from a Featurestore.
CreateEntityType Creates a new EntityType in a given Featurestore.
CreateFeature Creates a new Feature in a given EntityType.
CreateFeaturestore Creates a new Featurestore in a given project and location.
DeleteEntityType Deletes a single EntityType.
DeleteFeature Deletes a single Feature.
DeleteFeaturestore Deletes a single Featurestore.
ExportFeatureValues Exports Feature values from all the entities of a target EntityType.
GetEntityType Gets details of a single EntityType.
GetFeature Gets details of a single Feature.
GetFeaturestore Gets details of a single Featurestore.
ImportFeatureValues Imports Feature values into the Featurestore from a source storage.
ListEntityTypes Lists EntityTypes in a given Featurestore.
ListFeatures Lists Features in a given EntityType.
ListFeaturestores Lists Featurestores in a given project and location.
SearchFeatures Searches Features matching a query in a given project.
UpdateEntityType Updates the parameters of a single EntityType.
UpdateFeature Updates the parameters of a single Feature.
UpdateFeaturestore Updates the parameters of a single Featurestore.

google.cloud.aiplatform.v1beta1.IndexEndpointService

Methods
CreateIndexEndpoint Creates an IndexEndpoint.
DeleteIndexEndpoint Deletes an IndexEndpoint.
DeployIndex Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
GetIndexEndpoint Gets an IndexEndpoint.
ListIndexEndpoints Lists IndexEndpoints in a Location.
UndeployIndex Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
UpdateIndexEndpoint Updates an IndexEndpoint.

google.cloud.aiplatform.v1beta1.IndexService

Methods
CreateIndex Creates an Index.
DeleteIndex Deletes an Index.
GetIndex Gets an Index.
ListIndexes Lists Indexes in a Location.
UpdateIndex Updates an Index.

google.cloud.aiplatform.v1beta1.JobService

Methods
CancelBatchPredictionJob Cancels a BatchPredictionJob.
CancelCustomJob Cancels a CustomJob.
CancelDataLabelingJob Cancels a DataLabelingJob.
CancelHyperparameterTuningJob Cancels a HyperparameterTuningJob.
CreateBatchPredictionJob Creates a BatchPredictionJob.
CreateCustomJob Creates a CustomJob.
CreateDataLabelingJob Creates a DataLabelingJob.
CreateHyperparameterTuningJob Creates a HyperparameterTuningJob
CreateModelDeploymentMonitoringJob Creates a ModelDeploymentMonitoringJob.
DeleteBatchPredictionJob Deletes a BatchPredictionJob.
DeleteCustomJob Deletes a CustomJob.
DeleteDataLabelingJob Deletes a DataLabelingJob.
DeleteHyperparameterTuningJob Deletes a HyperparameterTuningJob.
DeleteModelDeploymentMonitoringJob Deletes a ModelDeploymentMonitoringJob.
GetBatchPredictionJob Gets a BatchPredictionJob
GetCustomJob Gets a CustomJob.
GetDataLabelingJob Gets a DataLabelingJob.
GetHyperparameterTuningJob Gets a HyperparameterTuningJob
GetModelDeploymentMonitoringJob Gets a ModelDeploymentMonitoringJob.
ListBatchPredictionJobs Lists BatchPredictionJobs in a Location.
ListCustomJobs Lists CustomJobs in a Location.
ListDataLabelingJobs Lists DataLabelingJobs in a Location.
ListHyperparameterTuningJobs Lists HyperparameterTuningJobs in a Location.
ListModelDeploymentMonitoringJobs Lists ModelDeploymentMonitoringJobs in a Location.
PauseModelDeploymentMonitoringJob Pauses a ModelDeploymentMonitoringJob.
ResumeModelDeploymentMonitoringJob Resumes a paused ModelDeploymentMonitoringJob.
SearchModelDeploymentMonitoringStatsAnomalies Searches Model Monitoring Statistics generated within a given time window.
UpdateModelDeploymentMonitoringJob Updates a ModelDeploymentMonitoringJob.

google.cloud.aiplatform.v1beta1.MetadataService

Methods
AddContextArtifactsAndExecutions Adds a set of Artifacts and Executions to a Context.
AddContextChildren Adds a set of Contexts as children to a parent Context.
AddExecutionEvents Adds Events to the specified Execution.
CreateArtifact Creates an Artifact associated with a MetadataStore.
CreateContext Creates a Context associated with a MetadataStore.
CreateExecution Creates an Execution associated with a MetadataStore.
CreateMetadataSchema Creates a MetadataSchema.
CreateMetadataStore Initializes a MetadataStore, including allocation of resources.
DeleteContext Deletes a stored Context.
DeleteMetadataStore Deletes a single MetadataStore.
GetArtifact Retrieves a specific Artifact.
GetContext Retrieves a specific Context.
GetExecution Retrieves a specific Execution.
GetMetadataSchema Retrieves a specific MetadataSchema.
GetMetadataStore Retrieves a specific MetadataStore.
ListArtifacts Lists Artifacts in the MetadataStore.
ListContexts Lists Contexts on the MetadataStore.
ListExecutions Lists Executions in the MetadataStore.
ListMetadataSchemas Lists MetadataSchemas.
ListMetadataStores Lists MetadataStores for a Location.
QueryArtifactLineageSubgraph Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
QueryContextLineageSubgraph Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
QueryExecutionInputsAndOutputs Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
UpdateArtifact Updates a stored Artifact.
UpdateContext Updates a stored Context.
UpdateExecution Updates a stored Execution.

google.cloud.aiplatform.v1beta1.MigrationService

Methods
BatchMigrateResources Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
SearchMigratableResources Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

google.cloud.aiplatform.v1beta1.ModelService

Methods
DeleteModel Deletes a Model.
ExportModel Exports a trained, exportable, Model to a location specified by the user.
GetModel Gets a Model.
GetModelEvaluation Gets a ModelEvaluation.
GetModelEvaluationSlice Gets a ModelEvaluationSlice.
ListModelEvaluationSlices Lists ModelEvaluationSlices in a ModelEvaluation.
ListModelEvaluations Lists ModelEvaluations in a Model.
ListModels Lists Models in a Location.
UpdateModel Updates a Model.
UploadModel Uploads a Model artifact into Vertex AI.

google.cloud.aiplatform.v1beta1.PipelineService

Methods
CancelPipelineJob Cancels a PipelineJob.
CancelTrainingPipeline Cancels a TrainingPipeline.
CreatePipelineJob Creates a PipelineJob.
CreateTrainingPipeline Creates a TrainingPipeline.
DeletePipelineJob Deletes a PipelineJob.
DeleteTrainingPipeline Deletes a TrainingPipeline.
GetPipelineJob Gets a PipelineJob.
GetTrainingPipeline Gets a TrainingPipeline.
ListPipelineJobs Lists PipelineJobs in a Location.
ListTrainingPipelines Lists TrainingPipelines in a Location.

google.cloud.aiplatform.v1beta1.PredictionService

Methods
Explain Perform an online explanation.
Predict Perform an online prediction.

google.cloud.aiplatform.v1beta1.SpecialistPoolService

Methods
CreateSpecialistPool Creates a SpecialistPool.
DeleteSpecialistPool Deletes a SpecialistPool as well as all Specialists in the pool.
GetSpecialistPool Gets a SpecialistPool.
ListSpecialistPools Lists SpecialistPools in a Location.
UpdateSpecialistPool Updates a SpecialistPool.

google.cloud.aiplatform.v1beta1.TensorboardService

Methods
CreateTensorboard Creates a Tensorboard.
CreateTensorboardExperiment Creates a TensorboardExperiment.
CreateTensorboardRun Creates a TensorboardRun.
CreateTensorboardTimeSeries Creates a TensorboardTimeSeries.
DeleteTensorboard Deletes a Tensorboard.
DeleteTensorboardExperiment Deletes a TensorboardExperiment.
DeleteTensorboardRun Deletes a TensorboardRun.
DeleteTensorboardTimeSeries Deletes a TensorboardTimeSeries.
ExportTensorboardTimeSeriesData Exports a TensorboardTimeSeries' data.
GetTensorboard Gets a Tensorboard.
GetTensorboardExperiment Gets a TensorboardExperiment.
GetTensorboardRun Gets a TensorboardRun.
GetTensorboardTimeSeries Gets a TensorboardTimeSeries.
ListTensorboardExperiments Lists TensorboardExperiments in a Location.
ListTensorboardRuns Lists TensorboardRuns in a Location.
ListTensorboardTimeSeries Lists TensorboardTimeSeries in a Location.
ListTensorboards Lists Tensorboards in a Location.
ReadTensorboardBlobData Gets bytes of TensorboardBlobs.
ReadTensorboardTimeSeriesData Reads a TensorboardTimeSeries' data.
UpdateTensorboard Updates a Tensorboard.
UpdateTensorboardExperiment Updates a TensorboardExperiment.
UpdateTensorboardRun Updates a TensorboardRun.
UpdateTensorboardTimeSeries Updates a TensorboardTimeSeries.
WriteTensorboardRunData Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.

google.cloud.aiplatform.v1beta1.VizierService

Methods
AddTrialMeasurement Adds a measurement of the objective metrics to a Trial.
CheckTrialEarlyStoppingState Checks whether a Trial should stop or not.
CompleteTrial Marks a Trial as complete.
CreateStudy Creates a Study.
CreateTrial Adds a user provided Trial to a Study.
DeleteStudy Deletes a Study.
DeleteTrial Deletes a Trial.
GetStudy Gets a Study by name.
GetTrial Gets a Trial.
ListOptimalTrials Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
ListStudies Lists all the studies in a region for an associated project.
ListTrials Lists the Trials associated with a Study.
LookupStudy Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
StopTrial Stops a Trial.
SuggestTrials Adds one or more Trials to a Study, with parameter values suggested by Vertex Vizier.

google.longrunning.Operations

Methods
CancelOperation Starts asynchronous cancellation on a long-running operation.
DeleteOperation Deletes a long-running operation.
GetOperation Gets the latest state of a long-running operation.
ListOperations Lists operations that match the specified filter in the request.
WaitOperation Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.