Package types (1.48.0)

API documentation for aiplatform_v1.types package.

Classes

AcceleratorType

Represents a hardware accelerator type.

Values: ACCELERATOR_TYPE_UNSPECIFIED (0): Unspecified accelerator type, which means no accelerator. NVIDIA_TESLA_K80 (1): Nvidia Tesla K80 GPU. NVIDIA_TESLA_P100 (2): Nvidia Tesla P100 GPU. NVIDIA_TESLA_V100 (3): Nvidia Tesla V100 GPU. NVIDIA_TESLA_P4 (4): Nvidia Tesla P4 GPU. NVIDIA_TESLA_T4 (5): Nvidia Tesla T4 GPU. NVIDIA_TESLA_A100 (8): Nvidia Tesla A100 GPU. NVIDIA_A100_80GB (9): Nvidia A100 80GB GPU. NVIDIA_L4 (11): Nvidia L4 GPU. NVIDIA_H100_80GB (13): Nvidia H100 80Gb GPU. TPU_V2 (6): TPU v2. TPU_V3 (7): TPU v3. TPU_V4_POD (10): TPU v4.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AddContextArtifactsAndExecutionsRequest

Request message for MetadataService.AddContextArtifactsAndExecutions.

AddContextArtifactsAndExecutionsResponse

Response message for MetadataService.AddContextArtifactsAndExecutions.

AddContextChildrenRequest

Request message for MetadataService.AddContextChildren.

AddContextChildrenResponse

Response message for MetadataService.AddContextChildren.

AddExecutionEventsRequest

Request message for MetadataService.AddExecutionEvents.

AddExecutionEventsResponse

Response message for MetadataService.AddExecutionEvents.

AddTrialMeasurementRequest

Request message for VizierService.AddTrialMeasurement.

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.

Artifact

Instance of a general artifact.

AssignNotebookRuntimeOperationMetadata

Metadata information for NotebookService.AssignNotebookRuntime.

AssignNotebookRuntimeRequest

Request message for NotebookService.AssignNotebookRuntime.

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.

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.

BatchCancelPipelineJobsOperationMetadata

Runtime operation information for PipelineService.BatchCancelPipelineJobs.

BatchCancelPipelineJobsRequest

Request message for PipelineService.BatchCancelPipelineJobs.

BatchCancelPipelineJobsResponse

Response message for PipelineService.BatchCancelPipelineJobs.

BatchCreateFeaturesOperationMetadata

Details of operations that perform batch create Features.

BatchCreateFeaturesRequest

Request message for FeaturestoreService.BatchCreateFeatures.

BatchCreateFeaturesResponse

Response message for FeaturestoreService.BatchCreateFeatures.

BatchCreateTensorboardRunsRequest

Request message for TensorboardService.BatchCreateTensorboardRuns.

BatchCreateTensorboardRunsResponse

Response message for TensorboardService.BatchCreateTensorboardRuns.

BatchCreateTensorboardTimeSeriesRequest

Request message for TensorboardService.BatchCreateTensorboardTimeSeries.

BatchCreateTensorboardTimeSeriesResponse

Response message for TensorboardService.BatchCreateTensorboardTimeSeries.

BatchDedicatedResources

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

BatchDeletePipelineJobsRequest

Request message for PipelineService.BatchDeletePipelineJobs.

BatchDeletePipelineJobsResponse

Response message for PipelineService.BatchDeletePipelineJobs.

BatchImportEvaluatedAnnotationsRequest

Request message for ModelService.BatchImportEvaluatedAnnotations

BatchImportEvaluatedAnnotationsResponse

Response message for ModelService.BatchImportEvaluatedAnnotations

BatchImportModelEvaluationSlicesRequest

Request message for ModelService.BatchImportModelEvaluationSlices

BatchImportModelEvaluationSlicesResponse

Response message for ModelService.BatchImportModelEvaluationSlices

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.

BatchReadFeatureValuesOperationMetadata

Details of operations that batch reads Feature values.

BatchReadFeatureValuesRequest

Request message for FeaturestoreService.BatchReadFeatureValues.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchReadFeatureValuesResponse

Response message for FeaturestoreService.BatchReadFeatureValues.

BatchReadTensorboardTimeSeriesDataRequest

Request message for TensorboardService.BatchReadTensorboardTimeSeriesData.

BatchReadTensorboardTimeSeriesDataResponse

Response message for TensorboardService.BatchReadTensorboardTimeSeriesData.

BigQueryDestination

The BigQuery location for the output content.

BigQuerySource

The BigQuery location for the input content.

Blob

Content blob.

It's preferred to send as text directly rather than raw bytes.

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.

CancelCustomJobRequest

Request message for JobService.CancelCustomJob.

CancelDataLabelingJobRequest

Request message for JobService.CancelDataLabelingJob.

CancelHyperparameterTuningJobRequest

Request message for JobService.CancelHyperparameterTuningJob.

CancelNasJobRequest

Request message for JobService.CancelNasJob.

CancelPipelineJobRequest

Request message for PipelineService.CancelPipelineJob.

CancelTrainingPipelineRequest

Request message for PipelineService.CancelTrainingPipeline.

CancelTuningJobRequest

Request message for GenAiTuningService.CancelTuningJob.

Candidate

A response candidate generated from the model.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

CheckTrialEarlyStoppingStateResponse

Response message for VizierService.CheckTrialEarlyStoppingState.

Citation

Source attributions for content.

CitationMetadata

A collection of source attributions for a piece of content.

CompleteTrialRequest

Request message for VizierService.CompleteTrial.

CompletionStats

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

ComputeTokensRequest

Request message for ComputeTokens RPC call.

ComputeTokensResponse

Response message for ComputeTokens RPC call.

ContainerRegistryDestination

The Container Registry location for the container image.

ContainerSpec

The spec of a Container.

Content

The base structured datatype containing multi-part content of a message.

A Content includes a role field designating the producer of the Content and a parts field containing multi-part data that contains the content of the message turn.

Context

Instance of a general context.

CopyModelOperationMetadata

Details of ModelService.CopyModel operation.

CopyModelRequest

Request message for ModelService.CopyModel.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CopyModelResponse

Response message of ModelService.CopyModel operation.

CountTokensRequest

Request message for [PredictionService.CountTokens][].

CountTokensResponse

Response message for [PredictionService.CountTokens][].

CreateArtifactRequest

Request message for MetadataService.CreateArtifact.

CreateBatchPredictionJobRequest

Request message for JobService.CreateBatchPredictionJob.

CreateContextRequest

Request message for MetadataService.CreateContext.

CreateCustomJobRequest

Request message for JobService.CreateCustomJob.

CreateDataLabelingJobRequest

Request message for JobService.CreateDataLabelingJob.

