Cloud AI Platform v1 API - Namespace Google.Cloud.AIPlatform.V1 (2.12.0)

Classes

ActiveLearningConfig

Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

AddContextArtifactsAndExecutionsRequest

Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].

AddContextArtifactsAndExecutionsResponse

Response message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].

AddContextChildrenRequest

Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].

AddContextChildrenResponse

Response message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].

AddExecutionEventsRequest

Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].

AddExecutionEventsResponse

Response message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].

AddTrialMeasurementRequest

Request message for [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement].

AnnotatedDatasetName

Resource name for the AnnotatedDataset resource.

Annotation

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

AnnotationName

Resource name for the Annotation resource.

AnnotationSpec

Identifies a concept with which DataItems may be annotated with.

AnnotationSpecName

Resource name for the AnnotationSpec resource.

Artifact

Instance of a general artifact.

Artifact.Types

Container for nested types declared in the Artifact message type.

ArtifactName

Resource name for the Artifact resource.

Attribution

Attribution that explains a particular prediction output.

AutomaticResources

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.

AutoMLDatasetName

Resource name for the AutoMLDataset resource.

AutoMLModelName

Resource name for the AutoMLModel resource.

AutoscalingMetricSpec

The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.

AvroSource

The storage details for Avro input content.

BatchCreateFeaturesOperationMetadata

Details of operations that perform batch create Features.

BatchCreateFeaturesRequest

Request message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].

BatchCreateFeaturesResponse

Response message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].

BatchCreateTensorboardRunsRequest

Request message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].

BatchCreateTensorboardRunsResponse

Response message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].

BatchCreateTensorboardTimeSeriesRequest

Request message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].

BatchCreateTensorboardTimeSeriesResponse

Response message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].

BatchDedicatedResources

A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.

BatchImportEvaluatedAnnotationsRequest

Request message for [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]

BatchImportEvaluatedAnnotationsResponse

Response message for [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]

BatchImportModelEvaluationSlicesRequest

Request message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]

BatchImportModelEvaluationSlicesResponse

Response message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]

BatchMigrateResourcesOperationMetadata

Runtime operation information for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].

BatchMigrateResourcesOperationMetadata.Types

Container for nested types declared in the BatchMigrateResourcesOperationMetadata message type.

BatchMigrateResourcesOperationMetadata.Types.PartialResult

Represents a partial result in batch migration operation for one [MigrateResourceRequest][google.cloud.aiplatform.v1.MigrateResourceRequest].

BatchMigrateResourcesRequest

Request message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].

BatchMigrateResourcesResponse

Response message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].

BatchPredictionJob

A job that uses a [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce predictions on multiple [input instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.

BatchPredictionJob.Types

Container for nested types declared in the BatchPredictionJob message type.

BatchPredictionJob.Types.InputConfig

Configures the input to [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] for Model's supported input formats, and how instances should be expressed via any of them.

BatchPredictionJob.Types.InstanceConfig

Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.

BatchPredictionJob.Types.OutputConfig

Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats] for supported output formats, and how predictions are expressed via any of them.

BatchPredictionJob.Types.OutputInfo

Further describes this job's output. Supplements [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].

BatchPredictionJobName

Resource name for the BatchPredictionJob resource.

BatchReadFeatureValuesOperationMetadata

Details of operations that batch reads Feature values.

BatchReadFeatureValuesRequest

Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].

BatchReadFeatureValuesRequest.Types

Container for nested types declared in the BatchReadFeatureValuesRequest message type.

BatchReadFeatureValuesRequest.Types.EntityTypeSpec

Selects Features of an EntityType to read values of and specifies read settings.

BatchReadFeatureValuesRequest.Types.PassThroughField

Describe pass-through fields in read_instance source.

BatchReadFeatureValuesResponse

Response message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].

BatchReadTensorboardTimeSeriesDataRequest

Request message for [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].

BatchReadTensorboardTimeSeriesDataResponse

Response message for [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].

BigQueryDestination

The BigQuery location for the output content.

BigQuerySource

The BigQuery location for the input content.

BlurBaselineConfig

Config for blur baseline.

When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383

BoolArray

A list of boolean values.

CancelBatchPredictionJobRequest

Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob].

CancelCustomJobRequest

Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob].

CancelDataLabelingJobRequest

Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob].

CancelHyperparameterTuningJobRequest

Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob].

CancelNasJobRequest

Request message for [JobService.CancelNasJob][google.cloud.aiplatform.v1.JobService.CancelNasJob].

CancelPipelineJobRequest

Request message for [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob].

CancelTrainingPipelineRequest

Request message for [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline].

CheckTrialEarlyStoppingStateMetatdata

This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.

CheckTrialEarlyStoppingStateRequest

Request message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].

CheckTrialEarlyStoppingStateResponse

Response message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].

CompleteTrialRequest

Request message for [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial].

CompletionStats

Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.

ContainerRegistryDestination

The Container Registry location for the container image.

ContainerSpec

The spec of a Container.

Context

Instance of a general context.

ContextName

Resource name for the Context resource.

CopyModelOperationMetadata

Details of [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel] operation.

CopyModelRequest

Request message for [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel].

CopyModelResponse

Response message of [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel] operation.

CreateArtifactRequest

Request message for [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact].

CreateBatchPredictionJobRequest

Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob].

