Package types (1.1.1)

API documentation for aiplatform_v1.types package.

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.

Annotation

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

AnnotationSpec

Identifies a concept with which DataItems may be annotated with.

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.

BatchDedicatedResources

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

BatchMigrateResourcesOperationMetadata

Runtime operation information for MigrationService.BatchMigrateResources.

BatchMigrateResourcesRequest

Request message for MigrationService.BatchMigrateResources.

BatchMigrateResourcesResponse

Response message for MigrationService.BatchMigrateResources.

BatchPredictionJob

A job that uses a 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.

BigQueryDestination

The BigQuery location for the output content. .. attribute:: output_uri

Required. BigQuery URI to a project or table, up to 2000 characters long.

When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist.

Accepted forms:

  • BigQuery path. For example: bq://projectId or bq://projectId.bqDatasetId.bqTableId.

    :type: str

BigQuerySource

The BigQuery location for the input content. .. attribute:: input_uri

Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms:

  • BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.

    :type: str

CancelBatchPredictionJobRequest

Request message for JobService.CancelBatchPredictionJob.

CancelCustomJobRequest

Request message for JobService.CancelCustomJob.

CancelDataLabelingJobRequest

Request message for JobService.CancelDataLabelingJob.

CancelHyperparameterTuningJobRequest

Request message for JobService.CancelHyperparameterTuningJob.

CancelTrainingPipelineRequest

Request message for PipelineService.CancelTrainingPipeline.

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. .. attribute:: output_uri

Required. Container Registry URI of a container image. Only Google Container Registry and Artifact Registry are supported now. Accepted forms:

  • Google Container Registry path. For example: gcr.io/projectId/imageName:tag.

  • Artifact Registry path. For example: us-central1-docker.pkg.dev/projectId/repoName/imageName:tag.

    If a tag is not specified, "latest" will be used as the default tag.

    :type: str

ContainerSpec

The spec of a Container. .. attribute:: image_uri

Required. The URI of a container image in the Container Registry that is to be run on each worker replica.

:type: str

CreateBatchPredictionJobRequest

Request message for JobService.CreateBatchPredictionJob.

CreateCustomJobRequest

Request message for JobService.CreateCusto