CreateDatasetOperationMetadata

Runtime operation information for DatasetService.CreateDataset.

CreateDatasetRequest

Request message for DatasetService.CreateDataset.

CreateDatasetVersionOperationMetadata

Runtime operation information for DatasetService.CreateDatasetVersion.

CreateDatasetVersionRequest

Request message for DatasetService.CreateDatasetVersion.

CreateDeploymentResourcePoolOperationMetadata

Runtime operation information for CreateDeploymentResourcePool method.

CreateDeploymentResourcePoolRequest

Request message for CreateDeploymentResourcePool method.

CreateEndpointOperationMetadata

Runtime operation information for EndpointService.CreateEndpoint.

CreateEndpointRequest

Request message for EndpointService.CreateEndpoint.

CreateEntityTypeOperationMetadata

Details of operations that perform create EntityType.

CreateEntityTypeRequest

Request message for FeaturestoreService.CreateEntityType.

CreateExecutionRequest

Request message for MetadataService.CreateExecution.

CreateFeatureGroupOperationMetadata

Details of operations that perform create FeatureGroup.

CreateFeatureGroupRequest

Request message for FeatureRegistryService.CreateFeatureGroup.

CreateFeatureOnlineStoreOperationMetadata

Details of operations that perform create FeatureOnlineStore.

CreateFeatureOnlineStoreRequest

Request message for FeatureOnlineStoreAdminService.CreateFeatureOnlineStore.

CreateFeatureOperationMetadata

Details of operations that perform create Feature.

CreateFeatureRequest

Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.

CreateFeatureViewOperationMetadata

Details of operations that perform create FeatureView.

CreateFeatureViewRequest

Request message for FeatureOnlineStoreAdminService.CreateFeatureView.

CreateFeaturestoreOperationMetadata

Details of operations that perform create Featurestore.

CreateFeaturestoreRequest

Request message for FeaturestoreService.CreateFeaturestore.

CreateHyperparameterTuningJobRequest

Request message for JobService.CreateHyperparameterTuningJob.

CreateIndexEndpointOperationMetadata

Runtime operation information for IndexEndpointService.CreateIndexEndpoint.

CreateIndexEndpointRequest

Request message for IndexEndpointService.CreateIndexEndpoint.

CreateIndexOperationMetadata

Runtime operation information for IndexService.CreateIndex.

CreateIndexRequest

Request message for IndexService.CreateIndex.

CreateMetadataSchemaRequest

Request message for MetadataService.CreateMetadataSchema.

CreateMetadataStoreOperationMetadata

Details of operations that perform MetadataService.CreateMetadataStore.

CreateMetadataStoreRequest

Request message for MetadataService.CreateMetadataStore.

CreateModelDeploymentMonitoringJobRequest

Request message for JobService.CreateModelDeploymentMonitoringJob.

CreateNasJobRequest

Request message for JobService.CreateNasJob.

CreateNotebookRuntimeTemplateOperationMetadata

Metadata information for NotebookService.CreateNotebookRuntimeTemplate.

CreateNotebookRuntimeTemplateRequest

Request message for NotebookService.CreateNotebookRuntimeTemplate.

CreatePersistentResourceOperationMetadata

Details of operations that perform create PersistentResource.

CreatePersistentResourceRequest

Request message for PersistentResourceService.CreatePersistentResource.

CreatePipelineJobRequest

Request message for PipelineService.CreatePipelineJob.

CreateRegistryFeatureOperationMetadata

Details of operations that perform create FeatureGroup.

CreateScheduleRequest

Request message for ScheduleService.CreateSchedule.

CreateSpecialistPoolOperationMetadata

Runtime operation information for SpecialistPoolService.CreateSpecialistPool.

CreateSpecialistPoolRequest

Request message for SpecialistPoolService.CreateSpecialistPool.

CreateStudyRequest

Request message for VizierService.CreateStudy.

CreateTensorboardExperimentRequest

Request message for TensorboardService.CreateTensorboardExperiment.

CreateTensorboardOperationMetadata

Details of operations that perform create Tensorboard.

CreateTensorboardRequest

Request message for TensorboardService.CreateTensorboard.

CreateTensorboardRunRequest

Request message for TensorboardService.CreateTensorboardRun.

CreateTensorboardTimeSeriesRequest

Request message for TensorboardService.CreateTensorboardTimeSeries.

CreateTrainingPipelineRequest

Request message for PipelineService.CreateTrainingPipeline.

CreateTrialRequest

Request message for VizierService.CreateTrial.

CreateTuningJobRequest

Request message for GenAiTuningService.CreateTuningJob.

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).

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.

DataItemView

A container for a single DataItem and Annotations on it.

DataLabelingJob

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

Dataset

A collection of DataItems and Annotations on them.

DatasetVersion

Describes the dataset version.

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.

DeleteBatchPredictionJobRequest

Request message for JobService.DeleteBatchPredictionJob.

DeleteContextRequest

Request message for MetadataService.DeleteContext.

DeleteCustomJobRequest

Request message for JobService.DeleteCustomJob.

DeleteDataLabelingJobRequest

Request message for JobService.DeleteDataLabelingJob.

DeleteDatasetRequest

Request message for DatasetService.DeleteDataset.

DeleteDatasetVersionRequest

Request message for DatasetService.DeleteDatasetVersion.

DeleteDeploymentResourcePoolRequest

Request message for DeleteDeploymentResourcePool method.

DeleteEndpointRequest

Request message for EndpointService.DeleteEndpoint.

DeleteEntityTypeRequest

Request message for [FeaturestoreService.DeleteEntityTypes][].

DeleteExecutionRequest

Request message for MetadataService.DeleteExecution.

DeleteFeatureGroupRequest

Request message for FeatureRegistryService.DeleteFeatureGroup.

DeleteFeatureOnlineStoreRequest

Request message for FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore.

DeleteFeatureRequest

Request message for FeaturestoreService.DeleteFeature. Request message for FeatureRegistryService.DeleteFeature.

DeleteFeatureValuesOperationMetadata

Details of operations that delete Feature values.

DeleteFeatureValuesRequest

Request message for FeaturestoreService.DeleteFeatureValues.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteFeatureValuesResponse

Response message for FeaturestoreService.DeleteFeatureValues.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteFeatureViewRequest

Request message for [FeatureOnlineStoreAdminService.DeleteFeatureViews][].

DeleteFeaturestoreRequest

Request message for FeaturestoreService.DeleteFeaturestore.

DeleteHyperparameterTuningJobRequest

Request message for JobService.DeleteHyperparameterTuningJob.

DeleteIndexEndpointRequest

Request message for IndexEndpointService.DeleteIndexEndpoint.

DeleteIndexRequest

Request message for IndexService.DeleteIndex.