CreateContextRequest

Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext].

CreateCustomJobRequest

Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob].

CreateDataLabelingJobRequest

Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob].

CreateDatasetOperationMetadata

Runtime operation information for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].

CreateDatasetRequest

Request message for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].

CreateEndpointOperationMetadata

Runtime operation information for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].

CreateEndpointRequest

Request message for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].

CreateEntityTypeOperationMetadata

Details of operations that perform create EntityType.

CreateEntityTypeRequest

Request message for [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType].

CreateExecutionRequest

Request message for [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution].

CreateFeatureOperationMetadata

Details of operations that perform create Feature.

CreateFeatureRequest

Request message for [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature].

CreateFeaturestoreOperationMetadata

Details of operations that perform create Featurestore.

CreateFeaturestoreRequest

Request message for [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore].

CreateHyperparameterTuningJobRequest

Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob].

CreateIndexEndpointOperationMetadata

Runtime operation information for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].

CreateIndexEndpointRequest

Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].

CreateIndexOperationMetadata

Runtime operation information for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].

CreateIndexRequest

Request message for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].

CreateMetadataSchemaRequest

Request message for [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema].

CreateMetadataStoreOperationMetadata

Details of operations that perform [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].

CreateMetadataStoreRequest

Request message for [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].

CreateModelDeploymentMonitoringJobRequest

Request message for [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].

CreateNasJobRequest

Request message for [JobService.CreateNasJob][google.cloud.aiplatform.v1.JobService.CreateNasJob].

CreatePipelineJobRequest

Request message for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].

CreateSpecialistPoolOperationMetadata

Runtime operation information for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].

CreateSpecialistPoolRequest

Request message for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].

CreateStudyRequest

Request message for [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy].

CreateTensorboardExperimentRequest

Request message for [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment].

CreateTensorboardOperationMetadata

Details of operations that perform create Tensorboard.

CreateTensorboardRequest

Request message for [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard].

CreateTensorboardRunRequest

Request message for [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun].

CreateTensorboardTimeSeriesRequest

Request message for [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries].

CreateTrainingPipelineRequest

Request message for [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline].

CreateTrialRequest

Request message for [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial].

CsvDestination

The storage details for CSV output content.

CsvSource

The storage details for CSV input content.

CustomJob

Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).

CustomJobName

Resource name for the CustomJob resource.

CustomJobSpec

Represents the spec of a CustomJob.

DataItem

A piece of data in a Dataset. Could be an image, a video, a document or plain text.

DataItemName

Resource name for the DataItem resource.

DataItemView

A container for a single DataItem and Annotations on it.

DataLabelingDatasetName

Resource name for the DataLabelingDataset resource.

DataLabelingJob

DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:

DataLabelingJobName

Resource name for the DataLabelingJob resource.

Dataset

A collection of DataItems and Annotations on them.

DatasetName

Resource name for the Dataset resource.

DatasetService

The service that handles the CRUD of Vertex AI Dataset and its child resources.

DatasetService.DatasetServiceBase

Base class for server-side implementations of DatasetService

DatasetService.DatasetServiceClient

Client for DatasetService

DatasetServiceClient

DatasetService client wrapper, for convenient use.

DatasetServiceClientBuilder

Builder class for DatasetServiceClient to provide simple configuration of credentials, endpoint etc.

DatasetServiceClientImpl

DatasetService client wrapper implementation, for convenient use.

DatasetServiceSettings

Settings for DatasetServiceClient instances.

DedicatedResources

A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.

DeleteArtifactRequest

Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact].

DeleteBatchPredictionJobRequest

Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob].

DeleteContextRequest

Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext].

DeleteCustomJobRequest

Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob].

DeleteDataLabelingJobRequest

Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob].

DeleteDatasetRequest

Request message for [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset].

DeleteEndpointRequest

Request message for [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint].

DeleteEntityTypeRequest

Request message for [FeaturestoreService.DeleteEntityTypes][].

DeleteExecutionRequest

Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution].

DeleteFeatureRequest

Request message for [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature].

DeleteFeaturestoreRequest

Request message for [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore].

DeleteFeatureValuesOperationMetadata

Details of operations that delete Feature values.

DeleteFeatureValuesRequest

Request message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].

DeleteFeatureValuesRequest.Types

Container for nested types declared in the DeleteFeatureValuesRequest message type.

DeleteFeatureValuesRequest.Types.SelectEntity

Message to select entity. If an entity id is selected, all the feature values corresponding to the entity id will be deleted, including the entityId.

DeleteFeatureValuesRequest.Types.SelectTimeRangeAndFeature

Message to select time range and feature. Values of the selected feature generated within an inclusive time range will be deleted. Using this option permanently deletes the feature values from the specified feature IDs within the specified time range. This might include data from the online storage. If you want to retain any deleted historical data in the online storage, you must re-ingest it.

DeleteFeatureValuesResponse

Response message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].

DeleteFeatureValuesResponse.Types

Container for nested types declared in the DeleteFeatureValuesResponse message type.

DeleteFeatureValuesResponse.Types.SelectEntity

Response message if the request uses the SelectEntity option.

DeleteFeatureValuesResponse.Types.SelectTimeRangeAndFeature

Response message if the request uses the SelectTimeRangeAndFeat