DeleteMetadataStoreOperationMetadata

Details of operations that perform MetadataService.DeleteMetadataStore.

DeleteMetadataStoreRequest

Request message for MetadataService.DeleteMetadataStore.

DeleteModelDeploymentMonitoringJobRequest

Request message for JobService.DeleteModelDeploymentMonitoringJob.

DeleteModelRequest

Request message for ModelService.DeleteModel.

DeleteModelVersionRequest

Request message for ModelService.DeleteModelVersion.

DeleteNasJobRequest

Request message for JobService.DeleteNasJob.

DeleteNotebookRuntimeRequest

Request message for NotebookService.DeleteNotebookRuntime.

DeleteNotebookRuntimeTemplateRequest

Request message for NotebookService.DeleteNotebookRuntimeTemplate.

DeleteOperationMetadata

Details of operations that perform deletes of any entities.

DeletePersistentResourceRequest

Request message for PersistentResourceService.DeletePersistentResource.

DeletePipelineJobRequest

Request message for PipelineService.DeletePipelineJob.

DeleteSavedQueryRequest

Request message for DatasetService.DeleteSavedQuery.

DeleteScheduleRequest

Request message for ScheduleService.DeleteSchedule.

DeleteSpecialistPoolRequest

Request message for SpecialistPoolService.DeleteSpecialistPool.

DeleteStudyRequest

Request message for VizierService.DeleteStudy.

DeleteTensorboardExperimentRequest

Request message for TensorboardService.DeleteTensorboardExperiment.

DeleteTensorboardRequest

Request message for TensorboardService.DeleteTensorboard.

DeleteTensorboardRunRequest

Request message for TensorboardService.DeleteTensorboardRun.

DeleteTensorboardTimeSeriesRequest

Request message for TensorboardService.DeleteTensorboardTimeSeries.

DeleteTrainingPipelineRequest

Request message for PipelineService.DeleteTrainingPipeline.

DeleteTrialRequest

Request message for VizierService.DeleteTrial.

DeployIndexOperationMetadata

Runtime operation information for IndexEndpointService.DeployIndex.

DeployIndexRequest

Request message for IndexEndpointService.DeployIndex.

DeployIndexResponse

Response message for IndexEndpointService.DeployIndex.

DeployModelOperationMetadata

Runtime operation information for EndpointService.DeployModel.

DeployModelRequest

Request message for EndpointService.DeployModel.

DeployModelResponse

Response message for EndpointService.DeployModel.

DeployedIndex

A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.

DeployedIndexAuthConfig

Used to set up the auth on the DeployedIndex's private endpoint.

DeployedIndexRef

Points to a DeployedIndex.

DeployedModel

A deployment of a Model. Endpoints contain one or more DeployedModels.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeployedModelRef

Points to a DeployedModel.

DeploymentResourcePool

A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.

DestinationFeatureSetting

DirectPredictRequest

Request message for PredictionService.DirectPredict.

DirectPredictResponse

Response message for PredictionService.DirectPredict.

DirectRawPredictRequest

Request message for PredictionService.DirectRawPredict.

DirectRawPredictResponse

Response message for PredictionService.DirectRawPredict.

DiskSpec

Represents the spec of disk options.

DoubleArray

A list of double values.

EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top-level resource.

Endpoint

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

EntityIdSelector

Selector for entityId. Getting ids from the given source.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EntityType

An entity type is a type of object in a system that needs to be modeled and have stored information about. For example, driver is an entity type, and driver0 is an instance of an entity type driver.

EnvVar

Represents an environment variable present in a Container or Python Module.

ErrorAnalysisAnnotation

Model error analysis for each annotation.

EvaluatedAnnotation

True positive, false positive, or false negative.

EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of annotationSpec dimension.

EvaluatedAnnotationExplanation

Explanation result of the prediction produced by the Model.

Event

An edge describing the relationship between an Artifact and an Execution in a lineage graph.

Examples

Example-based explainability that returns the nearest neighbors from the provided dataset.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExamplesOverride

Overrides for example-based explanations.

ExamplesRestrictionsNamespace

Restrictions namespace for example-based explanations overrides.

Execution

Instance of a general execution.

ExplainRequest

Request message for PredictionService.Explain.

ExplainResponse

Response message for PredictionService.Explain.

Explanation

Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.

ExplanationMetadata

Metadata describing the Model's input and output for explanation.

ExplanationMetadataOverride

The ExplanationMetadata entries that can be overridden at [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.

ExplanationParameters

Parameters to configure explaining for Model's predictions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExplanationSpec

Specification of Model explanation.

ExplanationSpecOverride

The ExplanationSpec entries that can be overridden at [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.

ExportDataConfig

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportDataOperationMetadata

Runtime operation information for DatasetService.ExportData.

ExportDataRequest

Request message for DatasetService.ExportData.

ExportDataResponse

Response message for DatasetService.ExportData.

ExportFeatureValuesOperationMetadata

Details of operations that exports Features values.

ExportFeatureValuesRequest

Request message for FeaturestoreService.ExportFeatureValues.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportFeatureValuesResponse

Response message for FeaturestoreService.ExportFeatureValues.

ExportFilterSplit

Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign).

Supported only for unstructured Datasets.

ExportFractionSplit

Assigns the input data to training, validation, and test sets as per the given fractions. Any of training_fraction, validation_fraction and test_fraction may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test.

ExportModelOperationMetadata

Details of ModelService.ExportModel operation.

ExportModelRequest

Request message for ModelService.ExportModel.

ExportModelResponse

Response message of ModelService.ExportModel operation.

ExportTensorboardTimeSeriesDataRequest

Request message for TensorboardService.ExportTensorboardTimeSeriesData.

ExportTensorboardTimeSeriesDataResponse

Response message for TensorboardService.ExportTensorboardTimeSeriesData.

Feature

Feature Metadata information. For example, color is a feature that describes an apple.

FeatureGroup

Vertex AI Feature Group.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeatureNoiseSigma

Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients.

FeatureOnlineStore

Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The Feature Online Store is a top-level container.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeatureSelector

Selector for Features of an EntityType.

FeatureStatsAnomaly

Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display.

FeatureValue

Value for a feature.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeatureValueDestination

A destination location for Feature values and format.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeatureValueList

Container for list of values.

FeatureView

FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeatureViewDataFormat

Format of the data in the Feature View.

Values: FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED (0): Not set. Will be treated as the KeyValue format. KEY_VALUE (1): Return response data in key-value format. PROTO_STRUCT (2): Return response data in proto Struct format.

FeatureViewDataKey

Lookup key for a feature view.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeatureViewSync

FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.

Featurestore

Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.

FeaturestoreMonitoringConfig

Configuration of how features in Featurestore are monitored.

FetchFeatureValuesRequest

Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.

FetchFeatureValuesResponse

Response message for FeatureOnlineStoreService.FetchFeatureValues

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FileData

URI based data.

FilterSplit

Supported only for unstructured Datasets.

FindNeighborsRequest

The request message for MatchService.FindNeighbors.

FindNeighborsResponse

The response message for MatchService.FindNeighbors.

FractionSplit

FunctionCall

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

FunctionDeclaration

Structured representation of a function declaration as defined by the OpenAPI 3.0 specification <https://spec.openapis.org/oas/v3.0.3>__. Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.

FunctionResponse

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

GcsDestination

The Google Cloud Storage location where the output is to be written to.

GcsSource

The Google Cloud Storage location for the input content.

GenerateContentRequest

Request message for [PredictionService.GenerateContent].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GenerateContentResponse

Response message for [PredictionService.GenerateContent].

GenerationConfig

Generation config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GenericOperationMetadata

Generic Metadata shared by all operations.

GenieSource

Contains information about the source of the models generated from Generative AI Studio.

GetAnnotationSpecRequest

Request message for DatasetService.GetAnnotationSpec.

GetArtifactRequest

Request message for MetadataService.GetArtifact.

GetBatchPredictionJobRequest

Request message for JobService.GetBatchPredictionJob.

GetContextRequest

Request message for MetadataService.GetContext.

GetCustomJobRequest

Request message for JobService.GetCustomJob.

GetDataLabelingJobRequest

Request message for JobService.GetDataLabelingJob.

GetDatasetRequest

Request message for DatasetService.GetDataset.

GetDatasetVersionRequest

Request message for DatasetService.GetDatasetVersion.

GetDeploymentResourcePoolRequest

Request message for GetDeploymentResourcePool method.

GetEndpointRequest

Request message for EndpointService.GetEndpoint

GetEntityTypeRequest

Request message for FeaturestoreService.GetEntityType.

GetExecutionRequest

Request message for MetadataService.GetExecution.

GetFeatureGroupRequest

Request message for FeatureRegistryService.GetFeatureGroup.

GetFeatureOnlineStoreRequest

Request message for FeatureOnlineStoreAdminService.GetFeatureOnlineStore.

GetFeatureRequest

Request message for FeaturestoreService.GetFeature. Request message for FeatureRegistryService.GetFeature.

GetFeatureViewRequest

Request message for FeatureOnlineStoreAdminService.GetFeatureView.

GetFeatureViewSyncRequest

Request message for FeatureOnlineStoreAdminService.GetFeatureViewSync.

GetFeaturestoreRequest

Request message for FeaturestoreService.GetFeaturestore.

GetHyperparameterTuningJobRequest

Request message for JobService.GetHyperparameterTuningJob.

GetIndexEndpointRequest

Request message for IndexEndpointService.GetIndexEndpoint

GetIndexRequest

Request message for IndexService.GetIndex

GetMetadataSchemaRequest

Request message for MetadataService.GetMetadataSchema.

GetMetadataStoreRequest

Request message for MetadataService.GetMetadataStore.

GetModelDeploymentMonitoringJobRequest

Request message for JobService.GetModelDeploymentMonitoringJob.

GetModelEvaluationRequest

Request message for ModelService.GetModelEvaluation.

GetModelEvaluationSliceRequest

Request message for ModelService.GetModelEvaluationSlice.

GetModelRequest

Request message for ModelService.GetModel.

GetNasJobRequest

Request message for JobService.GetNasJob.

GetNasTrialDetailRequest

Request message for JobService.GetNasTrialDetail.

GetNotebookRuntimeRequest

Request message for NotebookService.GetNotebookRuntime

GetNotebookRuntimeTemplateRequest

Request message for NotebookService.GetNotebookRuntimeTemplate

GetPersistentResourceRequest

Request message for PersistentResourceService.GetPersistentResource.

GetPipelineJobRequest

Request message for PipelineService.GetPipelineJob.

GetPublisherModelRequest

Request message for ModelGardenService.GetPublisherModel

GetScheduleRequest

Request message for ScheduleService.GetSchedule.

GetSpecialistPoolRequest

Request message for SpecialistPoolService.GetSpecialistPool.

GetStudyRequest

Request message for VizierService.GetStudy.

GetTensorboardExperimentRequest

Request message for TensorboardService.GetTensorboardExperiment.

GetTensorboardRequest

Request message for TensorboardService.GetTensorboard.

GetTensorboardRunRequest

Request message for TensorboardService.GetTensorboardRun.

GetTensorboardTimeSeriesRequest

Request message for TensorboardService.GetTensorboardTimeSeries.

GetTrainingPipelineRequest

Request message for PipelineService.GetTrainingPipeline.

GetTrialRequest

Request message for VizierService.GetTrial.

GetTuningJobRequest

Request message for GenAiTuningService.GetTuningJob.

GoogleSearchRetrieval

Tool to retrieve public web data for grounding, powered by Google.

GroundingAttribution

Grounding attribution.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GroundingMetadata

Metadata returned to client when grounding is enabled.

HarmCategory

Harm categories that will block the content.

Values: HARM_CATEGORY_UNSPECIFIED (0): The harm category is unspecified. HARM_CATEGORY_HATE_SPEECH (1): The harm category is hate speech. HARM_CATEGORY_DANGEROUS_CONTENT (2): The harm category is dangerous content. HARM_CATEGORY_HARASSMENT (3): The harm category is harassment. HARM_CATEGORY_SEXUALLY_EXPLICIT (4): The harm category is sexually explicit content.

HyperparameterTuningJob

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

IdMatcher

Matcher for Features of an EntityType by Feature ID.

ImportDataConfig

Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportDataOperationMetadata

Runtime operation information for DatasetService.ImportData.

ImportDataRequest

Request message for DatasetService.ImportData.

ImportDataResponse

Response message for DatasetService.ImportData.

ImportFeatureValuesOperationMetadata

Details of operations that perform import Feature values.

ImportFeatureValuesRequest

Request message for FeaturestoreService.ImportFeatureValues.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportFeatureValuesResponse

Response message for FeaturestoreService.ImportFeatureValues.

ImportModelEvaluationRequest

Request message for ModelService.ImportModelEvaluation

Index

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

IndexDatapoint

A datapoint of Index.

IndexEndpoint

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

IndexPrivateEndpoints

IndexPrivateEndpoints proto is used to provide paths for users to send requests via private endpoints (e.g. private service access, private service connect). To send request via private service access, use match_grpc_address. To send request via private service connect, use service_attachment.

IndexStats

Stats of the Index.

InputDataConfig

Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Int64Array

A list of int64 values.

IntegratedGradientsAttribution

An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365

JobState

Describes the state of a job.

Values: JOB_STATE_UNSPECIFIED (0): The job state is unspecified. JOB_STATE_QUEUED (1): The job has been just created or resumed and processing has not yet begun. JOB_STATE_PENDING (2): The service is preparing to run the job. JOB_STATE_RUNNING (3): The job is in progress. JOB_STATE_SUCCEEDED (4): The job completed successfully. JOB_STATE_FAILED (5): The job failed. JOB_STATE_CANCELLING (6): The job is being cancelled. From this state the job may only go to either JOB_STATE_SUCCEEDED, JOB_STATE_FAILED or JOB_STATE_CANCELLED. JOB_STATE_CANCELLED (7): The job has been cancelled. JOB_STATE_PAUSED (8): The job has been stopped, and can be resumed. JOB_STATE_EXPIRED (9): The job has expired. JOB_STATE_UPDATING (10): The job is being updated. Only jobs in the RUNNING state can be updated. After updating, the job goes back to the RUNNING state. JOB_STATE_PARTIALLY_SUCCEEDED (11): The job is partially succeeded, some results may be missing due to errors.

LargeModelReference

Contains information about the Large Model.

LineageSubgraph

A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes.

ListAnnotationsRequest

Request message for DatasetService.ListAnnotations.

ListAnnotationsResponse

Response message for DatasetService.ListAnnotations.

ListArtifactsRequest

Request message for MetadataService.ListArtifacts.

ListArtifactsResponse

Response message for MetadataService.ListArtifacts.

ListBatchPredictionJobsRequest

Request message for JobService.ListBatchPredictionJobs.

ListBatchPredictionJobsResponse

Response message for JobService.ListBatchPredictionJobs

ListContextsRequest

Request message for MetadataService.ListContexts

ListContextsResponse

Response message for MetadataService.ListContexts.

ListCustomJobsRequest

Request message for JobService.ListCustomJobs.

ListCustomJobsResponse

Response message for JobService.ListCustomJobs

ListDataItemsRequest

Request message for DatasetService.ListDataItems.

ListDataItemsResponse

Response message for DatasetService.ListDataItems.

ListDataLabelingJobsRequest

Request message for JobService.ListDataLabelingJobs.

ListDataLabelingJobsResponse

Response message for JobService.ListDataLabelingJobs.

ListDatasetVersionsRequest

Request message for DatasetService.ListDatasetVersions.

ListDatasetVersionsResponse

Response message for DatasetService.ListDatasetVersions.

ListDatasetsRequest

Request message for DatasetService.ListDatasets.

ListDatasetsResponse

Response message for DatasetService.ListDatasets.

ListDeploymentResourcePoolsRequest

Request message for ListDeploymentResourcePools method.

ListDeploymentResourcePoolsResponse

Response message for ListDeploymentResourcePools method.

ListEndpointsRequest

Request message for EndpointService.ListEndpoints.

ListEndpointsResponse

Response message for EndpointService.ListEndpoints.

ListEntityTypesRequest

Request message for FeaturestoreService.ListEntityTypes.

ListEntityTypesResponse

Response message for FeaturestoreService.ListEntityTypes.

ListExecutionsRequest

Request message for MetadataService.ListExecutions.

ListExecutionsResponse

Response message for MetadataService.ListExecutions.

ListFeatureGroupsRequest

Request message for FeatureRegistryService.ListFeatureGroups.

ListFeatureGroupsResponse

Response message for FeatureRegistryService.ListFeatureGroups.

ListFeatureOnlineStoresRequest

Request message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.

ListFeatureOnlineStoresResponse

Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.

ListFeatureViewSyncsRequest

Request message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.

ListFeatureViewSyncsResponse

Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.

ListFeatureViewsRequest

Request message for FeatureOnlineStoreAdminService.ListFeatureViews.

ListFeatureViewsResponse

Response message for FeatureOnlineStoreAdminService.ListFeatureViews.

ListFeaturesRequest

Request message for FeaturestoreService.ListFeatures. Request message for FeatureRegistryService.ListFeatures.

ListFeaturesResponse

Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.

ListFeaturestoresRequest

Request message for FeaturestoreService.ListFeaturestores.

ListFeaturestoresResponse

Response message for FeaturestoreService.ListFeaturestores.

ListHyperparameterTuningJobsRequest

Request message for JobService.ListHyperparameterTuningJobs.

ListHyperparameterTuningJobsResponse

Response message for JobService.ListHyperparameterTuningJobs

ListIndexEndpointsRequest

Request message for IndexEndpointService.ListIndexEndpoints.

ListIndexEndpointsResponse

Response message for IndexEndpointService.ListIndexEndpoints.

ListIndexesRequest

Request message for IndexService.ListIndexes.

ListIndexesResponse

Response message for IndexService.ListIndexes.

ListMetadataSchemasRequest

Request message for MetadataService.ListMetadataSchemas.

ListMetadataSchemasResponse

Response message for MetadataService.ListMetadataSchemas.

ListMetadataStoresRequest

Request message for MetadataService.ListMetadataStores.

ListMetadataStoresResponse

Response message for MetadataService.ListMetadataStores.

ListModelDeploymentMonitoringJobsRequest

Request message for JobService.ListModelDeploymentMonitoringJobs.

ListModelDeploymentMonitoringJobsResponse

Response message for JobService.ListModelDeploymentMonitoringJobs.

ListModelEvaluationSlicesRequest

Request message for ModelService.ListModelEvaluationSlices.

ListModelEvaluationSlicesResponse

Response message for ModelService.ListModelEvaluationSlices.

ListModelEvaluationsRequest

Request message for ModelService.ListModelEvaluations.

ListModelEvaluationsResponse

Response message for ModelService.ListModelEvaluations.

ListModelVersionsRequest

Request message for ModelService.ListModelVersions.

ListModelVersionsResponse

Response message for ModelService.ListModelVersions

ListModelsRequest

Request message for ModelService.ListModels.

ListModelsResponse

Response message for ModelService.ListModels

ListNasJobsRequest

Request message for JobService.ListNasJobs.

ListNasJobsResponse

Response message for JobService.ListNasJobs

ListNasTrialDetailsRequest

Request message for JobService.ListNasTrialDetails.

ListNasTrialDetailsResponse

Response message for JobService.ListNasTrialDetails

ListNotebookRuntimeTemplatesRequest

Request message for NotebookService.ListNotebookRuntimeTemplates.

ListNotebookRuntimeTemplatesResponse

Response message for NotebookService.ListNotebookRuntimeTemplates.

ListNotebookRuntimesRequest

Request message for NotebookService.ListNotebookRuntimes.

ListNotebookRuntimesResponse

Response message for NotebookService.ListNotebookRuntimes.

ListOptimalTrialsRequest

Request message for VizierService.ListOptimalTrials.

ListOptimalTrialsResponse

Response message for VizierService.ListOptimalTrials.

ListPersistentResourcesRequest

Request message for [PersistentResourceService.ListPersistentResource][].

ListPersistentResourcesResponse

Response message for PersistentResourceService.ListPersistentResources

ListPipelineJobsRequest

Request message for PipelineService.ListPipelineJobs.

ListPipelineJobsResponse

Response message for PipelineService.ListPipelineJobs

ListSavedQueriesRequest

Request message for DatasetService.ListSavedQueries.

ListSavedQueriesResponse

Response message for DatasetService.ListSavedQueries.

ListSchedulesRequest

Request message for ScheduleService.ListSchedules.

ListSchedulesResponse

Response message for ScheduleService.ListSchedules

ListSpecialistPoolsRequest

Request message for SpecialistPoolService.ListSpecialistPools.

ListSpecialistPoolsResponse

Response message for SpecialistPoolService.ListSpecialistPools.

ListStudiesRequest

Request message for VizierService.ListStudies.

ListStudiesResponse

Response message for VizierService.ListStudies.

ListTensorboardExperimentsRequest

Request message for TensorboardService.ListTensorboardExperiments.

ListTensorboardExperimentsResponse

Response message for TensorboardService.ListTensorboardExperiments.

ListTensorboardRunsRequest

Request message for TensorboardService.ListTensorboardRuns.

ListTensorboardRunsResponse

Response message for TensorboardService.ListTensorboardRuns.

ListTensorboardTimeSeriesRequest

Request message for TensorboardService.ListTensorboardTimeSeries.

ListTensorboardTimeSeriesResponse

Response message for TensorboardService.ListTensorboardTimeSeries.

ListTensorboardsRequest

Request message for TensorboardService.ListTensorboards.

ListTensorboardsResponse

Response message for TensorboardService.ListTensorboards.

ListTrainingPipelinesRequest

Request message for PipelineService.ListTrainingPipelines.

ListTrainingPipelinesResponse

Response message for PipelineService.ListTrainingPipelines

ListTrialsRequest

Request message for VizierService.ListTrials.

ListTrialsResponse

Response message for VizierService.ListTrials.

ListTuningJobsRequest

Request message for GenAiTuningService.ListTuningJobs.

ListTuningJobsResponse

Response message for GenAiTuningService.ListTuningJobs

LookupStudyRequest

Request message for VizierService.LookupStudy.

MachineSpec

Specification of a single machine.

ManualBatchTuningParameters

Manual batch tuning parameters.

Measurement

A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.

MergeVersionAliasesRequest

Request message for ModelService.MergeVersionAliases.

MetadataSchema

Instance of a general MetadataSchema.

MetadataStore

Instance of a metadata store. Contains a set of metadata that can be queried.

MigratableResource

Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MigrateResourceRequest

Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MigrateResourceResponse

Describes a successfully migrated resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Model

A trained machine learning Model.

ModelContainerSpec

Specification of a container for serving predictions. Some fields in this message correspond to fields in the Kubernetes Container v1 core specification <https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core>__.

ModelDeploymentMonitoringBigQueryTable

ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.

ModelDeploymentMonitoringJob

Represents a job that runs periodically to monitor the deployed models in an endpoint. It will analyze the logged training & prediction data to detect any abnormal behaviors.

ModelDeploymentMonitoringObjectiveConfig

ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig.

ModelDeploymentMonitoringObjectiveType

The Model Monitoring Objective types.

Values: MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED (0): Default value, should not be set. RAW_FEATURE_SKEW (1): Raw feature values' stats to detect skew between Training-Prediction datasets. RAW_FEATURE_DRIFT (2): Raw feature values' stats to detect drift between Serving-Prediction datasets. FEATURE_ATTRIBUTION_SKEW (3): Feature attribution scores to detect skew between Training-Prediction datasets. FEATURE_ATTRIBUTION_DRIFT (4): Feature attribution scores to detect skew between Prediction datasets collected within different time windows.

ModelDeploymentMonitoringScheduleConfig

The config for scheduling monitoring job.

ModelEvaluation

A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.

ModelEvaluationSlice

A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.

ModelExplanation

Aggregated explanation metrics for a Model over a set of instances.

ModelGardenSource

Contains information about the source of the models generated from Model Garden.

ModelMonitoringAlertConfig

The alert config for model monitoring.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ModelMonitoringObjectiveConfig

The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.

ModelMonitoringStatsAnomalies

Statistics and anomalies generated by Model Monitoring.

ModelSourceInfo

Detail description of the source information of the model.

MutateDeployedIndexOperationMetadata

Runtime operation information for IndexEndpointService.MutateDeployedIndex.

MutateDeployedIndexRequest

Request message for IndexEndpointService.MutateDeployedIndex.

MutateDeployedIndexResponse

Response message for IndexEndpointService.MutateDeployedIndex.

MutateDeployedModelOperationMetadata

Runtime operation information for EndpointService.MutateDeployedModel.

MutateDeployedModelRequest

Request message for EndpointService.MutateDeployedModel.

MutateDeployedModelResponse

Response message for EndpointService.MutateDeployedModel.

NasJob

Represents a Neural Architecture Search (NAS) job.

NasJobOutput

Represents a uCAIP NasJob output.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NasJobSpec

Represents the spec of a NasJob.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NasTrial

Represents a uCAIP NasJob trial.

NasTrialDetail

Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.

NearestNeighborQuery

A query to find a number of similar entities.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NearestNeighborSearchOperationMetadata

Runtime operation metadata with regard to Matching Engine Index.

NearestNeighbors

Nearest neighbors for one query.

Neighbor

Neighbors for example-based explanations.

NetworkSpec

Network spec.

NfsMount

Represents a mount configuration for Network File System (NFS) to mount.

NotebookEucConfig

The euc configuration of NotebookRuntimeTemplate.

NotebookIdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.

NotebookRuntime

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

NotebookRuntimeTemplate

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.

NotebookRuntimeTemplateRef

Points to a NotebookRuntimeTemplateRef.

NotebookRuntimeType

Represents a notebook runtime type.

Values: NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED (0): Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED. USER_DEFINED (1): runtime or template with coustomized configurations from user. ONE_CLICK (2): runtime or template with system defined configurations.

Part

A datatype containing media that is part of a multi-part Content message.

A Part consists of data which has an associated datatype. A Part can only contain one of the accepted types in Part.data.

A Part must have a fixed IANA MIME type identifying the type and subtype of the media if inline_data or file_data field is filled with raw bytes.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PauseModelDeploymentMonitoringJobRequest

Request message for JobService.PauseModelDeploymentMonitoringJob.

PauseScheduleRequest

Request message for ScheduleService.PauseSchedule.

PersistentDiskSpec

Represents the spec of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] options.

PersistentResource

Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.

PipelineFailurePolicy

Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.

Values: PIPELINE_FAILURE_POLICY_UNSPECIFIED (0): Default value, and follows fail slow behavior. PIPELINE_FAILURE_POLICY_FAIL_SLOW (1): Indicates that the pipeline should continue to run until all possible tasks have been scheduled and completed. PIPELINE_FAILURE_POLICY_FAIL_FAST (2): Indicates that the pipeline should stop scheduling new tasks after a task has failed.

PipelineJob

An instance of a machine learning PipelineJob.

PipelineJobDetail

The runtime detail of PipelineJob.

PipelineState

Describes the state of a pipeline.

Values: PIPELINE_STATE_UNSPECIFIED (0): The pipeline state is unspecified. PIPELINE_STATE_QUEUED (1): The pipeline has been created or resumed, and processing has not yet begun. PIPELINE_STATE_PENDING (2): The service is preparing to run the pipeline. PIPELINE_STATE_RUNNING (3): The pipeline is in progress. PIPELINE_STATE_SUCCEEDED (4): The pipeline completed successfully. PIPELINE_STATE_FAILED (5): The pipeline failed. PIPELINE_STATE_CANCELLING (6): The pipeline is being cancelled. From this state, the pipeline may only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED. PIPELINE_STATE_CANCELLED (7): The pipeline has been cancelled. PIPELINE_STATE_PAUSED (8): The pipeline has been stopped, and can be resumed.

PipelineTaskDetail

The runtime detail of a task execution.

PipelineTaskExecutorDetail

The runtime detail of a pipeline executor.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PipelineTemplateMetadata

Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry.

Port

Represents a network port in a container.

PredefinedSplit

Assigns input data to training, validation, and test sets based on the value of a provided key.

Supported only for tabular Datasets.

PredictRequest

Request message for PredictionService.Predict.

PredictRequestResponseLoggingConfig

Configuration for logging request-response to a BigQuery table.

PredictResponse

Response message for PredictionService.Predict.

PredictSchemata

Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.

Presets

Preset configuration for example-based explanations

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PrivateEndpoints

PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri, explain_http_uri or health_http_uri. To send request via private service connect, use service_attachment.

PrivateServiceConnectConfig

Represents configuration for private service connect.

Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PscAutomatedEndpoints

PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.

PublisherModel

A Model Garden Publisher Model.

PublisherModelView

View enumeration of PublisherModel.

Values: PUBLISHER_MODEL_VIEW_UNSPECIFIED (0): The default / unset value. The API will default to the BASIC view. PUBLISHER_MODEL_VIEW_BASIC (1): Include basic metadata about the publisher model, but not the full contents. PUBLISHER_MODEL_VIEW_FULL (2): Include everything. PUBLISHER_MODEL_VERSION_VIEW_BASIC (3): Include: VersionId, ModelVersionExternalName, and SupportedActions.

PurgeArtifactsMetadata

Details of operations that perform MetadataService.PurgeArtifacts.

PurgeArtifactsRequest

Request message for MetadataService.PurgeArtifacts.

PurgeArtifactsResponse

Response message for MetadataService.PurgeArtifacts.

PurgeContextsMetadata

Details of operations that perform MetadataService.PurgeContexts.

PurgeContextsRequest

Request message for MetadataService.PurgeContexts.

PurgeContextsResponse

Response message for MetadataService.PurgeContexts.

PurgeExecutionsMetadata

Details of operations that perform MetadataService.PurgeExecutions.

PurgeExecutionsRequest

Request message for MetadataService.PurgeExecutions.

PurgeExecutionsResponse

Response message for MetadataService.PurgeExecutions.

PythonPackageSpec

The spec of a Python packaged code.

QueryArtifactLineageSubgraphRequest

Request message for MetadataService.QueryArtifactLineageSubgraph.

QueryContextLineageSubgraphRequest

Request message for MetadataService.QueryContextLineageSubgraph.

QueryDeployedModelsRequest

Request message for QueryDeployedModels method.

QueryDeployedModelsResponse

Response message for QueryDeployedModels method.

QueryExecutionInputsAndOutputsRequest

Request message for MetadataService.QueryExecutionInputsAndOutputs.

RawPredictRequest

Request message for PredictionService.RawPredict.

RaySpec

Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.

ReadFeatureValuesRequest

Request message for FeaturestoreOnlineServingService.ReadFeatureValues.

ReadFeatureValuesResponse

Response message for FeaturestoreOnlineServingService.ReadFeatureValues.

ReadIndexDatapointsRequest

The request message for MatchService.ReadIndexDatapoints.

ReadIndexDatapointsResponse

The response message for MatchService.ReadIndexDatapoints.

ReadTensorboardBlobDataRequest

Request message for TensorboardService.ReadTensorboardBlobData.

ReadTensorboardBlobDataResponse

Response message for TensorboardService.ReadTensorboardBlobData.

ReadTensorboardSizeRequest

Request message for TensorboardService.ReadTensorboardSize.

ReadTensorboardSizeResponse

Response message for TensorboardService.ReadTensorboardSize.

ReadTensorboardTimeSeriesDataRequest

Request message for TensorboardService.ReadTensorboardTimeSeriesData.

ReadTensorboardTimeSeriesDataResponse

Response message for TensorboardService.ReadTensorboardTimeSeriesData.

ReadTensorboardUsageRequest

Request message for TensorboardService.ReadTensorboardUsage.

ReadTensorboardUsageResponse

Response message for TensorboardService.ReadTensorboardUsage.

RebootPersistentResourceOperationMetadata

Details of operations that perform reboot PersistentResource.

RebootPersistentResourceRequest

Request message for PersistentResourceService.RebootPersistentResource.

RemoveContextChildrenRequest

Request message for [MetadataService.DeleteContextChildrenRequest][].

RemoveContextChildrenResponse

Response message for MetadataService.RemoveContextChildren.

RemoveDatapointsRequest

Request message for IndexService.RemoveDatapoints

RemoveDatapointsResponse

Response message for IndexService.RemoveDatapoints

ResourcePool

Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResourceRuntime

Persistent Cluster runtime information as output

ResourceRuntimeSpec

Configuration for the runtime on a PersistentResource instance, including but not limited to:

Service accounts used to run the workloads.
Whether to make it a dedicated Ray Cluster.

ResourcesConsumed

Statistics information about resource consumption.

RestoreDatasetVersionOperationMetadata

Runtime operation information for DatasetService.RestoreDatasetVersion.

RestoreDatasetVersionRequest

Request message for DatasetService.RestoreDatasetVersion.

ResumeModelDeploymentMonitoringJobRequest

Request message for JobService.ResumeModelDeploymentMonitoringJob.

ResumeScheduleRequest

Request message for ScheduleService.ResumeSchedule.

Retrieval

Defines a retrieval tool that model can call to access external knowledge.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SafetyRating

Safety rating corresponding to the generated content.

SafetySetting

Safety settings.

SampleConfig

Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SampledShapleyAttribution

An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.

SamplingStrategy

Sampling Strategy for logging, can be for both training and prediction dataset.

SavedQuery

A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.

Scalar

One point viewable on a scalar metric plot.

Schedule

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Scheduling

All parameters related to queuing and scheduling of custom jobs.

Schema

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object <https://spec.openapis.org/oas/v3.0.3#schema>__. More fields may be added in the future as needed.

SearchDataItemsRequest

Request message for DatasetService.SearchDataItems.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SearchDataItemsResponse

Response message for DatasetService.SearchDataItems.

SearchFeaturesRequest

Request message for FeaturestoreService.SearchFeatures.

SearchFeaturesResponse

Response message for FeaturestoreService.SearchFeatures.

SearchMigratableResourcesRequest

Request message for MigrationService.SearchMigratableResources.

SearchMigratableResourcesResponse

Response message for MigrationService.SearchMigratableResources.

SearchModelDeploymentMonitoringStatsAnomaliesRequest

Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.

SearchModelDeploymentMonitoringStatsAnomaliesResponse

Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.

SearchNearestEntitiesRequest

The request message for FeatureOnlineStoreService.SearchNearestEntities.

SearchNearestEntitiesResponse

Response message for FeatureOnlineStoreService.SearchNearestEntities

Segment

Segment of the content.

ServiceAccountSpec

Configuration for the use of custom service account to run the workloads.

ShieldedVmConfig

A set of Shielded Instance options. See Images using supported Shielded VM features <https://cloud.google.com/compute/docs/instances/modifying-shielded-vm>__.

SmoothGradConfig

Config for SmoothGrad approximation of gradients.

When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details:

https://arxiv.org/pdf/1706.03825.pdf

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SpecialistPool

SpecialistPool represents customers' own workforce to work on their data labeling jobs. It includes a group of specialist managers and workers. Managers are responsible for managing the workers in this pool as well as customers' data labeling jobs associated with this pool. Customers create specialist pool as well as start data labeling jobs on Cloud, managers and workers handle the jobs using CrowdCompute console.

StartNotebookRuntimeOperationMetadata

Metadata information for NotebookService.StartNotebookRuntime.

StartNotebookRuntimeRequest

Request message for NotebookService.StartNotebookRuntime.

StartNotebookRuntimeResponse

Response message for NotebookService.StartNotebookRuntime.

StopTrialRequest

Request message for VizierService.StopTrial.

StratifiedSplit

Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the key field) is mirrored within each split. The fraction values determine the relative sizes of the splits.

For example, if the specified column has three values, with 50% of the rows having value "A", 25% value "B", and 25% value "C", and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value "A" for the specified column, about 25% having the value "B", and about 25% having the value "C".

Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned.

Supported only for tabular Datasets.

StreamDirectPredictRequest

Request message for PredictionService.StreamDirectPredict.

The first message must contain endpoint field and optionally [input][]. The subsequent messages must contain [input][].

StreamDirectPredictResponse

Response message for PredictionService.StreamDirectPredict.

StreamDirectRawPredictRequest

Request message for PredictionService.StreamDirectRawPredict.

The first message must contain endpoint and method_name fields and optionally input. The subsequent messages must contain input. method_name in the subsequent messages have no effect.

StreamDirectRawPredictResponse

Response message for PredictionService.StreamDirectRawPredict.

StreamRawPredictRequest

Request message for PredictionService.StreamRawPredict.

StreamingPredictRequest

Request message for PredictionService.StreamingPredict.

The first message must contain endpoint field and optionally [input][]. The subsequent messages must contain [input][].

StreamingPredictResponse

Response message for PredictionService.StreamingPredict.

StreamingRawPredictRequest

Request message for PredictionService.StreamingRawPredict.

The first message must contain endpoint and method_name fields and optionally input. The subsequent messages must contain input. method_name in the subsequent messages have no effect.

StreamingRawPredictResponse

Response message for PredictionService.StreamingRawPredict.

StreamingReadFeatureValuesRequest

Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].

StringArray

A list of string values.

Study

A message representing a Study.

StudySpec

Represents specification of a Study.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StudyTimeConstraint

Time-based Constraint for Study

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SuggestTrialsMetadata

Details of operations that perform Trials suggestion.

SuggestTrialsRequest

Request message for VizierService.SuggestTrials.

SuggestTrialsResponse

Response message for VizierService.SuggestTrials.

SupervisedHyperParameters

Hyperparameters for SFT.

SupervisedTuningDataStats

Tuning data statistics for Supervised Tuning.

SupervisedTuningDatasetDistribution

Dataset distribution for Supervised Tuning.

SupervisedTuningSpec

Tuning Spec for Supervised Tuning.

SyncFeatureViewRequest

Request message for FeatureOnlineStoreAdminService.SyncFeatureView.

SyncFeatureViewResponse

Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.

TFRecordDestination

The storage details for TFRecord output content.

Tensor

A tensor value type.

Tensorboard

Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a Google Cloud project. If needed users can also create extra Tensorboards in their projects.

TensorboardBlob

One blob (e.g, image, graph) viewable on a blob metric plot.

TensorboardBlobSequence

One point viewable on a blob metric plot, but mostly just a wrapper message to work around repeated fields can't be used directly within oneof fields.

TensorboardExperiment

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

TensorboardRun

TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

TensorboardTensor

One point viewable on a tensor metric plot.

TensorboardTimeSeries

TensorboardTimeSeries maps to times series produced in training runs

ThresholdConfig

The config for feature monitoring threshold.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TimeSeriesData

All the data stored in a TensorboardTimeSeries.

TimeSeriesDataPoint

A TensorboardTimeSeries data point.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TimestampSplit

Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set.

Supported only for tabular Datasets.

TokensInfo

Tokens info with a list of tokens and the corresponding list of token ids.

Tool

Tool details that the model may use to generate response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).

TrainingConfig

CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems.

TrainingPipeline

The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI's Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.

Trial

A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

TrialContext

Next ID: 3

TunedModel

The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob.

TuningDataStats

The tuning data statistic values for TuningJob.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TuningJob

Represents a TuningJob that runs with Google owned models.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Type

Type contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/

Values: TYPE_UNSPECIFIED (0): Not specified, should not be used. STRING (1): OpenAPI string type NUMBER (2): OpenAPI number type INTEGER (3): OpenAPI integer type BOOLEAN (4): OpenAPI boolean type ARRAY (5): OpenAPI array type OBJECT (6): OpenAPI object type

Supported only by image Models.